Struct UpdateOpenIdConnectConfiguration

#[non_exhaustive]
pub struct UpdateOpenIdConnectConfiguration {
    pub issuer: String,
    pub entity_id_prefix: Option<String>,
    pub group_configuration: Option<UpdateOpenIdConnectGroupConfiguration>,
    pub token_selection: Option<UpdateOpenIdConnectTokenSelection>,
}

Contains configuration details of an OpenID Connect (OIDC) identity provider, or identity source, that Verified Permissions can use to generate entities from authenticated identities. It specifies the issuer URL, token type that you want to use, and policy store entity details.

This data type is part of a UpdateConfiguration structure, which is a parameter to UpdateIdentitySource.

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.

issuer: String

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

entity_id_prefix: Option<String>

A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

group_configuration: Option<UpdateOpenIdConnectGroupConfiguration>

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

token_selection: Option<UpdateOpenIdConnectTokenSelection>

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

Implementations

impl UpdateOpenIdConnectConfiguration

pub fn issuer(&self) -> &str

The issuer URL of an OIDC identity provider. This URL must have an OIDC discovery endpoint at the path .well-known/openid-configuration.

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

A descriptive string that you want to prefix to user entities from your OIDC identity provider. For example, if you set an entityIdPrefix of MyOIDCProvider, you can reference principals in your policies in the format MyCorp::User::MyOIDCProvider|Carlos.

pub fn group_configuration( &self, ) -> Option<&UpdateOpenIdConnectGroupConfiguration>

The claim in OIDC identity provider tokens that indicates a user's group membership, and the entity type that you want to map it to. For example, this object can map the contents of a groups claim to MyCorp::UserGroup.

pub fn token_selection(&self) -> Option<&UpdateOpenIdConnectTokenSelection>

The token type that you want to process from your OIDC identity provider. Your policy store can process either identity (ID) or access tokens from a given OIDC identity source.

impl UpdateOpenIdConnectConfiguration

pub fn builder() -> UpdateOpenIdConnectConfigurationBuilder

Creates a new builder-style object to manufacture UpdateOpenIdConnectConfiguration.

Trait Implementations

impl Clone for UpdateOpenIdConnectConfiguration

fn clone(&self) -> UpdateOpenIdConnectConfiguration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UpdateOpenIdConnectConfiguration

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

Formats the value using the given formatter.

impl PartialEq for UpdateOpenIdConnectConfiguration

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