Skip to main content
POST
Link Apple

Authorizations

X-Authorization
string
header
required

This API requires a client session ticket, available from any Client Login function.

Body

application/json
IdentityToken
string
required

The JSON Web token (JWT) returned by Apple after login. Represented as the identityToken field in the authorization credential payload. Used to validate the request and find the user ID (Apple subject) to link with.

CustomTags
object

The optional custom tags associated with the request (e.g. build number, external trace identifiers, etc.).

If another user is already linked to a specific Apple account, unlink the other user and re-link.

Response

code
integer

The Http status code. If X-ReportErrorAsSuccess header is set to true, this will report the actual http error code.

status
string

The Http status code as a string.

data
object
Last modified on October 1, 2026