Documentation Archive

Developer

CloudKit Web Services Reference

On This Page

Discovering All User Identities (GET users/discover)

Fetches all user identities in the current user’s address book.

Path

GET [path]/database/[version]/[container]/[environment]/public/users/discover

Parameters

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.

Response

Dictionary containing the results of the operation with the following keys:

Key

Description

users

Array of user identity dictionaries, described in User Identity Dictionary.