ApiKeyDetailDto
A model the API reference uses in a request or a response. The operation pages link every field typed as this model here.
Read-only projection of an API key for the per-key detail surface.
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.
| ||||||
active
required |
boolean | Gets or sets a value indicating whether the API key is marked active.
An inactive key is rejected at authentication regardless of its expiry.
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.
| ||||||
keyPrefix
required |
string | Gets or sets the leading characters of the key value, safe to display. `null` for a key
minted before hashed storage that the rewrap 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 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. Resolved at the projection boundary, so a key
that predates the field arrives as `Active` rather than unset.
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.
| ||||||
revokedAt
required |
string (date-time) | Gets or sets when the key was revoked, or `null` if it has not been.
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.
| ||||||
revokedBy
required |
string (uuid) | Gets or sets who revoked the key, or `null` if it has not been revoked.
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.
| ||||||
revocationReason
required |
string | Gets or sets the reason recorded at revocation, when one was given.
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.
| ||||||
suspendedAt
required |
string (date-time) | Gets or sets when the key was suspended, or `null` when it is not suspended.
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.
| ||||||
suspendedBy
required |
string (uuid) | Gets or sets who suspended the key, or `null` when the platform did or the key is not
suspended. Read alongside `suspensionReason`, which says which of the two a null
means.
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.
| ||||||
suspensionReason
required |
string | Gets or sets why the key was suspended, when it is.
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.
| ||||||
anomalySourceAction
required |
ApiKeyAnomalyAction ApiKeyAnomalyAction | Gets or sets this key's own action for an anomalous source, or `null` when it follows
the merchant default.
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.
| ||||||
merchantId
required |
string (uuid) | Gets or sets the merchant this 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.
| ||||||
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. Retained after the key is revoked, because the lineage is
history.
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.
| ||||||
isRevoked
required |
boolean | Gets a value indicating whether the key has been revoked.
read 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.
| ||||||
isSuspended
required |
boolean | Gets a value indicating whether the key is suspended, which is reversible, as opposed to
revoked, which is not.
read 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.
| ||||||
isInRotationOverlap
required |
boolean | Gets a value indicating whether this key is currently inside a rotation overlap: rotated,
still in service, and not yet past the window.
read 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.
| ||||||
hasRotationLineage
required |
boolean | Gets a value indicating whether this key was minted as a replacement for an earlier one, or
has itself been replaced. Either makes it part of a rotation chain worth showing.
read 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.
| ||||||
creationTime
required |
string (date-time) | Gets or sets the UTC time 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.
| ||||||
lastModificationTime
required |
string (date-time) | Gets or sets the UTC time the key record was last modified, when it has been modified.
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.
| ||||||
lastUsedAt
required |
string (date-time) | Gets or sets the UTC time the key was last used to authenticate a request, or `null`
when it has no recorded use. Covers every kind of API activity, not just transactions.
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.
| ||||||
recentSourceIps
required |
array of ApiKeySourceIpDto array of ApiKeySourceIpDto | Gets or sets the addresses the key has recently authenticated from, most recently seen
first. Empty when none have been recorded.
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.
| ||||||
Fields of each ApiKeySourceIpDto: This body has no documented fields. | ||||||||
allowedCidrs
required |
array of string array of | Gets or sets the source addresses this key is permitted to authenticate from, as CIDR ranges
or bare addresses. Empty means the key 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.
| ||||||
isAddressRestricted
required |
boolean | Gets a value indicating whether the key is bound to a set of source addresses.
read 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.
| ||||||
scopes
required |
array of string array of | Gets or sets the capability scopes this key is restricted to. Empty means the key is
unrestricted and may reach everything its owning account 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.
| ||||||
isScopeRestricted
required |
boolean | Gets a value indicating whether the key is restricted to a set of capability scopes.
read 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.
| ||||||
isExpired
required |
boolean | Gets a value indicating whether the key's expiry has already passed.
A key with no expiry never reports as expired.
read 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.
| ||||||
hasRotationOverlapLapsed
required |
boolean | Gets a value indicating whether the key's rotation overlap has closed, so it is refused at
authentication even while its stored status still reads active.
read 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.
| ||||||
isUsable
required |
boolean | Gets a value indicating whether the key would currently be accepted at authentication:
in service, marked active, not past its expiry, and not past a rotation overlap.
read 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.
| ||||||
This model has no documented fields.