Struct Config 

#[non_exhaustive]
pub struct Config {
    pub client_id: String,
    pub issuer_url: String,
    pub metadata_source: MetadataSource,
    pub end_session_url: Option<String>,
    pub after_logout_url: Option<String>,
    pub post_logout_redirect_name: Option<String>,
    pub additional_trusted_audiences: Vec<String>,
    pub require_issuer_match: bool,
}

OpenID Connect client configuration

Non-exhaustive

This struct is #[non_exhaustive], so it is not possible to directly create a struct, creating a new struct is done using the Config::new function. Additional properties are set using the with_* functions.

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.

client_id: String

The client ID

issuer_url: String

The OpenID connect issuer URL.

metadata_source: MetadataSource

How to fetch the metadata

end_session_url: Option<String>

An override for the end session URL.

after_logout_url: Option<String>

The URL to navigate to after the logout has been completed.

post_logout_redirect_name: Option<String>

The name of the query parameter for the post logout redirect. The defaults to post_logout_redirect_uri for OpenID RP initiated logout. However, e.g. older Keycloak instances, require this to be redirect_uri.

additional_trusted_audiences: Vec<String>

Additional audiences of the ID token which are considered trustworthy.

Those audiences are allowed in addition to the client ID.

require_issuer_match: bool

Specifies whether the issuer claim must match the expected issuer URL for the provider.

Implementations

impl Config

pub fn new(client_id: impl Into<String>, issuer_url: impl Into<String>) -> Self

Create a new configuration

pub fn with_end_session_url(self, end_session_url: impl Into<String>) -> Self

Set an override for the URL for ending the session.

pub fn with_after_logout_url(self, after_logout_url: impl Into<String>) -> Self

Set the URL the issuer should redirect to after the logout

pub fn with_post_logout_redirect_name( self, post_logout_redirect_name: impl Into<String>, ) -> Self

Set the name of the post logout redirect query parameter

pub fn with_additional_trusted_audiences( self, additional_trusted_audiences: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Set the additionally trusted audiences

pub fn extend_additional_trusted_audiences( self, additional_trusted_audiences: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Extend the additionally trusted audiences.

pub fn add_additional_trusted_audience( self, additional_trusted_audience: impl Into<String>, ) -> Self

Add an additionally trusted audience.

pub fn with_require_issuer_match(self, require_issuer_match: bool) -> Self

Specifies whether the issuer claim must match the expected issuer URL for the provider.

pub fn with_metadata_source(self, metadata_source: MetadataSource) -> Self

Set the metadata source

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Config

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Config

impl StructuralPartialEq for Config