Struct ngrok_api::types::EndpointSAML

pub struct EndpointSAML {

    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 entity_id: String,
    pub assertion_consumer_service_url: String,
    pub single_logout_url: String,
    pub request_signing_certificate_pem: String,
    pub metadata_url: 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.

entity_id: String

The SP Entity’s unique ID. This always takes the form of a URL. In ngrok’s implementation, this URL is the same as the metadata URL. This will need to be specified to the IdP as configuration.

assertion_consumer_service_url: String

The public URL of the SP’s Assertion Consumer Service. This is where the IdP will redirect to during an authentication flow. This will need to be specified to the IdP as configuration.

single_logout_url: String

The public URL of the SP’s Single Logout Service. This is where the IdP will redirect to during a single logout flow. This will optionally need to be specified to the IdP as configuration.

request_signing_certificate_pem: String

PEM-encoded x.509 certificate of the key pair that is used to sign all SAML requests that the ngrok SP makes to the IdP. Many IdPs do not support request signing verification, but we highly recommend specifying this in the IdP’s configuration if it is supported.

metadata_url: String

A public URL where the SP’s metadata is hosted. If an IdP supports dynamic configuration, this is the URL it can use to retrieve the SP metadata.

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 EndpointSAML

fn clone(&self) -> EndpointSAML

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for EndpointSAML

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

Formats the value using the given formatter.

impl Default for EndpointSAML

fn default() -> EndpointSAML

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for EndpointSAML

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

Deserialize this value from the given Serde deserializer.

impl Serialize for EndpointSAML

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

Serialize this value into the given Serde serializer.