admin-user-roles

Update User Role

Changed on

Update a user role and optionally its groups/permissions.

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

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/{role_id}
  • Auth
    none declared

Path parameters

role_idinteger required

Headers

authorizationstring nullable
X-API-Keystring nullable

Request body

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

Replace group assignments if provided

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

  • db5ab8f1fcefRevision 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