Struct ApiKey

pub struct ApiKey {
    pub id: ApiKeyID,
    pub name: String,
    pub description: Option<String>,
    pub key: String,
    pub status: ApiKeyStatus,
    pub permissions: Vec<String>,
    pub expires_at: Option<DateTime<Utc>>,
    pub last_used_at: Option<DateTime<Utc>>,
    pub created_at: DateTime<Utc>,
    pub updated_at: DateTime<Utc>,
}

ApiKey entity

Fields

id: ApiKeyID

Unique Paddle ID for this API key entity, prefixed with apikey_.

name: String

Short name of this API key. Typically unique and human-identifiable.

description: Option<String>

Short description of this API key. Typically gives details about what the API key is used for and where it’s used.

key: String

An obfuscated version of this API key, prefixed with pdl_ and containing _apikey_.

status: ApiKeyStatus

Status of this API key.

permissions: Vec<String>

Permissions assigned to this API key. Determines what actions the API key can perform.

expires_at: Option<DateTime<Utc>>

Datetime of when this API key expires.

last_used_at: Option<DateTime<Utc>>

Datetime of when this API key was last used (accurate to within 1 hour). null if never used.

created_at: DateTime<Utc>

Datetime of when this entity was created. Set automatically by Paddle.

updated_at: DateTime<Utc>

Datetime of when this entity was updated. Set automatically by Paddle.

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.

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 Serialize for ApiKey

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.