v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB
systemCredentials

Create Credentials

Create new system-level credentials. System-level credentials are not tied to a specific user and never expire.

The access of the system-level credentials are scoped to the specified roles. If no roles are provided, the system-level credentials will have full access to all resources.

The client id and client secret of the created credentials can be exchanged for access tokens which can be used to make requests to the API. These credentials should only be used for programmatic access to the API as they are not tied to a specific user.

post/api/v1/auth-management/clients

Headers

Authorizationstring required

Bearer authentication

Request body

namestring required

Display name for the system-level credentials

Response

The details of the created system-level credentials, including the client ID and secret

client_idstring required

OAuth client ID

client_secretstring required

OAuth client secret (only returned on creation)

namestring required

Display name for the OAuth client