Qodex.ai

Gets a list of entitlements.

GET {{baseUrl}}/entitlements

This API returns a list of entitlements.

This API can be used in one of the two following ways: either getting entitlements for a specific account-id, or getting via use of filters (those two options are exclusive).

Any authenticated token can call this API.

Request Params

KeyDatatypeRequiredDescription
account-idstringThe account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the filters, segmented-for-identity, for-segment-ids, or include-unsegmented param(s).
segmented-for-identitystringIf present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. By convention, the value me can stand in for the current user's Identity ID.
Cannot be specified with the account-id or for-segment-ids param(s). It is also illegal to specify a value that refers to a different user's Identity.
for-segment-idsstringIf present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs.
Cannot be specified with the account-id or segmented-for-identity param(s).
include-unsegmentedbooleanWhether or not the response list should contain unsegmented Entitlements. If for-segment-ids and segmented-for-identity are both absent or empty, specifying include-unsegmented=false results in an error.
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results.
See V3 API Standard Collection Parameters for more information.
limitnumberMax number of results to return.
See V3 API Standard Collection Parameters for more information.
countbooleanIf true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored.

Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.

See V3 API Standard Collection Parameters for more information. | | sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters

Sorting is supported for the following fields: id, name, created, modified, type, attribute, value, source.id, requestable | | filters | string | | Filter results using the standard syntax described in V3 API Standard Collection Parameters

Filtering is supported for the following fields and operators:

id: eq, in

name: eq, in, sw

type: eq, in

attribute: eq, in

value: eq, in, sw

source.id: eq, in

requestable: eq

created: gt, lt, ge, le

modified: gt, lt, ge, le

owner.id: eq, in |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"id":"2c91808874ff91550175097daaec161c","name":"LauncherTest2","created":"2020-10-08T18:33:52.029Z","modified":"2020-10-08T18:33:52.029Z","attribute":"memberOf","value":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","sourceSchemaObjectType":"group","privileged":true,"cloudGoverned":true,"description":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","requestable":true,"attributes":{"fieldName":"fieldValue"},"source":{"id":"2c9180827ca885d7017ca8ce28a000eb","type":"SOURCE","name":"ODS-AD-Source"},"owner":{"id":"2a2fdacca5e345f18bf7970cfbb8fec2","name":"identity 1","type":"IDENTITY"},"directPermissions":[{"rights":["SELECT","SELECT"],"target":"SYS.GV_$TRANSACTION"},{"rights":["SELECT","SELECT"],"target":"SYS.GV_$TRANSACTION"}],"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"],"manuallyUpdatedFields":{"DISPLAY_NAME":true,"DESCRIPTION":true},"accessModelMetadata":{"attributes":[{"key":"iscPrivacy","name":"Privacy","multiselect":false,"status":"active","type":"governance","objectTypes":["all"],"description":"Specifies the level of privacy associated with an access item.","values":[{"value":"public","name":"Public","status":"active"}]}]}},{"id":"2c91808874ff91550175097daaec161c","name":"LauncherTest2","created":"2020-10-08T18:33:52.029Z","modified":"2020-10-08T18:33:52.029Z","attribute":"memberOf","value":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","sourceSchemaObjectType":"group","privileged":true,"cloudGoverned":true,"description":"CN=LauncherTest2,OU=LauncherTestOrg,OU=slpt-automation,DC=TestAutomationAD,DC=local","requestable":true,"attributes":{"fieldName":"fieldValue"},"source":{"id":"2c9180827ca885d7017ca8ce28a000eb","type":"SOURCE","name":"ODS-AD-Source"},"owner":{"id":"2a2fdacca5e345f18bf7970cfbb8fec2","name":"identity 1","type":"IDENTITY"},"directPermissions":[{"rights":["SELECT","SELECT"],"target":"SYS.GV_$TRANSACTION"},{"rights":["SELECT","SELECT"],"target":"SYS.GV_$TRANSACTION"}],"segments":["f7b1b8a3-5fed-4fd4-ad29-82014e137e19","29cb6c06-1da8-43ea-8be4-b3125f248f2a"],"manuallyUpdatedFields":{"DISPLAY_NAME":true,"DESCRIPTION":true},"accessModelMetadata":{"attributes":[{"key":"iscPrivacy","name":"Privacy","multiselect":false,"status":"active","type":"governance","objectTypes":["all"],"description":"Specifies the level of privacy associated with an access item.","values":[{"value":"public","name":"Public","status":"active"}]}]}}]