Roles

Delete a custom role

Delete an agency-scoped custom role. Users currently assigned to it are atomically reassigned to the system Viewer role; the response returns how many were moved. System roles cannot be deleted.

delete/api/v3/roles/{role_id}

Request

Path parameters

role_idinteger required

Response

Role deleted; affected users reassigned to Viewer.

reassigned_users_countinteger required

Number of users that were reassigned to the Viewer system role as part of the delete.

Changes

No recorded changes to this operation across all 1 revision of this API.