Sign in
latestSwagger 2.02026-08-191,9198883.9 MB

b296c3a60aa5

ApiKeys

Get a ApiKeyResource by ID

Gets a API key by ID.

get/users/{userId}/apikeys/{id}

Path parameters

userIdstring required

ID of the User that owns the ApiKey

idstring required

ID of the ApiKeyResource to load

Response

The requested Api Key

AccessLevel'FullAccess' | 'ReadOnly' | 'Custom'

The access level this API key grants.

ActorType'User' | 'AiAgent'
Createdstring date-time
Expiresstring date-time
Idstring

Gets or sets a unique identifier for this resource.

IsLastUsedTimestampKnownboolean

Whether the API key's last-used time is being tracked. False for keys that predate last-used tracking, whose usage history is unknown. When true, a null LastUsedTimeStamp means the key has never been used.

LastModifiedBystring

Gets or sets the username of the user who last modified this resource.

LastModifiedOnstring date-time

Gets or sets the date/time that this resource was last modified.

LastUsedTimeStampstring date-time

The date and time (UTC) the API key was last used to authenticate; null if it has never been used.

Linksobject

Gets or sets a dictionary of links to other related resources. These links can be used to navigate the resources on the server.

Purposestring
UserIdstring