Struct Principal 

pub struct Principal {
    pub user_id: Uuid,
    pub organizations: Vec<OrgMembership>,
}

The authenticated caller behind a request.

Fields

user_id: Uuid

organizations: Vec<OrgMembership>

Organisations the caller belongs to (loaded per request). Drives all org-scoped access and role: checks.

Implementations

impl Principal

pub fn membership(&self, org: Uuid) -> Option<&OrgMembership>

Membership in a specific organisation, if any.

pub fn is_member(&self, org: Uuid) -> bool

Whether the caller belongs to org.

pub fn role_in(&self, org: Uuid) -> Option<&str>

The caller’s primary role within org, if any.

This is what a hook context’s role reports. Authorization asks has_role_in instead, because holding a role is not the same as it being your headline one.

pub fn roles_in(&self, org: Uuid) -> &[String]

Every role the caller holds in org.

pub fn has_role_in(&self, org: Uuid, role: &str) -> bool

Whether the caller may act as role in org. The question every role: permission asks.

pub fn is_admin_of(&self, org: Uuid) -> bool

Whether the caller administers org.

pub fn org_ids(&self) -> Vec<Uuid>

Every organisation id the caller belongs to.

pub fn org_ids_with_role(&self, role: &str) -> Vec<Uuid>

Organisations where the caller may act as role — including the ones they merely administer.

Trait Implementations

impl Clone for Principal

fn clone(&self) -> Principal

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Principal

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

Formats the value using the given formatter.

impl Eq for Principal

impl PartialEq for Principal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Principal