Skip to main content

UserContext

Struct UserContext 

Source
pub struct UserContext {
    pub subject: String,
    pub principal: PrincipalKind,
    pub email: Option<String>,
    pub username: Option<String>,
    pub roles: Vec<String>,
    pub scopes: Vec<String>,
    pub capabilities: Vec<String>,
    pub api_key_id: Option<String>,
}
Expand description

The authenticated caller, resolved once at the edge (gateway) and propagated to every service via signed headers. This is the single identity type shared across all services.

Fields§

§subject: String

Canonical, opaque principal id. For User this is the user’s UUID (as a string); for ApiKey/Service it is the principal’s stable id. Use UserContext::user_id when a typed UUID is required.

§principal: PrincipalKind§email: Option<String>§username: Option<String>§roles: Vec<String>§scopes: Vec<String>§capabilities: Vec<String>

Effective account capabilities (entitlements) resolved by the identity service.

§api_key_id: Option<String>

Present only for ApiKey principals.

Implementations§

Source§

impl UserContext

Source

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

Parse the subject as a user UUID. Errors for non-UUID principals (e.g. API keys).

Source

pub fn user_id_opt(&self) -> Option<Uuid>

Parse the subject as a user UUID, or None for non-UUID principals.

Source

pub fn is_user(&self) -> bool

Source

pub fn is_api_key(&self) -> bool

Source

pub fn is_service(&self) -> bool

Source

pub fn has_role(&self, role: &str) -> bool

Source

pub fn has_any_role(&self, roles: &[&str]) -> bool

Source

pub fn require_role(&self, role: &str) -> Result<(), AppError>

Source

pub fn require_any_role(&self, roles: &[&str]) -> Result<(), AppError>

Source

pub fn is_admin(&self) -> bool

Platform-admin check: holds ADMIN or any *_ADMIN role (case-insensitive).

Source

pub fn require_admin(&self) -> Result<(), AppError>

Source

pub fn has_scope(&self, scope: &str) -> bool

Source

pub fn require_scope(&self, scope: &str) -> Result<(), AppError>

Source

pub fn has_capability(&self, capability: &str) -> bool

Source

pub fn require_capability(&self, capability: &str) -> Result<(), AppError>

Trait Implementations§

Source§

impl Clone for UserContext

Source§

fn clone(&self) -> UserContext

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for UserContext

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for UserContext

Source§

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

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Serialize for UserContext

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.