Interface: AppleRequestOptions
November 5, 2025 ยท View on GitHub
@invertase/react-native-apple-authentication
Interface: AppleRequestOptions
Defined in: index.d.ts:240
Apple Authentication Request options to be used with performRequest(requestOptions).
Properties
nonce?
optionalnonce:string
Defined in: index.d.ts:273
Nonce to be passed to the identity provider. If value not provided, one will automatically be created for you and available as part of @{AppleRequestResponse}.
This value can be verified with the identity token provided as a part of successful ASAuthorization response.
The nonce size may depend on the actual technology used and an error might be returned by the request execution.
nonceEnabled?
optionalnonceEnabled:boolean
Defined in: index.d.ts:282
Disable automatic nonce behaviour by setting this to false.
Useful for authentication providers that don't yet support nonces.
Defaults to true.
requestedOperation?
optionalrequestedOperation:AppleRequestOperation
Defined in: index.d.ts:253
Operation which should be executed.
Url
requestedScopes?
optionalrequestedScopes:AppleRequestScope[]
Defined in: index.d.ts:246
The contact information to be requested from the user.
Only scopes for which this app was authorized for will be returned.
state?
optionalstate:string
Defined in: index.d.ts:289
State to be passed to the identity provider.
This value will be returned as a part of successful AppleRequestResponse response.
user?
optionaluser:string
Defined in: index.d.ts:261
If you have been previously vended a 'user' value through a Apple Authorization response, you may set it here to provide additional context to the identity provider.
Inherited from ASAuthorizationAppleIDRequest