Skip to content

Latest commit

 

History

History
106 lines (58 loc) · 2.83 KB

AppleRequestOptions.md

File metadata and controls

106 lines (58 loc) · 2.83 KB

Interface: AppleRequestOptions

Apple Authentication Request options to be used with performRequest(requestOptions).

Table of contents

Properties

Properties

nonce

Optional nonce: string

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.

Defined in

index.d.ts:268


nonceEnabled

Optional nonceEnabled: boolean

Disable automatic nonce behaviour by setting this to false.

Useful for authentication providers that don't yet support nonces.

Defaults to true.

Defined in

index.d.ts:277


requestedOperation

Optional requestedOperation: AppleRequestOperation

Operation which should be executed.

url https://developer.apple.com/documentation/authenticationservices/asauthorizationoperationimplicit?language=objc

Defined in

index.d.ts:248


requestedScopes

Optional requestedScopes: AppleRequestScope[]

The contact information to be requested from the user.

Only scopes for which this app was authorized for will be returned.

Defined in

index.d.ts:241


state

Optional state: string

State to be passed to the identity provider.

This value will be returned as a part of successful AppleRequestResponse response.

Defined in

index.d.ts:284


user

Optional user: string

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

Defined in

index.d.ts:256