Struct tame_oidc::oidc::Token

pub struct Token {
    pub access_token: String,
    pub token_type: String,
    pub expires_in: i64,
    pub expires_in_timestamp: i64,
    pub scope: String,
    pub id_token: Option<String>,
    pub refresh_token: Option<String>,
}

This is the schema of the server’s response.

Fields

access_token: String

The actual token

token_type: String

The token type - most often bearer

expires_in: i64

The time until the token expires and a new one needs to be requested

expires_in_timestamp: i64

The time until the token expires and a new one needs to be requested

scope: String

The scope used for this token - most often openid

id_token: Option<String>

A JSON Web Token that contains information about an authentication event and claims about the authenticated user.

refresh_token: Option<String>

An opaque refresh token. This is returned if the offline_access scope is granted.

Implementations

impl Token

pub fn from_response<S>(response: Response<S>) -> Result<Self, Error> where
    S: AsRef<[u8]>, 

Once a response has been received for a token request, call this method to deserialize the token and store it in the cache so that future API requests don’t have to retrieve a new token, until it expires.

Trait Implementations

impl Clone for Token

fn clone(&self) -> Token

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Token

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

Formats the value using the given formatter.

impl PartialEq<Token> for Token

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

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

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

This method tests for !=.

impl StructuralPartialEq for Token