NGngrok
EdgeRouteOIDCModule

Replace

Changed on
put/edges/https/{edge_id}/routes/{id}/oidc

Request

  • Base URL
    https://api.ngrok.com
  • URL
    https://api.ngrok.com/edges/https/{edge_id}/routes/{id}/oidc
  • Auth
    HTTP bearer

Path parameters

edge_idstring required
idstring required

Headers

ngrok-versioninteger required

Request body

edge_idstring

n/a

idstring

n/a

Response

n/a

enabledboolean

true if the module will be applied to traffic, false to disable. default true if unspecified

options_passthroughboolean

Do not enforce authentication on HTTP OPTIONS requests. necessary if you are supporting CORS.

cookie_prefixstring

the prefix of the session cookie that ngrok sets on the http client to cache authentication. default is 'ngrok.'

inactivity_timeoutinteger

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_durationinteger

Integer number of seconds of the maximum duration of an authenticated session. After this period is exceeded, a user must reauthenticate.

issuerstring

URL of the OIDC "OpenID provider". This is the base URL used for discovery.

client_idstring

The OIDC app's client ID and OIDC audience.

client_secretstring

The OIDC app's client secret.

scopesstring[]

The set of scopes to request from the OIDC identity provider.

Changes

  • e40349f8ec6fRevision changes
    • info

      api operation id EdgeRouteOIDCModuleReplace removed and replaced with EdgeRouteOidcModuleReplace