latestOpenAPI 3.0.32026-08-10119559584.8 KB

6d091bc86a33

Roles

Returns roles matching the given search criteria.

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.

get/roles

Query parameters

offsetinteger

The first result to retrieve. If not set (offset = <code>0</code>), results will be retrieved starting from row <code>0</code>.

limitinteger

The maximum number of results to retrieve. If not set (limit = <code>0</code>), the default limit will be used. The maximum allowed limit is 1000.

countLimitinteger

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

namestring

The name of the role to search for.

nameMatchMode'START' | 'END' | 'ANYWHERE' | 'EXACT'

The match mode used to compare <code>name</code>. The search is case-insensitive.

descriptionstring

The description of the role to search for.

globalboolean

Whether global roles should be searched for.

ownerIdstring uuid

The id of the owner of the roles. This can be a user or a group.

roleInheritanceMode'DIRECTLY' | 'VIA_GROUPS' | 'DIRECTLY_AND_VIA_GROUPS'

How to include inherited roles from groups in the search results. Allowable values are DIRECTLY, VIA_GROUPS, DIRECTLY_AND_VIA_GROUPS.

sortField'NAME' | 'LICENSE_TYPE'

The sort field for the result.

sortOrder'ASC' | 'DESC'

The order of sorting.

includeDisabledboolean

Whether disabled roles should be searched for.

systemNamestring

If set, search returns only resource roles having permissions belonging to a specific system. Supported values are 'knowledgegraph' and 'dataquality'. It must be used in combination with <code>type</code> = RESOURCE or <code>global</code> = false.

type'ALL' | 'GLOBAL' | 'RESOURCE'

Indicates which type of roles should be searched for. Usage is mutually exclusive with the deprecated global flag.

Response

default response

totalinteger

The total number of results.

offsetinteger

The offset for the results.

limitinteger

The maximum number of results to be returned.