Sign in

v1

latestOpenAPI 3.0.32026-07-24214879985.1 KB
Roles

This endpoint creates a new role under the current user's account. Admins can create roles and define which permissions are part of which roles. Non-admin users with 'Role' permission can only create a role with the permission that they already have themselves.

post/roles

Request body

namestring required

The name of the role.

notesstring

The notes of the role.

defaultboolean required

True if the role is one of the default roles for the account, false otherwise.

Response

Role created.

idstring uuid required

The ID of the role.

assignableboolean

True if the user doing the request can assign this role to other users, false otherwise.

userCountinteger

Count of users that are associated with this role in the account

namestring required

The name of the role.

notesstring

The notes of the role.

defaultboolean required

True if the role is one of the default roles for the account, false otherwise.