Edge Route OIDC Module
Replace HTTPS Edge Route OIDC Module
Request
PUT /edges/https/{edge_id}/routes/{id}/oidc
Example Request
Loading…
Parameters
| Name | Type | Description |
|---|---|---|
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 | uint32 | 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 | uint32 | 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 | List<string> | The set of scopes to request from the OIDC identity provider. |
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
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 | uint32 | 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 | uint32 | 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 | List<string> | The set of scopes to request from the OIDC identity provider. |
Get HTTPS Edge Route OIDC Module
Request
GET /edges/https/{edge_id}/routes/{id}/oidc
Example Request
Loading…
Response
Returns a 200 response on success
Example Response
Loading…
Fields
| Name | Type | Description |
|---|---|---|
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 | uint32 | 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 | uint32 | 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 | List<string> | The set of scopes to request from the OIDC identity provider. |
Delete HTTPS Edge Route OIDC Module
Request
DELETE /edges/https/{edge_id}/routes/{id}/oidc
Example Request
Loading…
Response
Returns a 204 response with no body on success