Qodex.ai

Identity Profiles List

GET {{baseUrl}}/identity-profiles

This returns a list of Identity Profiles based on the specified query parameters. A token with ORG_ADMIN or API authority is required to call this API to get a list of Identity Profiles.

Request Params

KeyDatatypeRequiredDescription
limitnumberMax number of results to return.
See V3 API Standard Collection Parameters for more information.
offsetnumberOffset into the full result set. Usually specified with limit to paginate through the results.
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. | | 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, ne, ge, gt, in, le, lt, isnull, sw

name: eq, ne, in, le, lt, isnull, sw

priority: eq, ne | | sorters | string | | Sort results using the standard syntax described in V3 API Standard Collection Parameters

Sorting is supported for the following fields: id, name, priority, created, modified, owner.id, owner.name |

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

[{"authoritativeSource":{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"},"name":"aName","id":"id12345","created":"2015-05-28T14:07:17Z","modified":"2015-05-28T14:07:17Z","description":"My custom flat file profile","owner":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"priority":10,"identityRefreshRequired":true,"identityCount":8,"identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}},{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]},"identityExceptionReportReference":{"taskResultId":"2b838de9-db9b-abcf-e646-d4f274ad4238","reportName":"My annual report"},"hasTimeBasedAttr":true},{"authoritativeSource":{"type":"SOURCE","id":"2c9180835d191a86015d28455b4b232a","name":"HR Active Directory"},"name":"aName","id":"id12345","created":"2015-05-28T14:07:17Z","modified":"2015-05-28T14:07:17Z","description":"My custom flat file profile","owner":{"type":"IDENTITY","id":"2c9180835d191a86015d28455b4b232a","name":"William Wilson"},"priority":10,"identityRefreshRequired":true,"identityCount":8,"identityAttributeConfig":{"enabled":true,"attributeTransforms":[{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}},{"identityAttributeName":"email","transformDefinition":{"type":"accountAttribute","attributes":{"attributeName":"e-mail","sourceName":"MySource","sourceId":"2c9180877a826e68017a8c0b03da1a53"}}}]},"identityExceptionReportReference":{"taskResultId":"2b838de9-db9b-abcf-e646-d4f274ad4238","reportName":"My annual report"},"hasTimeBasedAttr":true}]