Struct AuthToken 

pub struct AuthToken {

    pub token_id: String,
    pub user_id: String,
    pub access_token: String,
    pub token_type: Option<String>,
    pub subject: Option<String>,
    pub issuer: Option<String>,
    pub refresh_token: Option<String>,
    pub issued_at: DateTime<Utc>,
    pub expires_at: DateTime<Utc>,
    pub scopes: Vec<String>,
    pub auth_method: String,
    pub client_id: Option<String>,
    pub user_profile: Option<UserProfile>,
    pub permissions: Vec<String>,
    pub roles: Vec<String>,
    pub metadata: TokenMetadata,
}

Represents an authentication token with all associated metadata.

Fields

token_id: String

Unique token identifier

user_id: String

User identifier this token belongs to

access_token: String

Access token value

token_type: Option<String>

Token type (e.g., “bearer”)

subject: Option<String>

Subject claim

issuer: Option<String>

Token issuer

refresh_token: Option<String>

Optional refresh token

issued_at: DateTime<Utc>

When the token was issued

expires_at: DateTime<Utc>

When the token expires

scopes: Vec<String>

Scopes granted to this token

auth_method: String

Authentication method used to obtain this token

client_id: Option<String>

Client ID that requested this token

user_profile: Option<UserProfile>

User profile data (optional)

permissions: Vec<String>

User’s permissions

roles: Vec<String>

User’s roles

metadata: TokenMetadata

Additional token metadata

Implementations

impl AuthToken

pub fn new( user_id: impl Into<String>, access_token: impl Into<String>, expires_in: Duration, auth_method: impl Into<String>, ) -> Self

Create a new authentication token.

pub fn access_token(&self) -> &str

Get the access token string.

pub fn user_id(&self) -> &str

Get the user ID.

pub fn expires_at(&self) -> DateTime<Utc>

Get the expiration time.

pub fn token_value(&self) -> &str

Get the token value

pub fn token_type(&self) -> Option<&str>

Get the token type

pub fn subject(&self) -> Option<&str>

Get the subject claim

pub fn issuer(&self) -> Option<&str>

Get the issuer

pub fn is_expired(&self) -> bool

Check if the token has expired.

pub fn is_expiring(&self, within: Duration) -> bool

Check if the token is expiring within the given duration.

pub fn is_revoked(&self) -> bool

Check if the token has been revoked.

pub fn is_valid(&self) -> bool

Check if the token is valid (not expired and not revoked).

pub fn revoke(&mut self, reason: Option<String>)

Revoke the token.

pub fn mark_used(&mut self)

Update the last used time and increment use count.

pub fn add_scope(&mut self, scope: impl Into<String>)

Add a scope to the token.

pub fn has_scope(&self, scope: &str) -> bool

Check if the token has a specific scope.

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

Set the refresh token.

pub fn with_client_id(self, client_id: impl Into<String>) -> Self

Set the client ID.

pub fn with_scopes(self, scopes: Vec<String>) -> Self

Set the token scopes.

pub fn with_metadata(self, metadata: TokenMetadata) -> Self

Add metadata to the token.

pub fn time_until_expiry(&self) -> Duration

Get time until expiration.

pub fn add_custom_claim(&mut self, key: impl Into<String>, value: Value)

Add a custom claim to the token metadata

pub fn get_custom_claim(&self, key: &str) -> Option<&Value>

Get a custom claim from the token metadata

pub fn has_permission(&self, permission: &str) -> bool

Check if the token has a specific permission

pub fn add_permission(&mut self, permission: impl Into<String>)

Add a permission to the token

pub fn add_role(&mut self, role: impl Into<String>)

Add a role to the token

pub fn has_role(&self, role: &str) -> bool

Check if the token has a specific role

pub fn with_permissions(self, permissions: Vec<String>) -> Self

Set the permissions

pub fn with_roles(self, roles: Vec<String>) -> Self

Set the roles

Trait Implementations

impl Clone for AuthToken

fn clone(&self) -> AuthToken

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AuthToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for AuthToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<'a, R: Row> FromRow<'a, R> for AuthToken

where &'a str: ColumnIndex<R>, String: Decode<'a, R::Database> + Type<R::Database>, Option<String>: Decode<'a, R::Database> + Type<R::Database>, DateTime<Utc>: Decode<'a, R::Database> + Type<R::Database>, Vec<String>: Decode<'a, R::Database> + Type<R::Database>, Option<UserProfile>: Decode<'a, R::Database> + Type<R::Database>, TokenMetadata: Decode<'a, R::Database> + Type<R::Database>,

fn from_row(__row: &'a R) -> Result<Self>

impl Serialize for AuthToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TokenToProfile for AuthToken

async fn to_profile(&self, _provider: &OAuthProvider) -> Result<UserProfile>

Convert a token to a user profile

impl TokenToProfile for AuthToken

fn to_profile<'life0, 'life1, 'async_trait>( &'life0 self, provider: &'life1 OAuthProvider, ) -> Pin<Box<dyn Future<Output = Result<UserProfile>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Convert this token to a user profile using the specified provider

fn to_profile_with_extractor<'life0, 'life1, 'life2, 'async_trait>( &'life0 self, provider: &'life1 OAuthProvider, extractor: &'life2 ProfileExtractor, ) -> Pin<Box<dyn Future<Output = Result<UserProfile>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait, 'life2: 'async_trait,

Convert this token to a user profile with a custom extractor