---
title: "Get"
method: GET
path: "/edges/https/{edge_id}/routes/{id}/oauth"
tags: ["EdgeRouteOAuthModule"]
---

# Get

`GET /edges/https/{edge_id}/routes/{id}/oauth`

## Path parameters

- `edge_id` string, required
- `id` string, required

## Headers

- `ngrok-version` integer, required

## Response `200`

n/a

- EndpointOAuth
  - `enabled` boolean — `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified
  - `provider` EndpointOAuthProvider
    - `github` EndpointOAuthGitHub
      - `client_id` string — the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.
      - `client_secret` string — the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for `client_id`.
      - `scopes` string[] — a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both `client_id` and `client_secret` to set scopes)
      - `email_addresses` string[] — a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
      - `email_domains` string[] — a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
      - `teams` string[] — a list of github teams identifiers. users will be allowed access to the endpoint if they are a member of any of these teams. identifiers should be in the 'slug' format qualified with the org name, e.g. `org-name/team-name`
      - `organizations` string[] — a list of github org identifiers. users who are members of any of the listed organizations will be allowed access. identifiers should be the organization's 'slug'
    - `facebook` EndpointOAuthFacebook
      - `client_id` string — the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.
      - `client_secret` string — the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for `client_id`.
      - `scopes` string[] — a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both `client_id` and `client_secret` to set scopes)
      - `email_addresses` string[] — a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
      - `email_domains` string[] — a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
    - `microsoft` EndpointOAuthMicrosoft
      - `client_id` string — the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.
      - `client_secret` string — the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for `client_id`.
      - `scopes` string[] — a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both `client_id` and `client_secret` to set scopes)
      - `email_addresses` string[] — a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
      - `email_domains` string[] — a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
    - `google` EndpointOAuthGoogle
      - `client_id` string — the OAuth app client ID. retrieve it from the identity provider's dashboard where you created your own OAuth app. optional. if unspecified, ngrok will use its own managed oauth application which has additional restrictions. see the OAuth module docs for more details. if present, client_secret must be present as well.
      - `client_secret` string — the OAuth app client secret. retrieve if from the identity provider's dashboard where you created your own OAuth app. optional, see all of the caveats in the docs for `client_id`.
      - `scopes` string[] — a list of provider-specific OAuth scopes with the permissions your OAuth app would like to ask for. these may not be set if you are using the ngrok-managed oauth app (i.e. you must pass both `client_id` and `client_secret` to set scopes)
      - `email_addresses` string[] — a list of email addresses of users authenticated by identity provider who are allowed access to the endpoint
      - `email_domains` string[] — a list of email domains of users authenticated by identity provider who are allowed access to the endpoint
    - `linkedin` EndpointOAuthLinkedIn
      - `client_id` string — n/a
      - `client_secret` string — n/a
      - `scopes` string[] — n/a
      - `email_addresses` string[] — n/a
      - `email_domains` string[] — n/a
    - `gitlab` EndpointOAuthGitLab
      - `client_id` string — n/a
      - `client_secret` string — n/a
      - `scopes` string[] — n/a
      - `email_addresses` string[] — n/a
      - `email_domains` string[] — n/a
    - `twitch` EndpointOAuthTwitch
      - `client_id` string — n/a
      - `client_secret` string — n/a
      - `scopes` string[] — n/a
      - `email_addresses` string[] — n/a
      - `email_domains` string[] — n/a
    - `amazon` EndpointOAuthAmazon
      - `client_id` string — n/a
      - `client_secret` string — n/a
      - `scopes` string[] — n/a
      - `email_addresses` string[] — n/a
      - `email_domains` string[] — n/a
  - `options_passthrough` boolean — Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.
  - `cookie_prefix` string — the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'
  - `inactivity_timeout` integer — Integer number of seconds of inactivity after which if the user has not accessed the endpoint, their session will time out and they will be forced to reauthenticate.
  - `maximum_duration` integer — Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.
  - `auth_check_interval` integer — Integer number of seconds after which ngrok guarantees it will refresh user state from the identity provider and recheck whether the user is still authorized to access the endpoint. This is the preferred tunable to use to enforce a minimum amount of time after which a revoked user will no longer be able to access the resource.

---

[API](https://skmtc.net/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.net/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/versions/1994bbb04714/schema)