A response from performRequest(requestOptions).
- AppleRequestResponse
• authorizationCode: string | null
Defined in lib/index.d.ts:397
A short-lived, one-time valid token that can provides proof of authorization to the server component of your app.
The authorization code is bound to the specific transaction using the state attribute passed in the authorization request. The server component of your app can validate the code using the Apple identity service endpoint.
• authorizedScopes: AppleRequestScope[]
Defined in lib/index.d.ts:362
This value will contain an array of scopes for which the user provided authorization. Note that these may contain a subset of the requested scopes. You should query this value to identify which scopes were returned as it may be different from ones you requested.
See @{AppleRealUserStatus}
• email: string | null
Defined in lib/index.d.ts:382
An optional email shared by the user.
This field is populated with a value that the user authorized.
• fullName: null | AppleRequestResponseFullName
Defined in lib/index.d.ts:346
An optional full name shared by the user.
This field is populated with a value that the user authorized.
See @{AppleRequestResponseFullName}
• identityToken: string | null
Defined in lib/index.d.ts:375
A JSON Web Token (JWT) used to communicate information about the identity of the user in a secure way to the app.
The ID token contains the following information signed by Apple's identity service:
- Issuer Identifier
- Subject Identifier
- Audience
- Expiry Time
- Issuance Time
• nonce: string
Defined in lib/index.d.ts:327
Nonce that was passed to the identity provider. If none was passed to the request, one will have automatically been created and available to be read from this property.
• realUserStatus: AppleRealUserStatus
Defined in lib/index.d.ts:353
Check this property for a hint as to whether the current user is a "real user".
See @{AppleRealUserStatus}
• state: string | null
Defined in lib/index.d.ts:387
A copy of the state value that was passed to the initial request.
• user: string
Defined in lib/index.d.ts:337
An opaque user ID associated with the AppleID used for the sign in. This identifier will be stable across the 'developer team', it can later be used as an input to
{appleauthrequest} to request user contact information.
The identifier will remain stable as long as the user is connected with the requesting client. The value may change upon user disconnecting from the identity provider.