Struct AccessContext 

pub struct AccessContext {
    pub subject_id: Option<String>,
    pub tenant_id: Option<String>,
    pub roles: BTreeSet<String>,
    pub scopes: BTreeSet<String>,
    /* private fields */
}

The subject being checked against an access policy.

Fields

subject_id: Option<String>

Authenticated user or service principal ID.

tenant_id: Option<String>

Tenant carried with the subject, if any.

roles: BTreeSet<String>

Subject roles.

scopes: BTreeSet<String>

Subject scopes or permissions.

Implementations

impl AccessContext

pub fn anonymous() -> Self

Anonymous context with no roles, scopes, tenant, or bypass.

pub fn subject(subject_id: impl Into<String>) -> Self

Authenticated context for a subject ID.

pub fn super_admin(_token: SuperAdminToken) -> Self

Super-admin context. The token cannot be fabricated outside qail-core.

pub fn with_tenant(self, tenant_id: impl Into<String>) -> Self

Attach a tenant ID.

pub fn with_role(self, role: impl Into<String>) -> Self

Attach one role.

pub fn with_roles<I, S>(self, roles: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Attach many roles.

pub fn with_scope(self, scope: impl Into<String>) -> Self

Attach one scope.

pub fn with_scopes<I, S>(self, scopes: I) -> Self

where I: IntoIterator<Item = S>, S: Into<String>,

Attach many scopes.

pub fn bypasses_access(&self) -> bool

Returns true when this context bypasses vertical checks.

Trait Implementations

impl Clone for AccessContext

fn clone(&self) -> AccessContext

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AccessContext

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

Formats the value using the given formatter.

impl Default for AccessContext

fn default() -> Self

Returns the “default value” for a type.

impl Eq for AccessContext

impl PartialEq for AccessContext

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

Tests for self and other values to be equal, and is used by ==.

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

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

impl StructuralPartialEq for AccessContext