Struct IdToken

pub struct IdToken<T = ()> { /* private fields */ }

OpenID connect ID Token.

More detail, see OpenID Connect Core specification

• 2. ID Token and
• 5.1 Standard Claims

If you need additionan non-standard claims, make your own struct and specify it to authenticate().

#[derive(serde::Deserialize)]
struct IdTokenExtraClaims {
    picture: Option<String>,
}
let id_token_with_picture = oidc_client
    .authenticate::<IdTokenExtraClaims>(&state, &code, &session)?;
let picture_url = id_token_with_picture.extra().picture;

Implementations

impl<T> IdToken<T>

pub fn issuer(&self) -> &str

ID Token issuer

pub fn subject(&self) -> &str

Subject Identifier. A locally unique and never reassigned identifier within the Issuer for the End-User.

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

End-User’s preferred e-mail address.

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

End-User’s full name in displayable form including all name parts, possibly including titles and suffixes, ordered according to the End-User’s locale and preferences.

pub fn extra(&self) -> &T

Extra claims

Trait Implementations

impl<'de, T> Deserialize<'de> for IdToken<T>

where T: Deserialize<'de>,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.