admin-user-roles

Get User Role

Get full details of a user role (groups, permissions, user count).

get/api/v1/admin/user-roles/{role_id}

Path parameters

role_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

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.2

    • added the optional property to the response with the status

      response-optional-property-added

    • added the optional property // to the response with the status

      response-optional-property-added