Struct ironoxide::user::JwtClaims

pub struct JwtClaims {
    pub sub: String,
    pub iat: u64,
    pub exp: u64,
    pub pid: Option<u32>,
    pub prefixed_pid: Option<u32>,
    pub sid: Option<String>,
    pub prefixed_sid: Option<String>,
    pub kid: Option<u32>,
    pub prefixed_kid: Option<u32>,
    pub uid: Option<String>,
    pub prefixed_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: Option<u32>

Project ID

prefixed_pid: Option<u32>

sid: Option<String>

Segment ID

prefixed_sid: Option<String>

kid: Option<u32>

Service key ID

prefixed_kid: Option<u32>

uid: Option<String>

User ID

prefixed_uid: Option<String>

Trait Implementations

impl Clone for JwtClaims

fn clone(&self) -> JwtClaims

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for JwtClaims

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

Formats the value using the given formatter.

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

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

Deserialize this value from the given Serde deserializer.

impl Hash for JwtClaims

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

Feeds this value into the given Hasher.

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

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

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

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for JwtClaims

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

Serialize this value into the given Serde serializer.

impl Eq for JwtClaims

impl StructuralEq for JwtClaims

impl StructuralPartialEq for JwtClaims