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

# Get

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

## Path parameters

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

## Headers

- `ngrok-version` integer, required

## Response `200`

n/a

- EndpointOIDC
  - `enabled` boolean — `true` if the module will be applied to traffic, `false` to disable. default `true` if unspecified
  - `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.
  - `issuer` string — URL of the OIDC "OpenID provider". This is the base URL used for discovery.
  - `client_id` string — The OIDC app's client ID and OIDC audience.
  - `client_secret` string — The OIDC app's client secret.
  - `scopes` string[] — The set of scopes to request from the OIDC identity provider.

## Other responses

- `4XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.
- `5XX` — An error. The body carries a machine-readable error_code and a human-readable msg; every code is documented at https://ngrok.com/docs/errors. A 429 with error code ERR_NGROK_226 means the account exceeded the documented request-rate limit.

## Changes

- **2024-10-22** `e40349f8ec6f` — 1 info
  - api operation id `EdgeRouteOIDCModuleGet` removed and replaced with `EdgeRouteOidcModuleGet`

[Change history](https://skmtc.dev/ngrok/apis/ngrok-openapi/changes/edges/https/:edge_id/routes/:id/oidc/get.md)

---

[API](https://skmtc.dev/ngrok/apis/ngrok-openapi.md) · [All operations](https://skmtc.dev/ngrok/apis/ngrok-openapi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ngrok/ngrok-openapi/revisions/c697539ac350/schema)