Struct ironoxide::user::JwtClaims

pub struct JwtClaims {
    pub sub: String,
    pub iat: u64,
    pub exp: u64,
    pub pid: u32,
    pub sid: String,
    pub kid: u32,
    pub uid: Option<String>,
}

Claims required to form a valid Jwt.

These are a mixture of public claims (predefined by the JWT standard - sub, iat, exp) and private claims (pid, sid, kid, uid). The private claims can be protected from collision by prefixing the claim names with "http://ironcore/". Some JWT generators such as Auth0 require a namespace on private claims. Note that the uid claim is a claim that is added by Auth0 - the sub claim is populated by the identity provider (if Auth0 is doing authentication via GitHub or another IDP), and the user's ID (email address) is placed in the uid claim. The Identity service currently looks for the uid claim, and if it is present, uses that instead of the sub claim as the source of the user's provided ID.

Fields

sub: String

Unique user ID

iat: u64

Issued time (seconds)

exp: u64

Expiration time (seconds)

We recommend it be set to iat + 120. The IronCore server will not use the value, and it will automatically reject JWTs that are received more than 120 seconds past iat.

pid: u32

Project ID

sid: String

Segment ID

kid: u32

Service key ID

uid: Option<String>

User ID

Trait Implementations

impl Clone for JwtClaims

pub fn clone(&self) -> JwtClaims

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwtClaims

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for JwtClaims

pub fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl Eq for JwtClaims

impl Hash for JwtClaims

pub fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

pub fn hash_slice<H>(data: &[Self], state: &mut H) where
    H: Hasher, 

Feeds a slice of this type into the given Hasher.

impl PartialEq<JwtClaims> for JwtClaims

pub fn eq(&self, other: &JwtClaims) -> bool

This method tests for self and other values to be equal, and is used by ==.

pub fn ne(&self, other: &JwtClaims) -> bool

This method tests for !=.

impl Serialize for JwtClaims

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

Serialize this value into the given Serde serializer.

impl StructuralEq for JwtClaims

impl StructuralPartialEq for JwtClaims