Struct FederationParameters

#[non_exhaustive]
pub struct FederationParameters {
    pub saml_metadata_document: Option<String>,
    pub saml_metadata_url: Option<String>,
    pub application_call_back_url: Option<String>,
    pub federation_urn: Option<String>,
    pub federation_provider_name: Option<String>,
    pub attribute_map: Option<HashMap<String, String>>,
}

Configuration information when authentication mode is FEDERATED.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

saml_metadata_document: Option<String>

SAML 2.0 Metadata document from identity provider (IdP).

saml_metadata_url: Option<String>

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

application_call_back_url: Option<String>

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

federation_urn: Option<String>

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

federation_provider_name: Option<String>

Name of the identity provider (IdP).

attribute_map: Option<HashMap<String, String>>

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

Implementations

impl FederationParameters

pub fn saml_metadata_document(&self) -> Option<&str>

SAML 2.0 Metadata document from identity provider (IdP).

pub fn saml_metadata_url(&self) -> Option<&str>

Provide the metadata URL from your SAML 2.0 compliant identity provider (IdP).

pub fn application_call_back_url(&self) -> Option<&str>

The redirect or sign-in URL that should be entered into the SAML 2.0 compliant identity provider configuration (IdP).

pub fn federation_urn(&self) -> Option<&str>

The Uniform Resource Name (URN). Also referred as Service Provider URN or Audience URI or Service Provider Entity ID.

pub fn federation_provider_name(&self) -> Option<&str>

Name of the identity provider (IdP).

pub fn attribute_map(&self) -> Option<&HashMap<String, String>>

SAML attribute name and value. The name must always be Email and the value should be set to the attribute definition in which user email is set. For example, name would be Email and value http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress. Please check your SAML 2.0 compliant identity provider (IdP) documentation for details.

impl FederationParameters

pub fn builder() -> FederationParametersBuilder

Creates a new builder-style object to manufacture FederationParameters.

Trait Implementations

impl Clone for FederationParameters

fn clone(&self) -> FederationParameters

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FederationParameters

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

Formats the value using the given formatter.

impl PartialEq for FederationParameters

fn eq(&self, other: &FederationParameters) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for FederationParameters