Get enterprise roles

get/api/usermanagement/v1/enterprises/{enterpriseId}/roles

Retrieves a paginated list of roles within an enterprise with optional filtering by permissions, resources, and visibility.

Path Parameters

  • enterpriseIdstringRequired

Query Parameters

  • permissionarray[string]
    Min length: >= 1 characters
    Max length: <= 50 characters
  • scopestring
  • resourceTypestring
  • resourceIdarray[string]
  • hiddenstringDefault: FALSE
    Enum: ALL TRUE FALSE
  • pageinteger<int32>Default: 1
    Minimum: >= 1
  • pageSizeinteger<int32>Default: 25
    Minimum: >= 1
    Maximum: <= 500

200 Response

roles array[object] required
id string <uuid>required
organizationId string required
name string required
status string required
Allowed values: ACTIVE INACTIVE
enterprises object required
permissions object required
isDefaultRole boolean required
numUsers integer <int32>required
resources array[object] required
createdDate string <date-time>required
modifiedDate string <date-time>required
defaultRole boolean write-only
page integer <int32>required
totalPages integer <int32>required
totalElements integer <int64>required

403 Response

404 Response