Struct openidconnect::IdTokenClaims

pub struct IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim,  { /* fields omitted */ }

OpenID Connect ID token claims.

Methods

impl<AC, GC> IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim, 

pub fn new(
    issuer: IssuerUrl,
    audiences: Vec<Audience>,
    expiration: DateTime<Utc>,
    issue_time: DateTime<Utc>,
    standard_claims: StandardClaims<GC>,
    additional_claims: AC
) -> Self

Initializes new ID token claims.

pub fn issuer(&self) -> &IssuerUrl

Returns the iss claim.

pub fn set_issuer(self, issuer: IssuerUrl) -> Self

Sets the iss claim.

pub fn audiences(&self) -> &Vec<Audience>

Returns the aud claim.

pub fn set_audiences(self, audiences: Vec<Audience>) -> Self

Sets the aud claim.

pub fn expiration(&self) -> &DateTime<Utc>

Returns the exp claim.

pub fn set_expiration(self, expiration: DateTime<Utc>) -> Self

Sets the exp claim.

pub fn issue_time(&self) -> &DateTime<Utc>

Returns the iat claim.

pub fn set_issue_time(self, issue_time: DateTime<Utc>) -> Self

Sets the iat claim.

pub fn auth_time(&self) -> Option<&DateTime<Utc>>

Returns the auth_time claim.

pub fn set_auth_time(self, auth_time: Option<DateTime<Utc>>) -> Self

Sets the auth_time claim.

pub fn nonce(&self) -> Option<&Nonce>

Returns the nonce claim.

pub fn set_nonce(self, nonce: Option<Nonce>) -> Self

Sets the nonce claim.

pub fn auth_context_ref(&self) -> Option<&AuthenticationContextClass>

Returns the acr claim.

pub fn set_auth_context_ref(
    self,
    auth_context_ref: Option<AuthenticationContextClass>
) -> Self

Sets the acr claim.

pub fn auth_method_refs(&self) -> Option<&Vec<AuthenticationMethodReference>>

Returns the amr claim.

pub fn set_auth_method_refs(
    self,
    auth_method_refs: Option<Vec<AuthenticationMethodReference>>
) -> Self

Sets the amr claim.

pub fn authorized_party(&self) -> Option<&ClientId>

Returns the azp claim.

pub fn set_authorized_party(self, authorized_party: Option<ClientId>) -> Self

Sets the azp claim.

pub fn access_token_hash(&self) -> Option<&AccessTokenHash>

Returns the at_hash claim.

pub fn set_access_token_hash(
    self,
    access_token_hash: Option<AccessTokenHash>
) -> Self

Sets the at_hash claim.

pub fn code_hash(&self) -> Option<&AuthorizationCodeHash>

Returns the c_hash claim.

pub fn set_code_hash(self, code_hash: Option<AuthorizationCodeHash>) -> Self

Sets the c_hash claim.

pub fn subject(&self) -> &SubjectIdentifier

Returns the sub claim.

pub fn set_subject(self, subject: SubjectIdentifier) -> Self

Sets the sub claim.

pub fn name(&self) -> Option<&LocalizedClaim<EndUserName>>

Returns the name claim.

pub fn set_name(self, name: Option<LocalizedClaim<EndUserName>>) -> Self

Sets the name claim.

pub fn given_name(&self) -> Option<&LocalizedClaim<EndUserGivenName>>

Returns the given_name claim.

pub fn set_given_name(
    self,
    given_name: Option<LocalizedClaim<EndUserGivenName>>
) -> Self

Sets the given_name claim.

pub fn family_name(&self) -> Option<&LocalizedClaim<EndUserFamilyName>>

Returns the family_name claim.

pub fn set_family_name(
    self,
    family_name: Option<LocalizedClaim<EndUserFamilyName>>
) -> Self

Sets the family_name claim.

pub fn middle_name(&self) -> Option<&LocalizedClaim<EndUserMiddleName>>

Returns the middle_name claim.

pub fn set_middle_name(
    self,
    middle_name: Option<LocalizedClaim<EndUserMiddleName>>
) -> Self

Sets the middle_name claim.

pub fn nickname(&self) -> Option<&LocalizedClaim<EndUserNickname>>

Returns the nickname claim.

pub fn set_nickname(
    self,
    nickname: Option<LocalizedClaim<EndUserNickname>>
) -> Self

