Struct Identity 

pub struct Identity {
    pub user_id: String,
    pub is_staff: bool,
    pub is_superuser: bool,
    pub extras: HashMap<String, Value>,
}

Who the request belongs to, after authentication.

The shape is intentionally narrow: user_id, is_staff, and is_superuser cover most permission checks. An extras map carries app-specific bits (role names, organisation id, scope strings) for custom permission impls.

Fields

user_id: String

The authenticated user’s primary key, stringified so the same Identity shape works whether the active user model has an i64, String, or UUID primary key. Permission checks that need the typed PK back can parse on demand (identity.user_id.parse::<i64>()); the framework’s own permissions plugin and session store already speak strings.

is_staff: bool

Staff flag. Used by the built-in IsStaff permission class in umbral-rest.

is_superuser: bool

Superuser flag. A superuser bypasses all permission checks in the built-in permission classes; custom permission impls can consult this field to grant unconditional access.

extras: HashMap<String, Value>

App-specific extras a permission check might want to consult. umbral-auth doesn’t populate this; user-defined auth backends can stuff role names, organisation ids, etc. here.

Implementations

impl Identity

pub fn user(user_id: impl ToString) -> Self

Convenience constructor for a non-staff user. Accepts any stringifiable PK — Identity::user(42), Identity::user("42"), or Identity::user(uuid.to_string()) all work because the argument is impl ToString.

pub fn staff(self) -> Self

Promote to staff. Chainable.

pub fn with_staff(self, is_staff: bool) -> Self

Set the staff flag explicitly. Chainable.

pub fn with_superuser(self, is_superuser: bool) -> Self

Set the superuser flag explicitly. Chainable.

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

Insert an extras entry. Chainable.

Trait Implementations

impl Clone for Identity

fn clone(&self) -> Identity

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Identity

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Identity

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Identity

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

where __S: Serializer,

Serialize this value into the given Serde serializer.