Identities

Retrieves a paginated list of identities in your workspace. Use pagination parameters to navigate through large identity lists efficiently.

get/v2/identities

Request

  • Base URL
    https://my.orq.ai
  • URL
    https://my.orq.ai/v2/identities
  • Auth
    HTTP bearer

Query parameters

limitinteger
starting_afterstring

Cursor for forward pagination. Set to the _id of the last item from the previous page.

ending_beforestring

Cursor for backward pagination. Set to the _id of the first item from the previous page.

searchstring

Case-insensitive search text matched against identity profile fields.

filter_by.tagsstring[]

Return only identities that have all of these tags.

include_metricsboolean

Include aggregate usage metrics on each returned identity.

sort_by'IDENTITY_SORT_FIELD_DISPLAY_NAME' | 'IDENTITY_SORT_FIELD_UPDATED'

Field used to order the list.

include_budgetboolean

When true, embed each identity's identity-scoped budget (config and limits only, no live usage) on the returned records. Adds one budget lookup for the page; omit to skip it.

Response

OK

objectstring required

Object discriminator for list responses; always list.

has_moreboolean required

Whether more identities are available in the selected pagination direction.

Changes

    • breaking

      removed the enum value IDENTITY_SORT_FIELD_UNSPECIFIED from the query request parameter sort_by

    • info

      added the non-success response with the status

    • info

      removed the BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value from the ///////// response property for the response status

    • info

      removed the BUDGET_PERIOD_UNSPECIFIED enum value from the //////// response property for the response status

    • warning

      added the new BUDGET_ALERT_DIMENSION_UNSPECIFIED enum value to the ///////// response property for the response status

    • warning

      added the new BUDGET_PERIOD_UNSPECIFIED enum value to the //////// response property for the response status

    • info

      added the new enum value IDENTITY_SORT_FIELD_UNSPECIFIED to the query request parameter sort_by

    • info

      removed the non-success response with the status