Skip to main content
PUT
/
edges
/
https
/
{edge_id}
/
routes
/
{id}
/
oidc
Replace
curl --request PUT \
  --url https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oidc \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'ngrok-version: <ngrok-version>' \
  --data '{
  "edge_id": "<string>",
  "id": "<string>",
  "module": {
    "enabled": true,
    "options_passthrough": true,
    "cookie_prefix": "<string>",
    "inactivity_timeout": 123,
    "maximum_duration": 123,
    "issuer": "<string>",
    "client_id": "<string>",
    "client_secret": "<string>",
    "scopes": [
      "<string>"
    ]
  }
}'
{
  "enabled": true,
  "options_passthrough": true,
  "cookie_prefix": "<string>",
  "inactivity_timeout": 123,
  "maximum_duration": 123,
  "issuer": "<string>",
  "client_id": "<string>",
  "client_secret": "<string>",
  "scopes": [
    "<string>"
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
ngrok-version
integer
default:2
required

Path Parameters

​
edge_id
string
required
​
id
string
required

Body

application/json
​
edge_id
string

n/a

​
id
string

n/a

​
module
object

n/a

Response

200 - application/json

n/a

​
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.