SigninWithApple Events

SigninWithApple has the following events associated with it:

onSuccessCallback Event

An event callback is invoked by the platform when the user performs a sucsessfull authentication action using the Apple ID on the SigninWithApple widget button.

Once the user logs in with the Apple ID, we'll get a set of values that will help to store in the keychain.

Values collected	Description
User	Unique user-id
givenName	Name of user
familyName	User family Name
identityToken	The JSON Web Token (JWT) served to securely communicate user identity information to the app. The ID token, signed by Apple's ID provider, includes the following information: Issuer Identifier, Subject Identifier, Audience, Expiry Time and Issuance Time. Example: Email which is used for sign in
email	The email used for sign in.
authorizationCode	A short-lived, one-time valid token that provides proof of authorization for the server component of the app. The authorization code is connected to the specific transaction using the state attribute passed in the request for authorization. The application's server component will validate the code using the Apple identity service endpoint provided for this purpose.
authorizedScopes	This value will include a list of scopes for which authorization has been provided by the user. These could contain a subset of the scopes requested on @see ASAuthorizationAppleIDRequest. This value should be queried by the application to identify which scopes have been returned as it may differ from those requested.

Syntax


onSuccessCallback ()

Type

Constant

Read/Write

Read Only

Example

Platform Availability

iOS 13 or later

onFailureCallback Event

An event onFailureCallback is invoked by the platform when the user fails a authentication action using the Apple ID on the SigninWithApple widget button.

The following table lists the Error codes that are displayed on the VoltMX Iris.

Error Codes	Failure Callback with enum Values	Description
1000	VoltMXSignInWithAppleAuthorizationErrorUnknown	The authorization attempt failed for an unknown reason.
1001	VoltMXSignInWithAppleAuthorizationErrorCanceled	The user canceled the authorization attempt.
1002	VoltMXSignInWithAppleAuthorizationErrorInvalidResponse	The authorization request received an invalid response.
1003	VoltMXSignInWithAppleAuthorizationErrorNotHandled	The authorization request wasn’t handled.
1004	VoltMXSignInWithAppleAuthorizationErrorFailed	The authorization attempt failed.