Struct ApiKey 

pub struct ApiKey { /* private fields */ }

Represents an API key with associated metadata and permissions.

Example

use actix_security::http::security::api_key::ApiKey;

let key = ApiKey::new("sk_live_abc123")
    .name("Production API Key")
    .owner("service-account@example.com")
    .roles(vec!["API_USER".into()])
    .authorities(vec!["api:read".into(), "api:write".into()])
    .expires_in(Duration::from_secs(86400 * 365)); // 1 year

Implementations

impl ApiKey

pub fn new(key: impl Into<String>) -> Self

Creates a new API key with the given value.

Arguments

• key - The API key string

Example

let key = ApiKey::new("sk_live_abc123");

pub fn builder(key: impl Into<String>) -> ApiKeyBuilder

Creates a builder for more complex key creation.

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

Sets the human-readable name for this key.

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

Sets the owner of this key.

pub fn roles(self, roles: Vec<String>) -> Self

Sets the roles for this key.

pub fn authorities(self, authorities: Vec<String>) -> Self

Sets the authorities for this key.

pub fn enabled(self, enabled: bool) -> Self

Sets whether the key is enabled.

pub fn expires_at(self, expires_at: SystemTime) -> Self

Sets the expiration time.

pub fn expires_in(self, duration: Duration) -> Self

Sets expiration relative to now.

pub fn with_metadata( self, key: impl Into<String>, value: impl Into<String>, ) -> Self

Adds metadata to the key.

pub fn get_key(&self) -> &str

Returns the API key value.

pub fn get_name(&self) -> Option<&str>

Returns the human-readable name.

pub fn get_owner(&self) -> Option<&str>

Returns the owner.

pub fn get_roles(&self) -> &[String]

Returns the roles.

pub fn get_authorities(&self) -> &[String]

Returns the authorities.

pub fn is_enabled(&self) -> bool

Returns whether the key is enabled.

pub fn get_created_at(&self) -> SystemTime

Returns when the key was created.

pub fn get_expires_at(&self) -> Option<SystemTime>

Returns when the key expires.

pub fn get_metadata(&self) -> &HashMap<String, String>

Returns the metadata.

pub fn is_expired(&self) -> bool

Checks if the key has expired.

pub fn is_valid(&self) -> bool

Checks if the key is valid (enabled and not expired).

pub fn has_role(&self, role: &str) -> bool

Checks if the key has the specified role.

pub fn has_any_role(&self, roles: &[&str]) -> bool

Checks if the key has any of the specified roles.

pub fn has_authority(&self, authority: &str) -> bool

Checks if the key has the specified authority.

pub fn has_any_authority(&self, authorities: &[&str]) -> bool

Checks if the key has any of the specified authorities.

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiKey

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

Formats the value using the given formatter.