Search for user profiles

post https://{hostname}/entity.find

Searches an entity type for users meeting the specified criteria. For example, you might search for all the users who have not logged on since a specified date, or for all the users whose accounts were created after a that date.

Recipes

Open Recipe

Form Data

type_name

string

Name of the entity type (user profile database) where the user profile is stored.

filter

string

Expression used to filter the result. By default, all records are returned.

application_id

string

Unique identifier of your Identity Cloud application. You can find your application ID on Console’s Manage Application page.

sort_on

array of strings

Specifies the sort order. Note that the sort_on parameter sorts results by using ASCII order. By default, results are sorted in ascending order. To sort in descending order, place a minus sign (-) directly in front of the appropriate attribute. For example: -displayName. If the sort order isn't important we recommend you include the sort_on parameter and set the value to an empty array: sort_on='[]'. Doing this typically speeds up an unsorted query.

sort_on

attributes

array of strings

Attributes for the user profile.

attributes

Response

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://hostname/entity.find \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/x-www-form-urlencoded'


xxxxxxxxxx
30
}
1
{
2
  "result_count": 6,
3
  "stat": "ok",
4
  "results": [
5
    {
6
      "displayName": "ian",
7
      "email": "ian@example.com"
8
    },
9
    {
10
      "displayName": "Rex",
11
      "email": "rex@example.com"
12
    },
13
    {
14
      "displayName": "sam",
15
      "email": "smann@example.com"
16
    },
17
    {
18
      "displayName": "alex",
19
      "email": "alex@example.com"
20
    },
21
    {
22
      "displayName": "john.j",
23
      "email": "jj@example.com"
24
    },
25
    {

200Successful response