GetUsers

Retrieves resources matching the specified criteria.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params

The query containing filter parameters.

roleIds
array of strings | null

Gets or sets the role ids.

roleIds
includeRoleIds
array of strings | null

Gets or sets the include role ids.

includeRoleIds
excludeRoleIds
array of strings | null

Gets or sets the exclude role ids.

excludeRoleIds
roleNames
array of strings | null

Gets or sets the role names.

roleNames
includeRoleNames
array of strings | null

Gets or sets the include role names.

includeRoleNames
excludeRoleNames
array of strings | null

Gets or sets the exclude role names.

excludeRoleNames
roleEnvironments
array of objects | null

Gets or sets the role environments.

roleEnvironments
Allowed:
roleApplicationComponentIds
array | null

Gets or sets the role application component ids.

roleApplicationComponentIds
roleTypes
array of objects | null

Gets or sets the role types.

roleTypes
excludeUserIds
array | null

Gets or sets the exclude user ids.

excludeUserIds
relatedUserIds
array | null

Gets or sets the related user ids.

relatedUserIds
includeRelatedUserIds
array | null

Gets or sets the include related user ids.

includeRelatedUserIds
sourceRelatedUserCodes
array of strings | null

Gets or sets the source related user codes.

sourceRelatedUserCodes
usernames
array of strings | null

Gets or sets the usernames.

usernames
emails
array of strings | null

Gets or sets the emails.

emails
includesEmails
array of strings | null

Gets or sets the includes emails.

includesEmails
mobilePhones
array of strings | null

Gets or sets the mobile phones.

mobilePhones
loginIds
array of strings | null

Gets or sets the login ids.

loginIds
loginProviders
array of strings | null

Gets or sets the login providers.

loginProviders
loginProviderKeys
array of strings | null

Gets or sets the login provider keys.

loginProviderKeys
string | null

Gets or sets the activation number.

securityStamps
array of strings | null

Gets or sets the security stamps.

securityStamps
citizenIds
array of strings | null

Gets or sets the citizen ids.

citizenIds
firstnames
array of strings | null

Gets or sets the firstnames.

firstnames
includesFirstnames
array of strings | null

Gets or sets the includes firstnames.

includesFirstnames
lastnames
array of strings | null

Gets or sets the lastnames.

lastnames
includesLastnames
array of strings | null

Gets or sets the includes lastnames.

includesLastnames
userTokens
array of strings | null

Gets or sets the user tokens.

userTokens
includesFullnames
array of strings | null

Gets or sets the includes fullnames.

includesFullnames
dateOfBirths
array of date-times | null

Gets or sets the date and time of the of births.

dateOfBirths
properties
array of objects | null

Gets or sets the properties.

properties
tags
array of objects | null

Gets or sets the tags.

tags
date-time | null

Gets or sets the date and time of the from.

date-time | null

Gets or sets the date and time of the to.

date-time | null

Gets or sets the date and time of the from up.

date-time | null

Gets or sets the date and time of the to up.

string | null

Gets or sets the tag prefix.

tagTypes
array of objects | null

Gets or sets the tag types.

tagTypes
Allowed:
excludeStatus
array of objects | null

Gets or sets the exclude status.

excludeStatus
string | null

Gets or sets the environment.

string | null

Gets or sets the application i p.

string | null

Gets or sets the user token.

string | null

Gets or sets the unique identifier of the session id.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the unique identifier of the user id.

string | null

Gets or sets the user i p.

string | null

Gets or sets the envelope.

string | null

Gets or sets the unique identifier of the thread id.

includes
array of strings | null

Gets or sets the includes.

includes
string | null

Gets or sets the search key.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page index.

string
^-?(?:0|[1-9]\d*)$

Gets or sets the page size.

string | null

Gets or sets the sorting.

status
array of objects | null

Gets or sets the status.

status
Headers
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
string
enum
Defaults to application/json-patch+json

Generated from available request content types

Allowed:
Response

Language
Credentials
Bearer
JWT
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
text/plain
application/json
text/json