v1

latestOpenAPI 3.0.32026-07-17214860.6 KB
Users

Get the Caller (Current User)

Fetch the authenticated caller's user information. This replaces the deprecated users/current endpoint. Requires public database with a web-auth token (user-context auth); server-to-server credentials and the private database will be rejected with BAD_REQUEST: endpoint not applicable in the database type.

get/database/{version}/{container}/{environment}/{database}/users/caller

Path parameters

versionstring required

Protocol version

containerstring required

Container ID (begins with "iCloud.")

environment'development' | 'production' required

Container environment

database'public' | 'private' | 'shared' required

Database scope

Response

User information retrieved successfully

userRecordNamestring
firstNamestring
lastNamestring
emailAddressstring