Struct Claims

pub struct Claims {
    pub sub: Uuid,
    pub exp: i64,
    pub iss: String,
    pub token_type: ClaimTokenType,
    pub email: Option<String>,
    pub user_id: Option<Uuid>,
    pub tenant_id: Uuid,
    pub roles: Vec<String>,
    pub permissions: Vec<String>,
    pub metadata: Option<ClaimMetadata>,
}

The raw claims encoded in a Frontegg access token.

Consult the JSON Web Token specification and the Frontegg documentation to determine the precise semantics of these fields.

Fields

sub: Uuid

The “subject” of the token.

For tokens of type UserToken, this is the ID of the Frontegg user itself. For tokens of type UserApiToken and TenantApiToken, this is the client ID of the API token.

exp: i64

The time at which the claims expire, represented in seconds since the Unix epoch.

iss: String

The “issuer” of the token.

This is always the domain associated with the Frontegg workspace.

token_type: ClaimTokenType

The type of API token.

email: Option<String>

For tokens of type UserToken and UserApiToken, the email address of the authenticated user.

user_id: Option<Uuid>

For tokens of type UserApiToken, the ID of the authenticated user.

tenant_id: Uuid

The ID of the authenticated tenant.

roles: Vec<String>

The IDs of the roles granted by the token.

permissions: Vec<String>

The IDs of the permissions granted by the token.

metadata: Option<ClaimMetadata>

Metadata embedded in the JWT.

Implementations

impl Claims

pub fn user(&self) -> Result<&str, Error>

Returns the name of the user associated with the token.

pub fn user_id(&self) -> Result<Uuid, Error>

Returns the ID of the user associated with the token.

Trait Implementations

impl Clone for Claims

fn clone(&self) -> Claims

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Claims

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Claims

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Claims

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

where __S: Serializer,

Serialize this value into the given Serde serializer.