Sets the nickname claim.

pub fn preferred_username(&self) -> Option<&EndUserUsername>

Returns the preferred_username claim.

pub fn set_preferred_username(
    self,
    preferred_username: Option<EndUserUsername>
) -> Self

Sets the preferred_username claim.

pub fn profile(&self) -> Option<&LocalizedClaim<EndUserProfileUrl>>

Returns the profile claim.

pub fn set_profile(
    self,
    profile: Option<LocalizedClaim<EndUserProfileUrl>>
) -> Self

Sets the profile claim.

pub fn picture(&self) -> Option<&LocalizedClaim<EndUserPictureUrl>>

Returns the picture claim.

pub fn set_picture(
    self,
    picture: Option<LocalizedClaim<EndUserPictureUrl>>
) -> Self

Sets the picture claim.

pub fn website(&self) -> Option<&LocalizedClaim<EndUserWebsiteUrl>>

Returns the website claim.

pub fn set_website(
    self,
    website: Option<LocalizedClaim<EndUserWebsiteUrl>>
) -> Self

Sets the website claim.

pub fn email(&self) -> Option<&EndUserEmail>

Returns the email claim.

pub fn set_email(self, email: Option<EndUserEmail>) -> Self

Sets the email claim.

pub fn email_verified(&self) -> Option<bool>

Returns the email_verified claim.

pub fn set_email_verified(self, email_verified: Option<bool>) -> Self

Sets the email_verified claim.

pub fn gender(&self) -> Option<&GC>

Returns the gender claim.

pub fn set_gender(self, gender: Option<GC>) -> Self

Sets the gender claim.

pub fn birthday(&self) -> Option<&EndUserBirthday>

Returns the birthday claim.

pub fn set_birthday(self, birthday: Option<EndUserBirthday>) -> Self

Sets the birthday claim.

pub fn zoneinfo(&self) -> Option<&EndUserTimezone>

Returns the zoneinfo claim.

pub fn set_zoneinfo(self, zoneinfo: Option<EndUserTimezone>) -> Self

Sets the zoneinfo claim.

pub fn locale(&self) -> Option<&LanguageTag>

Returns the locale claim.

pub fn set_locale(self, locale: Option<LanguageTag>) -> Self

Sets the locale claim.

pub fn phone_number(&self) -> Option<&EndUserPhoneNumber>

Returns the phone_number claim.

pub fn set_phone_number(self, phone_number: Option<EndUserPhoneNumber>) -> Self

Sets the phone_number claim.

pub fn phone_number_verified(&self) -> Option<bool>

Returns the phone_number_verified claim.

pub fn set_phone_number_verified(
    self,
    phone_number_verified: Option<bool>
) -> Self

Sets the phone_number_verified claim.

pub fn address(&self) -> Option<&AddressClaim>

Returns the address claim.

pub fn set_address(self, address: Option<AddressClaim>) -> Self

Sets the address claim.

pub fn updated_at(&self) -> Option<&DateTime<Utc>>

Returns the updated_at claim.

pub fn set_updated_at(self, updated_at: Option<DateTime<Utc>>) -> Self

Sets the updated_at claim.

pub fn additional_claims(&self) -> &AC

Returns additional ID token claims.

pub fn additional_claims_mut(&mut self) -> &mut AC

Returns mutable additional ID token claims.

Trait Implementations

impl<AC: Clone, GC: Clone> Clone for IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim, 

fn clone(&self) -> IdTokenClaims<AC, GC>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<AC: PartialEq, GC: PartialEq> PartialEq<IdTokenClaims<AC, GC>> for IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim, 

fn eq(&self, other: &IdTokenClaims<AC, GC>) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &IdTokenClaims<AC, GC>) -> bool

This method tests for !=.

impl<AC: Debug, GC: Debug> Debug for IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim, 

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

Formats the value using the given formatter.

impl<AC, GC> Serialize for IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim,
    GC: GenderClaim,
    AC: AdditionalClaims, 

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

Serialize this value into the given Serde serializer.

impl<'de, AC, GC> Deserialize<'de> for IdTokenClaims<AC, GC> where
    AC: AdditionalClaims,
    GC: GenderClaim,
    GC: GenderClaim,
    AC: AdditionalClaims, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.