Skip to content

Latest commit

 

History

History
99 lines (54 loc) · 2.67 KB

_lib_index_d_.applerequestoptions.md

File metadata and controls

99 lines (54 loc) · 2.67 KB

Interface: AppleRequestOptions

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

Hierarchy

  • AppleRequestOptions

Index

Properties

Properties

Optional nonce

nonce? : undefined | string

Defined in lib/index.d.ts:263

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.


Optional nonceEnabled

nonceEnabled? : undefined | false | true

Defined in lib/index.d.ts:272

Disable automatic nonce behaviour by setting this to false.

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

Defaults to true.


Optional requestedOperation

requestedOperation? : AppleRequestOperation

Defined in lib/index.d.ts:243

Operation which should be executed.

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


Optional requestedScopes

requestedScopes? : AppleRequestScope[]

Defined in lib/index.d.ts:236

The contact information to be requested from the user.

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


Optional state

state? : undefined | string

Defined in lib/index.d.ts:279

State to be passed to the identity provider.

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


Optional user

user? : undefined | string

Defined in lib/index.d.ts:251

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