API ReferenceSystem Credentials

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.

Path parameters

client_idstringRequired

The client ID of the system-level credentials

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
namestringOptional

Display name for the system-level credentials

roleslist of objectsOptional

List of roles to assign to the system-level credentials. This is only available to organizations that are RBAC-enabled. Please contact support if you would like to enable RBAC for your organization.

roles_contextstringOptional

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
OAuth client ID
client_secretstring

OAuth client secret (only returned on creation)

namestring
Display name for the OAuth client
roleslist of objects
List of roles assigned to the client

Errors