Struct AuthenticatedAgent 

pub struct AuthenticatedAgent {
    pub agent_id: String,
    pub admin: bool,
    pub dbs: Option<Vec<String>>,
    pub read_only: bool,
    pub scope: Scope,
    pub subject: Option<String>,
    pub token_id: Option<String>,
}

Fields

agent_id: String

Agent the token was issued for; empty when the token is scoped to databases rather than to one agent.

admin: bool

dbs: Option<Vec<String>>

Databases this token may use: exact names or globs where * matches any run of characters. None means every database (allowed only when the server does not require the claim).

read_only: bool

Read-only tokens may search and read but not write. Same as scope == Scope::Read.

scope: Scope

What the token may do.

subject: Option<String>

The token’s sub claim.

token_id: Option<String>

The token’s jti claim.

Implementations

impl AuthenticatedAgent

pub fn authorize_db(&self, name: &str, write: bool) -> Result<(), ApiError>

Allow or refuse access to database name.

pub fn authorize_maintenance(&self, name: &str) -> Result<(), ApiError>

Allow or refuse dropping or backing up database name: admin tokens, or a token with the maintenance scope whose dbs names the database. A maintenance token must carry dbs even where the server accepts unscoped tokens, so it can never drop every database.

pub fn rate_key(&self) -> Option<String>

The key requests from this caller are rate limited under: the token’s sub, else its jti, else its agent.

pub fn agent(&self) -> Result<Option<AgentId>, ApiError>

The agent the token is bound to, if any.

Trait Implementations

impl Clone for AuthenticatedAgent

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 AuthenticatedAgent

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

Formats the value using the given formatter.