Struct openidconnect::StandardTokenResponse

pub struct StandardTokenResponse<EF, TT> where
    EF: ExtraTokenFields,
    TT: TokenType,  { /* fields omitted */ }

Standard OAuth2 token response.

This struct includes the fields defined in Section 5.1 of RFC 6749, as well as extensions defined by the EF type parameter.

Implementations

impl<EF, TT> StandardTokenResponse<EF, TT> where
    EF: ExtraTokenFields,
    TT: TokenType, 

pub fn new(
    access_token: AccessToken,
    token_type: TT,
    extra_fields: EF
) -> StandardTokenResponse<EF, TT>

Instantiate a new OAuth2 token response.

pub fn set_access_token(&mut self, access_token: AccessToken)

Set the access_token field.

pub fn set_token_type(&mut self, token_type: TT)

Set the token_type field.

pub fn set_expires_in(&mut self, expires_in: Option<&Duration>)

Set the expires_in field.

pub fn set_refresh_token(&mut self, refresh_token: Option<RefreshToken>)

Set the refresh_token field.

pub fn set_scopes(&mut self, scopes: Option<Vec<Scope, Global>>)

Set the scopes field.

pub fn extra_fields(&self) -> &EF

Extra fields defined by the client application.

pub fn set_extra_fields(&mut self, extra_fields: EF)

Set the extra fields defined by the client application.

Trait Implementations

impl<EF, TT> Clone for StandardTokenResponse<EF, TT> where
    EF: Clone + ExtraTokenFields,
    TT: Clone + TokenType, 

pub fn clone(&self) -> StandardTokenResponse<EF, TT>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<EF, TT> Debug for StandardTokenResponse<EF, TT> where
    EF: Debug + ExtraTokenFields,
    TT: Debug + TokenType, 

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

Formats the value using the given formatter.

impl<'de, EF, TT> Deserialize<'de> for StandardTokenResponse<EF, TT> where
    EF: ExtraTokenFields,
    TT: TokenType, 

pub fn deserialize<__D>(
    __deserializer: __D
) -> Result<StandardTokenResponse<EF, TT>, <__D as Deserializer<'de>>::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl<EF, TT> Serialize for StandardTokenResponse<EF, TT> where
    EF: ExtraTokenFields,
    TT: TokenType, 

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

Serialize this value into the given Serde serializer.

impl<AC, EF, GC, JE, JS, JT, TT> TokenResponse<AC, GC, JE, JS, JT, TT> for StandardTokenResponse<IdTokenFields<AC, EF, GC, JE, JS, JT>, TT> where
    AC: AdditionalClaims,
    EF: ExtraTokenFields,
    GC: GenderClaim,
    JE: JweContentEncryptionAlgorithm<JT>,
    JS: JwsSigningAlgorithm<JT>,
    JT: JsonWebKeyType,
    TT: TokenType, 

fn id_token(&self) -> Option<&IdToken<AC, GC, JE, JS, JT>>

Returns the ID token provided by the token response.

impl<EF, TT> TokenResponse<TT> for StandardTokenResponse<EF, TT> where
    EF: ExtraTokenFields,
    TT: TokenType, 

pub fn access_token(&self) -> &AccessToken

REQUIRED. The access token issued by the authorization server.

pub fn token_type(&self) -> &TT

REQUIRED. The type of the token issued as described in Section 7.1. Value is case insensitive and deserialized to the generic TokenType parameter.

pub fn expires_in(&self) -> Option<Duration>

RECOMMENDED. The lifetime in seconds of the access token. For example, the value 3600 denotes that the access token will expire in one hour from the time the response was generated. If omitted, the authorization server SHOULD provide the expiration time via other means or document the default value.

pub fn refresh_token(&self) -> Option<&RefreshToken>

OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.

pub fn scopes(&self) -> Option<&Vec<Scope, Global>>

OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The scope of the access token as described by Section 3.3. If included in the response, this space-delimited field is parsed into a Vec of individual scopes. If omitted from the response, this field is None.