Enum StandardRevocableToken

#[non_exhaustive]
pub enum StandardRevocableToken {
    AccessToken(AccessToken),
    RefreshToken(RefreshToken),
}

A token representation usable with authorization servers that support RFC 7009 token revocation.

For use with revoke_token().

Automatically reports the correct RFC 7009 token_type_hint value corresponding to the token type variant used, i.e. access_token for AccessToken and secret_token for RefreshToken.

Example

Per RFC 7009, Section 2 prefer revocation by refresh token which, if issued to the client, must be supported by the server, otherwise fallback to access token (which may or may not be supported by the server).

let client = BasicClient::new(ClientId::new("aaa".to_string()))
    .set_auth_uri(AuthUrl::new("https://example.com/auth".to_string()).unwrap())
    .set_token_uri(TokenUrl::new("https://example.com/token".to_string()).unwrap())
    // Be sure to set a revocation URL.
    .set_revocation_url(RevocationUrl::new("https://revocation/url".to_string()).unwrap());

// ...

let token_to_revoke: StandardRevocableToken = match token_response.refresh_token() {
    Some(token) => token.into(),
    None => token_response.access_token().into(),
};

client
    .revoke_token(token_to_revoke)?
    .request(&http_client)

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

AccessToken(AccessToken)

A representation of an AccessToken suitable for use with revoke_token().

RefreshToken(RefreshToken)

A representation of an RefreshToken suitable for use with revoke_token().

Trait Implementations

impl Clone for StandardRevocableToken

fn clone(&self) -> StandardRevocableToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for StandardRevocableToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for StandardRevocableToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&AccessToken> for StandardRevocableToken

fn from(token: &AccessToken) -> Self

Converts to this type from the input type.

impl From<&RefreshToken> for StandardRevocableToken

fn from(token: &RefreshToken) -> Self

Converts to this type from the input type.

impl From<AccessToken> for StandardRevocableToken

fn from(token: AccessToken) -> Self

Converts to this type from the input type.

impl From<RefreshToken> for StandardRevocableToken

fn from(token: RefreshToken) -> Self

Converts to this type from the input type.

impl RevocableToken for StandardRevocableToken

fn type_hint(&self) -> Option<&str>

Indicates the type of the token to be revoked, as defined by RFC 7009, Section 2.1, i.e.:

• access_token: An access token as defined in RFC 6749, Section 1.4

• refresh_token: A refresh token as defined in RFC 6749, Section 1.5

fn secret(&self) -> &str

The actual token value to be revoked.

impl Serialize for StandardRevocableToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.