CloudKit Web Services Reference: Fetching Users by Record Name (users/lookup/id)

Fetching Users by Record Name (users/lookup/id)

You can fetch discoverable users with the specified record names.

POST [path]/database/[version]/[container]/[environment]/public/users/lookup/id

path: The URL to the CloudKit web service, which is https://api.apple-cloudkit.com.
version: The protocol version—currently, 1.
container: A unique identifier for the app’s container. The container ID begins with iCloud..
environment: The version of the app’s container. Pass development to use the environment that is not accessible by apps available on the store. Pass production to use the environment that is accessible by development apps and apps available on the store.

The POST request is a JSON dictionary containing the following key:


Key	Description
`users`	Array of dictionaries where each dictionary specifies a user and contains a single `userRecordName` key.

The response is a dictionary containing the results of the operation with the following key:


Key	Description
`users`	An array of user dictionaries, described in User Dictionary, but not including an `emailAddress` key.

This request is similar to the CKDiscoverUserInfosOperation class in the CloudKit framework.