Sign in

v1

latestOpenAPI 3.0.32026-07-13218142597.2 KB
Admin Key

Enable Admin Key

Enables admin key access for the calling user within the site. If an admin key already exists for the user, a new one will be issued with an updated expiration time.

Note: The durationInMinutes field within the request body is optional. If the request body is empty or if the durationInMinutes is set to 0 minutes, a new admin key will be issued to the calling user with a default duration of 10 minutes.

Permissions required: User must be an organization or site admin.

post/admin-key

Request body

durationInMinutesinteger

The requested duration of admin key access in minutes, up to a maximum of 60 minutes, after which the issued admin key will automatically expire.

Example request

{
  "durationInMinutes": 60
}

Response

Returned if a new admin key is successfully issued for the calling user.

accountIdstring

User identifier.

expirationTimestring date-time

Timestamp in UTC that represents when the admin key will expire. In format "YYYY-MM-DDTHH:mm:ss.sssZ".