Struct SamlConfiguration

#[non_exhaustive]
pub struct SamlConfiguration {
    pub idp_metadata: Option<IdpMetadata>,
    pub assertion_attributes: Option<AssertionAttributes>,
    pub role_values: Option<RoleValues>,
    pub allowed_organizations: Option<Vec<String>>,
    pub login_validity_duration: i32,
}

A structure containing information about how this workspace works with SAML.

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.

idp_metadata: Option<IdpMetadata>

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

assertion_attributes: Option<AssertionAttributes>

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

role_values: Option<RoleValues>

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

allowed_organizations: Option<Vec<String>>

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

login_validity_duration: i32

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

Implementations

impl SamlConfiguration

pub fn idp_metadata(&self) -> Option<&IdpMetadata>

A structure containing the identity provider (IdP) metadata used to integrate the identity provider with this workspace.

pub fn assertion_attributes(&self) -> Option<&AssertionAttributes>

A structure that defines which attributes in the SAML assertion are to be used to define information about the users authenticated by that IdP to use the workspace.

pub fn role_values(&self) -> Option<&RoleValues>

A structure containing arrays that map group names in the SAML assertion to the Grafana Admin and Editor roles in the workspace.

pub fn allowed_organizations(&self) -> &[String]

Lists which organizations defined in the SAML assertion are allowed to use the Amazon Managed Grafana workspace. If this is empty, all organizations in the assertion attribute have access.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .allowed_organizations.is_none().

pub fn login_validity_duration(&self) -> i32

How long a sign-on session by a SAML user is valid, before the user has to sign on again.

impl SamlConfiguration

pub fn builder() -> SamlConfigurationBuilder

Creates a new builder-style object to manufacture SamlConfiguration.

Trait Implementations

impl Clone for SamlConfiguration

fn clone(&self) -> SamlConfiguration

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamlConfiguration

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

Formats the value using the given formatter.

impl PartialEq for SamlConfiguration

fn eq(&self, other: &SamlConfiguration) -> 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 SamlConfiguration