admin-user-roles

Create User Role

Changed on

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

post/api/v1/admin/user-roles

Request

  • Base URL
    https://api.ninjavan.co (the document declares no server; this is the origin it was published from)
  • URL
    https://api.ninjavan.co/api/v1/admin/user-roles
  • Auth
    none declared

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

    • info

      added the new optional request property

    • info

      added the new optional request property //

    • info

      added the optional property to the response with the status

    • info

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