Struct kanidm_proto::v1::UserAuthToken

pub struct UserAuthToken {
    pub session_id: Uuid,
    pub issued_at: OffsetDateTime,
    pub expiry: Option<OffsetDateTime>,
    pub purpose: UatPurpose,
    pub uuid: Uuid,
    pub displayname: String,
    pub spn: String,
    pub mail_primary: Option<String>,
    pub ui_hints: BTreeSet<UiHint>,
}

The currently authenticated user, and any required metadata for them to properly authorise them. This is similar in nature to oauth and the krb PAC/PAD structures. This information is transparent to clients and CAN be parsed by them!

This structure and how it works will very much change over time from this point onward! This means on updates, that sessions will invalidate in many cases.

Fields

session_id: Uuid

issued_at: OffsetDateTime

expiry: Option<OffsetDateTime>

If none, there is no expiry, and this is always valid. If there is an expiry, check that the current time < expiry.

purpose: UatPurpose

uuid: Uuid

displayname: String

spn: String

mail_primary: Option<String>

ui_hints: BTreeSet<UiHint>

Implementations

impl UserAuthToken

pub fn name(&self) -> &str

pub fn purpose_readwrite_active(&self, ct: OffsetDateTime) -> bool

Show if the uat at a current point in time has active read-write capabilities.

Trait Implementations

impl Clone for UserAuthToken

fn clone(&self) -> UserAuthToken

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for UserAuthToken

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for UserAuthToken

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for UserAuthToken

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

Formats the value using the given formatter.

impl PartialEq for UserAuthToken

fn eq(&self, other: &Self) -> 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 UserAuthToken

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<'__s> ToSchema<'__s> for UserAuthToken

fn schema() -> (&'__s str, RefOr<Schema>)

Return a tuple of name and schema or reference to a schema that can be referenced by the name or inlined directly to responses, request bodies or parameters.

fn aliases() -> Vec<(&'__s str, Schema)>

Optional set of alias schemas for the [ToSchema::schema].

impl Eq for UserAuthToken