Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • AppleIdTokenType

Index

Properties

aud

aud: string

Your client_id in your Apple Developer account.

example

"com.unity.testApp"

auth_time

auth_time: number

c_hash

c_hash: string

The hash of the authorization code. It’s only used when you need to validate the authorization code.

example

"agyAh42GdE-O72Y4HUHypg"

Optional email

email: undefined | string

[First login only] The user's email address.

example

xxx@privaterelay.appleid.com

Optional email_verified

email_verified: undefined | boolean

[First login only] A Boolean value that indicates whether the service has verified the email. The value of this claim is always true because the servers only return verified email addresses.

example

true

exp

exp: string

The expiry time for the token. This value is typically set to five minutes.

example

1568671600

iat

iat: string

The time the token was issued.

example

1568671000

Optional is_private_email

is_private_email: undefined | boolean

Determine whether email is Apple private (trough relay) one or not. In my testing, is_private_email property will only be present if it is true.

example

true

iss

iss: string

The issuer-registered claim key, which has the value https://appleid.apple.com.

example

"https://appleid.apple.com"

nonce

nonce: string

A String value used to associate a client session and an ID token. This value is used to mitigate replay attacks and is present only if passed during the authorization request.

nonce_supported

nonce_supported: boolean

A Boolean value that indicates whether the transaction is on a nonce-supported platform. If you sent a nonce in the authorization request but do not see the nonce claim in the ID token, check this claim to determine how to proceed. If this claim returns true you should treat nonce as mandatory and fail the transaction; otherwise, you can proceed treating the nonce as optional.

sub

sub: string

The unique identifier for the user.

example

"001999.80b18c74c3264cad895d0eae181d8f50.1909"

Legend

  • Constructor
  • Method
  • Property
  • Private property

Generated using TypeDoc