Sign in
Admin Integrations

List tenant-specific roles

Returns paginated roles for a specific tenant entity. Supports standard Spring pagination parameters.

get/admin/integrations/data/tenant-roles

Query parameters

entityIdstring uuid required

Specifies the entity ID of the tenant.

pageinteger

Specifies the zero-based page number.

sizeinteger

Specifies the number of items per page.

sortstring

Specifies the sort field and direction.

Response

OK

pageinteger
sizeinteger
totalElementsinteger
totalPagesinteger
hasNextboolean

Example response

{
  "data": [
    {
      "roleSetId": "c3d4e5f6-a7b8-9012-cdef-234567890123",
      "roleName": "Billing Admin",
      "description": "Full billing administrative access for this tenant",
      "appType": "BILLING",
      "entityId": "ent-98765432-dcba-hgfe-lkji-210987654321",
      "organizationId": "org-12345678-abcd-efgh-ijkl-123456789012",
      "status": "ACTIVE",
      "roleType": "SYSTEM",
      "sourceType": "BUILT_IN",
      "permissionGroupIds": [
        "pg-55555555-aaaa-bbbb-cccc-555555555555",
        "pg-66666666-aaaa-bbbb-cccc-666666666666"
      ],
      "globalRoleIds": [],
      "createdOn": "2023-01-01T00:00:00.000Z",
      "updatedOn": "2023-01-01T00:00:00.000Z",
      "createdByUsername": "system"
    }
  ],
  "size": 20,
  "totalElements": 12,
  "totalPages": 1
}

Changes

No recorded changes to this endpoint across all 4 revisions of this API.