Sign in

v8

latestOpenAPI 3.0.0raw.githubusercontent.com2026-01-23241216351.5 KB
EdgeRouteOAuthModule

Get

get/edges/https/{edge_id}/routes/{id}/oauth

Path parameters

edge_idstring required

unique identifier of this edge

idstring required

unique identifier of this edge route

Headers

ngrok-versioninteger required

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.

auth_check_intervalinteger

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.