Sign in
admin-user-roles

Create User Role

Create a new user role with optional group and permission assignments.

post/api/v1/admin/user-roles

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

namestring required
descriptionstring nullable
all_access_levelstring
is_all_accessboolean nullable
can_manage_activitiesboolean
can_manage_tasksboolean
can_create_dashboardsboolean
record_type_group_idsinteger[]

IDs of record type groups to attach

Response

Successful Response

idinteger required
tenant_idinteger required
namestring required
descriptionstring nullable
all_access_levelstring
can_manage_activitiesboolean
can_manage_tasksboolean
can_create_dashboardsboolean
is_activeboolean required
created_atstring date-time nullable
updated_atstring date-time nullable
user_countinteger

Changes

Changed in 1 of the 5 revisions of this API.4

  • db5ab8f1fcef4See the full diff
    • ○

      added the new optional request property can_create_dashboards

      new-optional-request-property

    • ○

      added the new optional request property object_permissions/items/can_reopen_closed

      new-optional-request-property

    • ○

      added the optional property can_create_dashboards to the response with the 201 status

      response-optional-property-added

    • ○

      added the optional property object_permissions/items/can_reopen_closed to the response with the 201 status

      response-optional-property-added