Struct EndpointOAuth

pub struct EndpointOAuth {
    pub enabled: Option<bool>,
    pub provider: EndpointOAuthProvider,
    pub options_passthrough: bool,
    pub cookie_prefix: String,
    pub inactivity_timeout: u32,
    pub maximum_duration: u32,
    pub auth_check_interval: u32,
}

Fields

enabled: Option<bool>

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

provider: EndpointOAuthProvider

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

options_passthrough: bool

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: u32

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: u32

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

auth_check_interval: u32

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.

Trait Implementations

impl Clone for EndpointOAuth

fn clone(&self) -> EndpointOAuth

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EndpointOAuth

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for EndpointOAuth

fn default() -> EndpointOAuth

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndpointOAuth

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointOAuth

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.