Skip to main content
The roles functions are currently in BETA. The API may change without notice. A one-time warning is emitted on first use.

List Roles

Create a Role

Custom roles must have a unique name within the account and at least one permission. Predefined (system-managed) roles cannot be created through this endpoint.

Get a Role

Update a Role

At least one of name, description, or permissions must be provided. When permissions is provided, it fully replaces the existing permission set. Predefined roles cannot be updated.

Delete a Role

Predefined (system-managed) roles cannot be deleted.

Role Fields