Struct ApiKeyPrincipal 

pub struct ApiKeyPrincipal {
    pub prefix: String,
    pub namespace: String,
    pub subject: String,
    pub scopes: Vec<String>,
    pub mode: ApiKeyMode,
}

A verified key’s answer to “who is calling, and what may they do?”.

Fields

prefix: String

The public prefix the request presented.

namespace: String

The app-chosen namespace the key was issued under.

subject: String

The opaque subject (tenant/account id) the key speaks for.

scopes: Vec<String>

What the key may do; the gate checks one of these per request.

mode: ApiKeyMode

Which environment the key belongs to.

Implementations

impl ApiKeyPrincipal

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

Whether the key carries scope; scopes are exact-match strings.

pub fn rate_limit_key(&self) -> String

The per-key rate-limit key apikey:<prefix>: a RateLimitPolicy arm matching that prefix sets the key’s budget, the way rate_limit_keys’ ip:/email: keys slot into the shared limiter (issue #538).

pub fn to_subject(&self) -> Subject

The Subject this key speaks for, for code shared with the session auth port; the session id is the prefix, so instant revocation already exists — revoke the key.

Trait Implementations

impl Clone for ApiKeyPrincipal

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyPrincipal

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

Formats the value using the given formatter.

impl Eq for ApiKeyPrincipal

impl PartialEq for ApiKeyPrincipal

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ApiKeyPrincipal