Struct ApiKeyAuth 

pub struct ApiKeyAuth {
    pub key_id: Uuid,
    pub user_id: Uuid,
    pub key_name: String,
    pub scopes: Vec<ApiKeyScope>,
    pub owner_is_admin: bool,
}

An authenticated caller via API key.

Use as an Axum handler parameter to enforce API key authentication.

Examples

use ironflow_auth::extractor::ApiKeyAuth;

async fn protected(key: ApiKeyAuth) -> String {
    format!("Key {} (user {})", key.key_name, key.user_id)
}

Fields

key_id: Uuid

The API key ID.

user_id: Uuid

The owner user ID.

key_name: String

The API key name.

scopes: Vec<ApiKeyScope>

Scopes granted to this key.

owner_is_admin: bool

Whether the key owner is an admin (checked at request time).

Implementations

impl ApiKeyAuth

pub fn has_scope(&self, required: &ApiKeyScope) -> bool

Check if the API key has a specific scope.

Trait Implementations

impl Clone for ApiKeyAuth

fn clone(&self) -> ApiKeyAuth

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKeyAuth

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

Formats the value using the given formatter.

impl<S> FromRequestParts<S> for ApiKeyAuth

where S: Send + Sync, Arc<dyn ApiKeyStore>: FromRef<S>, Arc<dyn UserStore>: FromRef<S>,

type Rejection = ApiKeyRejection

If the extractor fails it’ll use this “rejection” type. A rejection is a kind of error that can be converted into a response.

async fn from_request_parts( parts: &mut Parts, state: &S, ) -> Result<Self, Self::Rejection>

Perform the extraction.