Read All Direct-mapped Users (search)
POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers/.search
The POST {{scimPath}}/environments/{{envID}}/v2/DirectMappedUsers/.search operation returns information about every user in the specified environment that matches the SCIM filter defined in the body, up to the optionally-defined number of users requested in the body. To filter the results when retrieving users, this request is preferred over Read All Direct-mapped Users with query paramters. The response is limited to a maximum of 200 results.
See Direct-mapped search data model for full property descriptions.
| Property | Type | Required? |
|---|---|---|
filter | String | Optional |
count | Integer | Optional |
While all body properties are optional, a body is required, even if empty, as in {}.
Request Body
{"filter"=>"username sw \"cicerone\"", "count"=>100}
RESPONSES
status: OK
{"schemas":["urn:ietf:params:scim:api:messages:2.0:ListResponse"],"totalResults":1,"itemsPerPage":1,"Resources":[{"schemas":["urn:pingidentity:schemas:2.0:DirectMappedUser"],"id":"0c507e67-4533-4870-b59b-6d0591ab87e0","meta":{"created":"2021-05-12T18:32:15.591Z","lastModified":"2021-05-12T18:32:15.591Z","resourceType":"User","location":"https://scim-api.pingone.com/environments/abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6/v2/DirectMappedUsers/0c507e67-4533-4870-b59b-6d0591ab87e0"},"environment":{"id":"abfba8f6-49eb-49f5-a5d9-80ad5c98f9f6"},"account":{"canAuthenticate":true,"status":"OK"},"address":{"streetAddress":"50 Springview Lane","locality":"Beaconsfield","countryCode":"CA"},"email":"cicerone_genevieve@example.com","enabled":true,"identityProvider":{"type":"PING_ONE"},"lifecycle":{"status":"ACCOUNT_OK"},"mfaEnabled":false,"name":{"formatted":"Cicerone Geneviève","given":"Cicerone","family":"Geneviève"},"population":{"id":"0353b962-cf0b-4149-8d1b-084e33814924"},"username":"cicerone_geneviève","verifyStatus":"NOT_INITIATED"}]}