Struct TokenClaims 

pub struct TokenClaims {
    pub sub: Option<String>,
    pub iss: Option<String>,
    pub aud: Option<String>,
    pub exp: Option<u64>,
    pub iat: Option<u64>,
    pub nbf: Option<u64>,
    pub jti: Option<String>,
    pub tenant_id: Option<String>,
    pub roles: Vec<String>,
    pub permissions: Vec<String>,
    pub extra: HashMap<String, Value>,
}

JWT token claims

Fields

sub: Option<String>

Subject (user ID)

iss: Option<String>

Issuer

aud: Option<String>

Audience

exp: Option<u64>

Expiration time (Unix timestamp)

iat: Option<u64>

Issued at (Unix timestamp)

nbf: Option<u64>

Not before (Unix timestamp)

jti: Option<String>

JWT ID

tenant_id: Option<String>

Tenant ID (custom claim)

roles: Vec<String>

Roles (custom claim)

permissions: Vec<String>

Permissions (custom claim)

extra: HashMap<String, Value>

Additional custom claims

Implementations

impl TokenClaims

pub fn for_user(user_id: impl Into<String>) -> Self

Create new claims for a user

pub fn expires_in(self, duration: Duration) -> Self

Set expiration

pub fn for_tenant(self, tenant_id: impl Into<String>) -> Self

Set tenant

pub fn with_role(self, role: impl Into<String>) -> Self

Add role

pub fn with_permission(self, permission: impl Into<String>) -> Self

Add permission

pub fn with_claim(self, key: impl Into<String>, value: impl Serialize) -> Self

Add custom claim

Trait Implementations

impl Clone for TokenClaims

fn clone(&self) -> TokenClaims

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TokenClaims

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

Formats the value using the given formatter.

impl Default for TokenClaims

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TokenClaims

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for TokenClaims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.