Struct ProviderIdentity 

#[non_exhaustive]
pub struct ProviderIdentity {
    pub provider: String,
    pub issuer: String,
    pub subject: String,
    pub email: Option<String>,
    pub email_verified: bool,
    pub name: Option<String>,
    pub claims: Map<String, Value>,
}

Who an OpenID Connect provider says signed in, once the panel has checked its ID token: the token came from the provider’s token endpoint, names the panel’s client, has not expired and carries the nonce this sign-in sent.

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.

provider: String

The provider’s key, such as google.

issuer: String

The provider’s issuer, such as https://accounts.google.com.

subject: String

The provider’s id for the account (sub): with the issuer, the one stable name of the account. An email address can change hands; this cannot.

email: Option<String>

The account’s email address, as the provider has it.

email_verified: bool

Whether the provider says the account proved it reads email.

name: Option<String>

The account’s display name.

claims: Map<String, Value>

Every claim of the ID token, such as Google’s hd, the Workspace domain of the account: what a linker reads that the fields above do not carry.

Implementations

impl ProviderIdentity

pub fn new( provider: impl Into<String>, issuer: impl Into<String>, subject: impl Into<String>, ) -> Self

The account subject at the provider keyed provider whose issuer is issuer, with no address, name or other claim: for a test of an IdentityLinker, which adds them with with_email, with_name and with_claim.

pub fn with_email(self, email: impl Into<String>, verified: bool) -> Self

This identity holding email, which the provider verified or not.

pub fn with_name(self, name: impl Into<String>) -> Self

This identity named name.

pub fn with_claim( self, name: impl Into<String>, value: impl Into<Value>, ) -> Self

This identity carrying the claim name with value.

Trait Implementations

impl Clone for ProviderIdentity

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProviderIdentity

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

Formats the value using the given formatter.

impl Eq for ProviderIdentity

impl PartialEq for ProviderIdentity

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for ProviderIdentity