---
title: "Returns roles matching the given search criteria."
method: GET
path: "/roles"
tags: ["Roles"]
---

# Returns roles matching the given search criteria.

`GET /roles`

Only parameters that are specified in this request and have not <code>null</code> values are used for filtering.  All other parameters are ignored.  The returned roles satisfy all constraints that are specified in this search criteria.  By default a result containing 1000 roles is returned.

## Query parameters

- `offset` integer
- `limit` integer
- `countLimit` integer
- `name` string
- `nameMatchMode` 'START' | 'END' | 'ANYWHERE' | 'EXACT'
- `description` string
- `global` boolean
- `ownerId` string, uuid
- `roleInheritanceMode` 'DIRECTLY' | 'VIA_GROUPS' | 'DIRECTLY_AND_VIA_GROUPS'
- `sortField` 'NAME' | 'LICENSE_TYPE'
- `sortOrder` 'ASC' | 'DESC'
- `includeDisabled` boolean
- `systemName` string
- `type` 'ALL' | 'GLOBAL' | 'RESOURCE'

## Response `default`

default response

- PagedResponseRole — Response containing the paged information.
  - `total` integer — The total number of results.
  - `offset` integer — The offset for the results.
  - `limit` integer — The maximum number of results to be returned.
  - `results` RoleImpl[] — The list of results.
    - `id` string, uuid, required — The id of the represented object (entity).
    - `createdBy` string, uuid — The id of the user that created this resource.
    - `createdOn` integer — The timestamp (in UTC time standard) of the creation of this resource.
    - `lastModifiedBy` string, uuid — The id of the user who modified this resource the last time.
    - `lastModifiedOn` integer — The timestamp (in UTC time standard) of the last modification of this resource.
    - `system` boolean — Whether this is a system resource or not.
    - `resourceType` 'View' | 'Asset' | 'Community' | 'Domain' | 'AssetType' | 'DomainType' | 'Status' | 'User' | 'ClassificationMatch' | 'UserGroup' | 'Attribute' | 'StringAttribute' | 'ScriptAttribute' | 'BooleanAttribute' | 'DateAttribute' | 'NumericAttribute' | 'SingleValueListAttribute' | 'MultiValueListAttribute' | 'Comment' | 'Attachment' | 'Responsibility' | 'Workflow' | 'Job' | 'Relation' | 'RelationType' | 'ComplexRelation' | 'ComplexRelationType' | 'ArticulationRule' | 'Assignment' | 'Scope' | 'RelationTrace' | 'ValidationRule' | 'DataQualityRule' | 'DataQualityMetric' | 'Address' | 'InstantMessagingAccount' | 'Email' | 'PhoneNumber' | 'Website' | 'Activity' | 'FormProperty' | 'WorkflowTask' | 'ActivityChange' | 'WorkflowInstance' | 'Role' | 'AttributeType' | 'BooleanAttributeType' | 'DateAttributeType' | 'DateTimeAttributeType' | 'MultiValueListAttributeType' | 'NumericAttributeType' | 'ScriptAttributeType' | 'SingleValueListAttributeType' | 'StringAttributeType' | 'ViewSharingRule' | 'ViewAssignmentRule' | 'JdbcDriverFile' | 'JdbcDriver' | 'JdbcIngestionProperties' | 'CsvIngestionProperties' | 'ExcelIngestionProperties' | 'ConnectionStringParameter' | 'AssignedCharacteristicType' | 'Notification' | 'Tag' | 'ComplexRelationLegType' | 'ComplexRelationAttributeType' | 'ComplexRelationLeg' | 'BaseDataType' | 'AdvancedDataType' | 'DiagramPicture' | 'DiagramPictureSharingRule' | 'DiagramPictureAssignmentRule' | 'Rating' | 'Classification' | 'PhysicalDataConnector' | 'Context', required — The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.
    - `name` string — The name of the resource.
    - `description` string — The description of the resource.
    - `global` boolean — Whether the role is global.
    - `disabled` boolean — Whether the role is disabled.
    - `permissionList` string[] — The list of permissions this role will provide to the user. To get an up-to-date list of the permissions in the system, please refer to the enums in AddRoleRequest and ChangeRoleRequest
    - `permissions` string[] — The list of permissions this role will provide to the user. This will not return permissions added since 2023.02 and should no longer be used. Please use getPermissionList instead.

---

[API](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api.md) · [All operations](https://skmtc.net/collibra/apis/collibra-data-governance-center-core-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/collibra/collibra-data-governance-center-core-api/revisions/6d091bc86a33/schema)