v13

latestOpenAPI 3.1.0Proprietaryraw.githubusercontent.com2026-03-243075159.3 KB

API Tokens

Create a new API token

Create a new API token to access the UMAaaS APIs.

post/tokens

Request body

namestring required

Name of the token to help identify it

permissionsPermission[] required

A list of permissions to grant to the token

Example request

{
  "name": "Sandbox read-only"
}

Response

API token created successfully

idstring required

System-generated unique identifier

namestring required

Name of the token

permissionsPermission[] required

A list of permissions granted to the token

clientIdstring required

An opaque identifier that should be used as a client_id (or username) in the HTTP Basic Authentication scheme when issuing http requests to UMAaaS.

clientSecretstring

The secret that should be used to authenticate against UMAaaS API. This secret is not stored and will never be available again after creation. Platform must keep this secret secure as it grants access to the account.

createdAtstring date-time required

Creation timestamp

updatedAtstring date-time required

Last update timestamp

Example response

{
  "id": "Token:019542f5-b3e7-1d02-0000-000000000001",
  "name": "Sandbox read-only token",
  "clientId": "01947d2284054f890000e63bca4810df",
  "clientSecret": "ed0ad25881e234cc28fb2dec0a4fe64e4172",
  "createdAt": "2023-07-21T17:32:28Z",
  "updatedAt": "2023-07-21T17:32:28Z"
}