Struct CreateApiKeyResponse 

pub struct CreateApiKeyResponse {
    pub created_at: DateTime<Utc>,
    pub expires_at: Option<DateTime<Utc>>,
    pub id: Uuid,
    pub key: String,
    pub key_prefix: String,
    pub name: String,
    pub rate_limit_override: Option<i32>,
    pub scopes: Vec<ApiKeyScope>,
}

Response returned when creating an API key. The raw key is only shown once.

JSON schema

{
 "description": "Response returned when creating an API key.\nThe raw key is only shown once.",
 "type": "object",
 "required": [
   "created_at",
   "id",
   "key",
   "key_prefix",
   "name",
   "scopes"
 ],
 "properties": {
   "created_at": {
     "description": "Creation date.",
     "type": "string",
     "format": "date-time"
   },
   "expires_at": {
     "description": "Expiration date.",
     "type": [
       "string",
       "null"
     ],
     "format": "date-time"
   },
   "id": {
     "description": "API key ID.",
     "type": "string",
     "format": "uuid"
   },
   "key": {
     "description": "The full raw API key (only returned at creation time).",
     "type": "string"
   },
   "key_prefix": {
     "description": "First characters for identification.",
     "type": "string"
   },
   "name": {
     "description": "Key name.",
     "type": "string"
   },
   "rate_limit_override": {
     "description": "Per-key rate limit override (requests per minute), if set.",
     "type": [
       "integer",
       "null"
     ],
     "format": "int32",
     "minimum": 0.0
   },
   "scopes": {
     "description": "Granted scopes.",
     "type": "array",
     "items": {
       "$ref": "#/components/schemas/ApiKeyScope"
     }
   }
 }
}
```ignore
</details>

Fields

created_at: DateTime<Utc>

Creation date.

expires_at: Option<DateTime<Utc>>

Expiration date.

id: Uuid

API key ID.

key: String

The full raw API key (only returned at creation time).

key_prefix: String

First characters for identification.

name: String

Key name.

rate_limit_override: Option<i32>

Per-key rate limit override (requests per minute), if set.

scopes: Vec<ApiKeyScope>

Granted scopes.

Implementations

impl CreateApiKeyResponse

pub fn builder() -> CreateApiKeyResponse

Trait Implementations

impl Clone for CreateApiKeyResponse

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 CreateApiKeyResponse

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for CreateApiKeyResponse

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<CreateApiKeyResponse> for CreateApiKeyResponse

fn from(value: CreateApiKeyResponse) -> Self

Converts to this type from the input type.

impl Serialize for CreateApiKeyResponse

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<CreateApiKeyResponse> for CreateApiKeyResponse

type Error = ConversionError

The type returned in the event of a conversion error.

fn try_from(value: CreateApiKeyResponse) -> Result<Self, ConversionError>

Performs the conversion.