iOS · Schema

Sign in with Apple ID Token Claims

Decoded claims of the JWT id_token returned from Apple's /auth/token endpoint.

iOSAppleMobileApp StorePush NotificationsIn-App PurchasesSubscriptionsAuthenticationWalletDeveloper Platform

Properties

Name Type Description
iss object
sub string Apple-issued, stable user identifier.
aud string Client ID (Services ID) of the requesting app.
iat integer
exp integer
nonce string
nonce_supported boolean
email string
email_verified object
is_private_email object
real_user_status integer 0=Unsupported, 1=Unknown, 2=LikelyReal.
transfer_sub string
View JSON Schema on GitHub

JSON Schema

sign-in-with-apple-id-token-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/ios/main/json-schema/sign-in-with-apple-id-token-schema.json",
  "title": "Sign in with Apple ID Token Claims",
  "description": "Decoded claims of the JWT id_token returned from Apple's /auth/token endpoint.",
  "type": "object",
  "required": ["iss", "sub", "aud", "iat", "exp"],
  "properties": {
    "iss": { "const": "https://appleid.apple.com" },
    "sub": { "type": "string", "description": "Apple-issued, stable user identifier." },
    "aud": { "type": "string", "description": "Client ID (Services ID) of the requesting app." },
    "iat": { "type": "integer" },
    "exp": { "type": "integer" },
    "nonce": { "type": "string" },
    "nonce_supported": { "type": "boolean" },
    "email": { "type": "string", "format": "email" },
    "email_verified": {
      "oneOf": [{ "type": "boolean" }, { "type": "string" }]
    },
    "is_private_email": {
      "oneOf": [{ "type": "boolean" }, { "type": "string" }]
    },
    "real_user_status": {
      "type": "integer",
      "enum": [0, 1, 2],
      "description": "0=Unsupported, 1=Unknown, 2=LikelyReal."
    },
    "transfer_sub": { "type": "string" }
  }
}