[−][src]Trait oauth2::TokenResponse
Common methods shared by all OAuth2 token implementations.
The methods in this trait are defined in
Section 5.1 of RFC 6749. This trait exists
separately from the StandardTokenResponse
struct to support customization by clients,
such as supporting interoperability with non-standards-complaint OAuth2 providers.
Required methods
fn access_token(&self) -> &AccessToken
REQUIRED. The access token issued by the authorization server.
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.
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.
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.
fn scopes(&self) -> Option<&Vec<Scope>>
OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The
scipe 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
.
Implementors
impl<EF, TT> TokenResponse<TT> for StandardTokenResponse<EF, TT> where
EF: ExtraTokenFields,
TT: TokenType,
[src]
EF: ExtraTokenFields,
TT: TokenType,
fn access_token(&self) -> &AccessToken
[src]
REQUIRED. The access token issued by the authorization server.
fn token_type(&self) -> &TT
[src]
REQUIRED. The type of the token issued as described in
Section 7.1.
Value is case insensitive and deserialized to the generic TokenType
parameter.
fn expires_in(&self) -> Option<Duration>
[src]
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.
fn refresh_token(&self) -> Option<&RefreshToken>
[src]
OPTIONAL. The refresh token, which can be used to obtain new access tokens using the same authorization grant as described in Section 6.
fn scopes(&self) -> Option<&Vec<Scope>>
[src]
OPTIONAL, if identical to the scope requested by the client; otherwise, REQUIRED. The
scipe 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
.