ApiKeyRevealedDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
A newly created API key, including its plaintext value.
Values
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
Fields
| Field | Type | Description | ||||||
|---|---|---|---|---|---|---|---|---|
id
required |
string (uuid) |
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
name
required |
string | Gets or sets the display name of the API key.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
keyPrefix
required |
string | Gets or sets the leading characters of the key value, safe to display. `null` for a key
the rewrap backfill has not reached.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
last4
required |
string | Gets or sets the trailing characters of the key value, safe to display. `null` for a key
the rewrap backfill has not reached.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
environment
required |
ApiKeyEnvironment ApiKeyEnvironment | Gets or sets which world the key acts in, or `null` when it has never been stamped.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
status
required |
ApiKeyStatus ApiKeyStatus | Gets or sets the key's administrative state.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
maskedKey
required |
string | Gets the key's display form: its retained prefix, an ellipsis, and its last characters. This
is the only representation of the value any read path carries.
nullableread only
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
lastUsedAt
required |
string (date-time) | Gets or sets the UTC instant the key was last used to authenticate, or `null` when it
has no recorded use.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
creationTime
required |
string (date-time) | Gets or sets the UTC instant the key was created.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
merchantId
required |
string (uuid) | Gets or sets the merchant the key was minted for, or `null` when it is not tied to one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
active
required |
boolean | Gets or sets a value indicating whether the API key is active.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
expireAt
required |
string (date-time) | Gets or sets the expiration date for the API key. Null indicates the key does not expire.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
userId
required |
string (uuid) | Gets or sets the user ID that owns this API key.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
replacesKeyId
required |
string (uuid) | Gets or sets the key this one was minted to replace, or `null` when it was not created
by a rotation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
replacedByKeyId
required |
string (uuid) | Gets or sets the key minted to replace this one, or `null` when it has not been rotated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
overlapExpiresAt
required |
string (date-time) | Gets or sets when this key's rotation overlap closes and it stops authenticating, or
`null` when it is not in one.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
allowedCidrs
required |
array of string array of | Gets or sets the source addresses this key may be used from, as CIDR ranges or bare
addresses, or `null` when it is not bound to any and may be used from anywhere.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
scopes
required |
array of string array of | Gets or sets the capability scopes this key is restricted to, or `null` when it is
unrestricted and may reach everything its owner can.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
key
required |
string | Gets or sets the plaintext API key value. Shown once, at creation, and never again.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ||||||
replacedKeyOverlapExpiresAt
required |
string (date-time) | Gets or sets when the key this one replaced stops authenticating, or `null` when this key
was not created by a rotation, or was created by one that cut over immediately.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This model has no documented fields.