Perform Search
POST {{baseUrl}}/search
Performs a search with the provided query and returns a matching result collection. By default, you can page a maximum of 10,000 search result records. To page past 10,000 records, you can use searchAfter paging. Refer to Paginating Search Queries for more information about how to implement searchAfter paging.
Request Params
| Key | Datatype | Required | Description |
|---|---|---|---|
offset | number | Offset into the full result set. Usually specified with limit to paginate through the results. | |
| See V3 API Standard Collection Parameters for more information. | |||
limit | number | Max number of results to return. | |
| See V3 API Standard Collection Parameters for more information. | |||
count | boolean | If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. |
Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used.
See V3 API Standard Collection Parameters for more information. |
Request Body
{"indices"=>["identities"], "query"=>{"query"=>"\"John Doe\"", "fields"=>["name"]}}
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Content-Type | string | ||
Accept | string |
RESPONSES
status: OK
[{"id":"2c91808c6faadea6016fb4f2bc69077b","name":"IT Role","_type":"role","description":"IT role","created":"2020-01-17T19:20:15.040Z","modified":null,"synced":"2020-02-18T05:30:20.145Z","enabled":true,"requestable":false,"requestCommentsRequired":false,"owner":{"id":"2c9180a46faadee4016fb4e018c20639","name":"Cloud Support","type":"IDENTITY","email":"thomas.edison@acme-solar.com"},"accessProfiles":[{"id":"2c91809c6faade77016fb4f0b63407ae","name":"Admin Access"}],"accessProfileCount":1,"tags":["TAG_1","TAG_2"]}]