Sign in

v1

latestOpenAPI 3.1.02026-08-04118425322.0 KB
systemCredentials

Update Credentials

Update system-level credentials.

This endpoint allows updating the name and roles of existing system-level credentials.

The access of the system-level credentials is scoped to its roles. If no roles are provided, the system-level credentials will have full access to all resources. If the credentials was previously assigned roles and no roles are provided in the update request, the credentials will gain full access to all resources.

put/api/v1/auth-management/clients/{client_id}

Path parameters

client_idstring required

The client ID of the system-level credentials

Headers

Authorizationstring required

Bearer authentication

Request body

namestring nullable

Display name for the system-level credentials

roles_contextstring nullable

Context for the roles to update. This can either be 'system' for system-level roles or 'dataset:{dataset_id}' for dataset-level roles.

Response

The updated system-level credentials details

client_idstring required

OAuth client ID

client_secretstring required

OAuth client secret (only returned on creation)

namestring required

Display name for the OAuth client