Struct OpenIdConnectAccessTokenConfiguration

#[non_exhaustive]
pub struct OpenIdConnectAccessTokenConfiguration {
    pub principal_id_claim: String,
    pub audiences: Option<Vec<String>>,
}

The configuration of an OpenID Connect (OIDC) identity source for handling access token claims. Contains the claim that you want to identify as the principal in an authorization request, and the values of the aud claim, or audiences, that you want to accept.

This data type is part of a OpenIdConnectTokenSelection structure, which is a parameter of CreateIdentitySource.

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.

principal_id_claim: String

The claim that determines the principal in OIDC access tokens. For example, sub.

audiences: Option<Vec<String>>

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

Implementations

impl OpenIdConnectAccessTokenConfiguration

pub fn principal_id_claim(&self) -> &str

The claim that determines the principal in OIDC access tokens. For example, sub.

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

The access token aud claim values that you want to accept in your policy store. For example, https://myapp.example.com, https://myapp2.example.com.

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

impl OpenIdConnectAccessTokenConfiguration

pub fn builder() -> OpenIdConnectAccessTokenConfigurationBuilder

Creates a new builder-style object to manufacture OpenIdConnectAccessTokenConfiguration.

Trait Implementations

impl Clone for OpenIdConnectAccessTokenConfiguration

fn clone(&self) -> OpenIdConnectAccessTokenConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for OpenIdConnectAccessTokenConfiguration

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

Formats the value using the given formatter.

impl PartialEq for OpenIdConnectAccessTokenConfiguration

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