Struct CreateKeyRequest 

pub struct CreateKeyRequest {

    pub config_id: Option<String>,
    pub user_id: Option<String>,
    pub organization_id: Option<String>,
    pub name: Option<String>,
    pub prefix: Option<String>,
    pub expires_in: Option<f64>,
    pub remaining: Option<f64>,
    pub rate_limit_enabled: Option<bool>,
    pub rate_limit_time_window: Option<f64>,
    pub rate_limit_max: Option<f64>,
    pub refill_interval: Option<f64>,
    pub refill_amount: Option<f64>,
    pub permissions: Option<HashMap<String, Vec<String>>>,
    pub metadata: Option<Value>,
}

API key creation parameters for HTTP and trusted server callers.

Fields

config_id: Option<String>

Configuration to use, or the default configuration when absent.

user_id: Option<String>

User authorizing a server-side creation; HTTP clients must omit this field.

organization_id: Option<String>

Organization owning the key when the configuration references organizations.

name: Option<String>

Display name for the key.

prefix: Option<String>

Prefix prepended to the generated key.

expires_in: Option<f64>

Lifetime in seconds; null or absence uses the configured default.

remaining: Option<f64>

Remaining uses, available only to trusted server callers.

rate_limit_enabled: Option<bool>

Enable rate limiting for this key, available only to server callers.

rate_limit_time_window: Option<f64>

Rate limit window in milliseconds, available only to server callers.

rate_limit_max: Option<f64>

Requests per window, available only to server callers.

refill_interval: Option<f64>

Refill interval in milliseconds, available only to server callers.

refill_amount: Option<f64>

Uses restored per refill, available only to server callers.

permissions: Option<HashMap<String, Vec<String>>>

Resource permissions, available only to server callers.

metadata: Option<Value>

Optional metadata; preservation of null matches the upstream wire contract.

Trait Implementations

impl Clone for CreateKeyRequest

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 CreateKeyRequest

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

Formats the value using the given formatter.

impl Default for CreateKeyRequest

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for CreateKeyRequest

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for CreateKeyRequest

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validate for CreateKeyRequest

fn validate(&self) -> Result<(), ValidationErrors>