Skip to main content
GET
Core - List identities by tag

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

limit
integer<int32>
starting_after
string

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

ending_before
string

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

Case-insensitive search text matched against identity profile fields.

filter_by.tags
string[]

Return only identities that have at least one of these tags.

include_metrics
boolean

Include aggregate usage metrics on each returned identity.

sort_by
enum<string>

Field used to order the list.

Available options:
IDENTITY_SORT_FIELD_UNSPECIFIED,
IDENTITY_SORT_FIELD_DISPLAY_NAME,
IDENTITY_SORT_FIELD_UPDATED

Response

200 - application/json

OK

object
string
required

Object discriminator for list responses; always list.

data
object[]
required

Page of identities.

has_more
boolean
required

Whether more identities are available in the selected pagination direction.