Struct TokenResponseFields 

#[non_exhaustive]
pub struct TokenResponseFields {
    pub access_token: String,
    pub refresh_token: Option<String>,
    pub expires_in: Option<u64>,
    pub token_type: Option<String>,
    pub id_token: Option<String>,
    pub scope: Option<String>,
}

The standard fields extracted from a token endpoint response.

Consumed internally by loopauth to build a crate::TokenSet.

For the standard flat OAuth 2.0 response format, this struct is deserialized directly. For non-standard providers, define a custom type that implements Into<TokenResponseFields> and pass it to CliTokenClientBuilder::token_response_type.

Example: Custom provider response

use loopauth::TokenResponseFields;
use serde::Deserialize;

#[derive(Deserialize)]
struct SlackV2TokenResponse {
    authed_user: SlackAuthedUser,
}

#[derive(Deserialize)]
struct SlackAuthedUser {
    access_token: String,
    refresh_token: Option<String>,
    expires_in: Option<u64>,
}

impl From<SlackV2TokenResponse> for TokenResponseFields {
    fn from(resp: SlackV2TokenResponse) -> Self {
        TokenResponseFields::new(resp.authed_user.access_token)
            .with_refresh_token(resp.authed_user.refresh_token)
            .with_expires_in(resp.authed_user.expires_in)
            .with_token_type(Some("Bearer".to_string()))
    }
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

access_token: String

The access token issued by the authorization server.

refresh_token: Option<String>

The refresh token, if the server issued one.

expires_in: Option<u64>

The lifetime in seconds of the access token.

token_type: Option<String>

The token type (e.g., "Bearer").

id_token: Option<String>

The ID token JWT, if OpenID Connect was requested.

scope: Option<String>

The scope granted by the server (space-separated).

Implementations

impl TokenResponseFields

pub const fn new(access_token: String) -> Self

Create a new TokenResponseFields with the required access token.

All optional fields default to None. Use the with_* methods to set them.

pub fn with_refresh_token(self, refresh_token: Option<String>) -> Self

Set the refresh token.

pub const fn with_expires_in(self, expires_in: Option<u64>) -> Self

Set the token lifetime in seconds.

pub fn with_token_type(self, token_type: Option<String>) -> Self

Set the token type.

pub fn with_id_token(self, id_token: Option<String>) -> Self

Set the ID token JWT.

pub fn with_scope(self, scope: Option<String>) -> Self

Set the granted scope.

Trait Implementations

impl Clone for TokenResponseFields

fn clone(&self) -> TokenResponseFields

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenResponseFields

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TokenResponseFields

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.