Struct ngrok_api::types::EndpointSAMLMutate

pub struct EndpointSAMLMutate {
    pub enabled: Option<bool>,
    pub options_passthrough: bool,
    pub cookie_prefix: String,
    pub inactivity_timeout: u32,
    pub maximum_duration: u32,
    pub idp_metadata: String,
    pub force_authn: bool,
    pub allow_idp_initiated: Option<bool>,
    pub authorized_groups: Vec<String>,
    pub nameid_format: String,
}

Fields

enabled: Option<bool>

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

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.

idp_metadata: String

The full XML IdP EntityDescriptor. Your IdP may provide this to you as a a file to download or as a URL.

force_authn: bool

If true, indicates that whenever we redirect a user to the IdP for authentication that the IdP must prompt the user for authentication credentials even if the user already has a valid session with the IdP.

allow_idp_initiated: Option<bool>

If true, the IdP may initiate a login directly (e.g. the user does not need to visit the endpoint first and then be redirected). The IdP should set the RelayState parameter to the target URL of the resource they want the user to be redirected to after the SAML login assertion has been processed.

authorized_groups: Vec<String>

If present, only users who are a member of one of the listed groups may access the target endpoint.

nameid_format: String

Defines the name identifier format the SP expects the IdP to use in its assertions to identify subjects. If unspecified, a default value of urn:oasis:names:tc:SAML:2.0:nameid-format:persistent will be used. A subset of the allowed values enumerated by the SAML specification are supported.

Trait Implementations

impl Clone for EndpointSAMLMutate

fn clone(&self) -> EndpointSAMLMutate

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointSAMLMutate

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

Formats the value using the given formatter.

impl Default for EndpointSAMLMutate

fn default() -> EndpointSAMLMutate

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndpointSAMLMutate

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointSAMLMutate

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

Serialize this value into the given Serde serializer.