Struct ApiKey

pub struct ApiKey {
    pub id: String,
    pub name: String,
    pub created_at: String,
    pub created_by: ApiKeyCreator,
    pub partial_key_hint: Option<String>,
    pub status: ApiKeyStatus,
    pub key_type: String,
    pub workspace_id: Option<String>,
}

An API key available through the Anthropic Admin API.

Fields

id: String

Unique API key identifier

name: String

Name of the API key

created_at: String

RFC 3339 datetime string representing the time at which the API key was created

created_by: ApiKeyCreator

Information about who created the API key

partial_key_hint: Option<String>

Partially redacted hint for the API key

status: ApiKeyStatus

Status of the API key

key_type: String

Object type (always “api_key” for API Keys)

workspace_id: Option<String>

ID of the Workspace associated with the API key, or null if the API key belongs to the default Workspace

Implementations

impl ApiKey

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

Creates a builder for getting a specific API key.

Example

let credentials = Credentials::from_env();

let api_key = ApiKey::builder("api_key_123456789")
    .credentials(credentials)
    .create()
    .await?;

pub async fn create(request: ApiKeyRequest) -> ApiResponseOrError<Self>

Gets information about a specific API key.

Example

let credentials = Credentials::from_env();
let request = ApiKeyRequest {
    api_key_id: "api_key_123456789".to_string(),
    credentials: Some(credentials),
};

let api_key = ApiKey::create(request).await?;

pub fn update_builder(api_key_id: impl Into<String>) -> ApiKeyUpdateBuilder

Creates a builder for updating an API key.

Example

let credentials = Credentials::from_env();

let updated_api_key = ApiKey::update_builder("api_key_123456789")
    .credentials(credentials)
    .name("New API Key Name")
    .status(ApiKeyStatus::Inactive)
    .create()
    .await?;

pub async fn update(request: ApiKeyUpdateRequest) -> ApiResponseOrError<Self>

Updates an API key with the given request parameters.

Example

let credentials = Credentials::from_env();
let request = ApiKeyUpdateRequest {
    api_key_id: "api_key_123456789".to_string(),
    name: Some("New API Key Name".to_string()),
    status: Some(ApiKeyStatus::Inactive),
    credentials: Some(credentials),
};

let updated_api_key = ApiKey::update(request).await?;

Trait Implementations

impl Clone for ApiKey

fn clone(&self) -> ApiKey

Returns a copy 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.

impl<'de> Deserialize<'de> for ApiKey

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ApiKey

fn eq(&self, other: &ApiKey) -> 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 Eq for ApiKey

impl StructuralPartialEq for ApiKey