#[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>>, }
Expand description

Configuration information when authentication mode is FEDERATED.

Fields (Non-exhaustive)§

This struct is marked as 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§

source§

impl FederationParameters

source

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

SAML 2.0 Metadata document from identity provider (IdP).

source

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

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

source

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).

source

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.

source

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

Name of the identity provider (IdP).

source

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.

source§

impl FederationParameters

source

pub fn builder() -> FederationParametersBuilder

Creates a new builder-style object to manufacture FederationParameters.

Trait Implementations§

source§

impl Clone for FederationParameters

source§

fn clone(&self) -> FederationParameters

Returns a copy of the value. Read more
1.0.0 · source§

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

Performs copy-assignment from source. Read more
source§

impl Debug for FederationParameters

source§

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

Formats the value using the given formatter. Read more
source§

impl PartialEq for FederationParameters

source§

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

This method tests for self and other values to be equal, and is used by ==.
1.0.0 · source§

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
source§

impl StructuralPartialEq for FederationParameters

Auto Trait Implementations§

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<Unshared, Shared> IntoShared<Shared> for Unshared
where Shared: FromUnshared<Unshared>,

source§

fn into_shared(self) -> Shared

Creates a shared type from an unshared type.
source§

impl<T> Same for T

§

type Output = T

Should always be Self
source§

impl<T> ToOwned for T
where T: Clone,

§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more