List accounts

get

https://{tenant}/admin/api/v1/identityStores/{identityStoreName}/accounts

You can list the existing accounts by calling this endpoint. Filtering can be done by the parameters listed below and by custom searchable attributes. The password type authenticator will be excluded from the response.

REQUIRED API PERMISSION
read:account

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

identityStoreName

string

required

Query Params

attribute_[path]

string

Custom filter applicable only for searchable attribute in the following format: attribute_[path], e.g. attribute_name.givenName

string

Account ID

loginIdentifier

string

Login identifier (username, email or phone). Start with @ to search by email domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.

emailNativeClaim

string

Attribute mapped to the Email native claim. Start with @ to search by domain. When searching by domain, only email addresses belonging to that domain or its subdomains are returned.

userNameNativeClaim

string

User name in account info

enabled

boolean

Account is enabled or not

updatedAtStartDate

date-time

Start date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

updatedAtEndDate

date-time

End date used for filtering based on updatedAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

createdAtStartDate

date-time

Start date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

createdAtEndDate

date-time

End date used for filtering based on createdAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

disabledAtStartDate

date-time

Start date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

disabledAtEndDate

date-time

End date used for filtering based on disabledAt field. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

lastLoginAtStartDate

date-time

Start date used for filtering based on lastLoggedIn field. Must not be provided if neverLoggedIn is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

lastLoginAtEndDate

date-time

End date used for filtering based on lastLoggedIn field. Must not be provided if neverLoggedIn is true. Accepted formats are an ISO 8061 timestamp or an ISO 8061 duration with a +/- prefix.

neverLoggedIn

boolean

Flag to filter for accounts that have never logged in.

organization

string

Organization ID

organizationScope

string

Filter accounts that are under the provided unique identifier organization ID

groups

array of strings

Group IDs used for filtering

groups

groupsFilter

string

enum

Type of inclusion used for groups filter. By setting to exclude makes it an AND relationship within the values of the groups parameter.

Allowed:

roles

array of strings

Organization-role pairs used for filtering, should be provided in the following form: [organizationId]:[roleId]

roles

rolesFilter

string

enum

Type of inclusion used for roles filter. By setting to exclude makes it an AND relationship within the values of the roles parameter.

Allowed:

page

int64

Defaults to 0

Zero-based page index (0..N)

size

int64

Defaults to 20

The size of the page to be returned

sort

array of strings

Sorting criteria in the format: property,(asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

sort

Headers

string

enum

Defaults to application/problem+json

Generated from available response content types

Allowed:

Responses

200OK

400Bad Request

401Unauthorized

403Forbidden

404Not Found