Account Management - Link Apple

  • Reference
Service:
Client
API Version:
240412

Links the Apple account associated with the token to the user's PlayFab account.

POST https://titleId.playfabapi.com/Client/LinkApple

Request Header

Name Required Type Description
X-Authorization True

string

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

Request Body

Name Required Type Description
IdentityToken True

string

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.).
ForceLink

boolean

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

Responses

Name Type Description
200 OK

EmptyResult

400 Bad Request

ApiErrorWrapper

This is the outer wrapper for all responses with errors

Security

X-Authorization

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

Type: apiKey
In: header

Definitions

Name Description
ApiErrorWrapper

The basic wrapper around every failed API response
EmptyResult
LinkAppleRequest

ApiErrorWrapper

The basic wrapper around every failed API response

Name Type Description
code

integer

Numerical HTTP code
error

string

Playfab error code
errorCode

integer

Numerical PlayFab error code
errorDetails

object

Detailed description of individual issues with the request object
errorMessage

string

Description for the PlayFab errorCode
status

string

String HTTP code

EmptyResult

LinkAppleRequest

Name Type Description
CustomTags

object

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

boolean

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

string

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.

Error Codes

Name Code
AppleNotEnabledForTitle 1501
InvalidIdentityProviderId 1263
LinkedIdentifierAlreadyClaimed 1184
TokenSigningKeyNotFound 1568