Struct SamlConfig 

pub struct SamlConfig {

    pub entity_id: String,
    pub idp_sso_url: String,
    pub idp_slo_url: Option<String>,
    pub idp_entity_id: Option<String>,
    pub idp_certificate: Option<String>,
    pub sp_private_key: Option<String>,
    pub sp_certificate: Option<String>,
    pub acs_url: String,
    pub sls_url: Option<String>,
    pub sso_binding: SamlBinding,
    pub slo_binding: SamlBinding,
    pub name_id_format: NameIdFormat,
    pub authn_context_class: Option<AuthnContextClass>,
    pub sign_authn_request: bool,
    pub want_assertions_signed: bool,
    pub want_assertions_encrypted: bool,
    pub max_clock_skew: Duration,
    pub attribute_mapping: HashMap<String, String>,
    pub role_attribute: Option<String>,
    pub authority_attribute: Option<String>,
    pub default_roles: Vec<String>,
    pub allow_unsolicited_responses: bool,
    pub session_timeout: Duration,
}

SAML Service Provider configuration

Fields

entity_id: String

SP Entity ID (unique identifier)

idp_sso_url: String

IdP SSO URL (where to send AuthnRequest)

idp_slo_url: Option<String>

IdP Single Logout URL (optional)

idp_entity_id: Option<String>

IdP Entity ID

idp_certificate: Option<String>

IdP certificate for signature verification (PEM format)

sp_private_key: Option<String>

SP private key for signing requests (PEM format)

sp_certificate: Option<String>

SP certificate (PEM format)

acs_url: String

Assertion Consumer Service URL

sls_url: Option<String>

Single Logout Service URL

sso_binding: SamlBinding

Preferred binding for SSO

slo_binding: SamlBinding

Preferred binding for SLO

name_id_format: NameIdFormat

Name ID format to request

authn_context_class: Option<AuthnContextClass>

Authentication context class to request

sign_authn_request: bool

Whether to sign AuthnRequest

want_assertions_signed: bool

Whether to require signed assertions

want_assertions_encrypted: bool

Whether to require encrypted assertions

max_clock_skew: Duration

Maximum allowed clock skew

attribute_mapping: HashMap<String, String>

Attribute mapping (SAML attribute name -> User field)

role_attribute: Option<String>

Role attribute name

authority_attribute: Option<String>

Authority attribute name

default_roles: Vec<String>

Default roles for authenticated users

allow_unsolicited_responses: bool

Allow unsolicited responses (IdP-initiated SSO)

session_timeout: Duration

Session timeout

Implementations

impl SamlConfig

pub fn new() -> SamlConfig

Create a new SAML configuration with minimal required fields

pub fn entity_id(self, entity_id: impl Into<String>) -> SamlConfig

Set the SP entity ID

pub fn idp_sso_url(self, url: impl Into<String>) -> SamlConfig

Set the IdP SSO URL

pub fn idp_slo_url(self, url: impl Into<String>) -> SamlConfig

Set the IdP SLO URL

pub fn idp_entity_id(self, entity_id: impl Into<String>) -> SamlConfig

Set the IdP entity ID

pub fn idp_certificate(self, cert: impl Into<String>) -> SamlConfig

Set the IdP certificate (PEM format)

pub fn sp_private_key(self, key: impl Into<String>) -> SamlConfig

Set the SP private key (PEM format)

pub fn sp_certificate(self, cert: impl Into<String>) -> SamlConfig

Set the SP certificate (PEM format)

pub fn acs_url(self, url: impl Into<String>) -> SamlConfig

Set the Assertion Consumer Service URL

pub fn assertion_consumer_service_url( self, url: impl Into<String>, ) -> SamlConfig

Alias for acs_url

pub fn sls_url(self, url: impl Into<String>) -> SamlConfig

Set the Single Logout Service URL

pub fn sso_binding(self, binding: SamlBinding) -> SamlConfig

Set the SSO binding

pub fn slo_binding(self, binding: SamlBinding) -> SamlConfig

Set the SLO binding

pub fn name_id_format(self, format: NameIdFormat) -> SamlConfig

Set the Name ID format

pub fn authn_context_class(self, class: AuthnContextClass) -> SamlConfig

Set the authentication context class

pub fn sign_authn_request(self, sign: bool) -> SamlConfig

Set whether to sign AuthnRequest

pub fn want_assertions_signed(self, signed: bool) -> SamlConfig

Set whether assertions must be signed

pub fn want_assertions_encrypted(self, encrypted: bool) -> SamlConfig

Set whether assertions must be encrypted

pub fn max_clock_skew(self, skew: Duration) -> SamlConfig

Set maximum clock skew tolerance

pub fn map_attribute( self, saml_attribute: impl Into<String>, user_field: impl Into<String>, ) -> SamlConfig

Add an attribute mapping

pub fn role_attribute(self, attr: impl Into<String>) -> SamlConfig

Set the role attribute name

pub fn authority_attribute(self, attr: impl Into<String>) -> SamlConfig

Set the authority attribute name

pub fn default_roles(self, roles: Vec<String>) -> SamlConfig

Set default roles for authenticated users

pub fn allow_unsolicited_responses(self, allow: bool) -> SamlConfig

Set whether to allow unsolicited responses

pub fn session_timeout(self, timeout: Duration) -> SamlConfig

Set session timeout

pub fn okta( okta_domain: impl Into<String>, app_id: impl Into<String>, sp_entity_id: impl Into<String>, ) -> SamlConfig

Create configuration preset for Okta

pub fn azure_ad( tenant_id: impl Into<String>, _app_id: impl Into<String>, sp_entity_id: impl Into<String>, ) -> SamlConfig

Create configuration preset for Azure AD

pub fn google_workspace( sp_entity_id: impl Into<String>, acs_url: impl Into<String>, ) -> SamlConfig

Create configuration preset for Google Workspace

pub fn adfs( adfs_host: impl Into<String>, sp_entity_id: impl Into<String>, ) -> SamlConfig

Create configuration preset for ADFS

pub fn validate(&self) -> Result<(), SamlError>

Validate the configuration

Trait Implementations

impl Clone for SamlConfig

fn clone(&self) -> SamlConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SamlConfig

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

Formats the value using the given formatter.

impl Default for SamlConfig

fn default() -> SamlConfig

Returns the “default value” for a type.