Instance Constructors

1.  new EndpointOAuth(enabled: Option[Boolean] = None, provider: EndpointOAuthProvider, optionsPassthrough: Boolean, cookiePrefix: String, inactivityTimeout: Long, maximumDuration: Duration, authCheckInterval: Long)

   create a new EndpointOAuth.

   create a new EndpointOAuth.

   enabled

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

   provider

   an object which defines the identity provider to use for authentication and configuration for who may access the endpoint

   optionsPassthrough

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

   cookiePrefix

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

   inactivityTimeout

   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.

   maximumDuration

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

   authCheckInterval

   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.