Sign in
latestOpenAPI 3.1.02026-08-194237902.5 MB

563848e0ecc0

Role

List all roles for a tenant

Returns every role belonging to the tenant identified by the required tenant-id header. Use this to populate role-selection UIs or to audit which roles exist before assigning one to a user. Requires the tenant-id header; the request returns 400 if the header is absent or blank. The response is a paginated envelope containing a data array of role objects, a totalCount, and links for navigation.

get/roles

Headers

tenant-idstring

Response

Roles retrieved successfully

totalCountinteger

Total number of roles

Example response

{
  "data": [
    {
      "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "Business Admin",
      "tenantId": "8f14e45f-ceea-467e-9906-ccfb98d21f95",
      "description": "Full access to all operations",
      "createdAt": "2022-03-10T12:15:50-04:00",
      "updatedAt": "2022-03-10T12:15:50-04:00",
      "createdBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11",
      "updatedBy": "b7e685c1-6b2a-4e3a-9c1a-2f8b6d9e4a11"
    }
  ]
}