Struct IdToken

pub struct IdToken {
    pub code: Option<String>,
    pub id_token: String,
    pub state: Option<String>,
    pub session_state: Option<String>,
    pub additional_fields: HashMap<String, Value>,
    /* private fields */
}

ID tokens are sent to the client application as part of an OpenID Connect flow. They can be sent alongside or instead of an access token. ID tokens are used by the client to authenticate the user. To learn more about how the Microsoft identity platform issues ID tokens, see ID tokens in the Microsoft identity platform.

Fields

code: Option<String>

id_token: String

state: Option<String>

session_state: Option<String>

additional_fields: HashMap<String, Value>

Implementations

impl IdToken

pub fn new( id_token: &str, code: Option<&str>, state: Option<&str>, session_state: Option<&str>, ) -> IdToken

pub fn decode_payload(&self) -> Result<Value>

Decode the id token payload.

pub fn decode_header(&self) -> Result<Header>

Decode the id token header.

pub fn enable_pii_logging(&mut self, log_pii: bool)

Enable or disable logging of personally identifiable information such as logging the id_token. This is disabled by default. When log_pii is enabled passing an IdToken to logging or print functions will log id_token field. By default this does not get logged.

Trait Implementations

impl AsRef<str> for IdToken

fn as_ref(&self) -> &str

Converts this type into a shared reference of the (usually inferred) input type.

impl Clone for IdToken

fn clone(&self) -> IdToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for IdToken

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

Formats the value using the given formatter.

impl Default for IdToken

fn default() -> IdToken

Returns the “default value” for a type.

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

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for IdToken

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

Formats the value using the given formatter.

impl FromStr for IdToken

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self, Self::Err>

Parses a string s to return a value of this type.

impl PartialEq for IdToken

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

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&str> for IdToken

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &str) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<AuthorizationResponse> for IdToken

type Error = AuthorizationFailure

The type returned in the event of a conversion error.

fn try_from(value: AuthorizationResponse) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<String> for IdToken

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: String) -> Result<Self, Self::Error>

Performs the conversion.

impl Eq for IdToken

impl StructuralPartialEq for IdToken