AppleAuthentication

Installation

Configuration

1. Enable the "Sign In with Apple" capability in your app. For bare projects, enable the capability in Xcode under "Signing & Capabilities" -- you'll need to be on Xcode 11 or later. For managed projects, set ios.usesAppleSignIn to true in app.json.
2. Log into the Apple Developer Console, go to "Certificates, Identifiers, & Profiles" and then "Identifiers".
3. You need to choose a primary app for the Apple Sign In configuration. This is the app whose icon will show up in the Apple Sign In system UI. If you have a set of related apps you might choose the "main" app as the primary, but most likely you'll want to just use the app you're working on now as the primary.
4. In the list of identifiers, click on the one corresponding to your primary app. Enable the "Sign In with Apple" capability, click "Edit", and choose the "Enable as a primary App ID" option. Save the new configuration.
5. If you chose a different app to be the primary, you'll also need to open up the configuration page for your current app, enable the "Sign In with Apple" capability, click "Edit" and choose the "Group with an existing primary App ID" option. Save this configuration as well.
6. Next, go to the "Keys" page and register a new key. Add the "Sign In with Apple" capability, and make sure to choose the correct primary app on the configuration screen.
7. Finally, when you want to make a standalone build to test with, run expo build:ios --clear-provisioning-profile --revoke-credentials so that your provisioning profile is regenerated with the new entitlement.
8. (Optional) If you'd like to localize the button text, you can add "CFBundleAllowMixedLocalizations": true to your ios.infoPlist property in your app.json. Note: The localized value will only appear in your standalone app.

Usage

import * as AppleAuthentication from 'expo-apple-authentication';

function YourComponent() {
  return (
    <AppleAuthentication.AppleAuthenticationButton
      buttonType={AppleAuthentication.AppleAuthenticationButtonType.SIGN_IN}
      buttonStyle={AppleAuthentication.AppleAuthenticationButtonStyle.BLACK}
      cornerRadius={5}
      style={{ width: 200, height: 44 }}
      onPress={async () => {
        try {
          const credential = await AppleAuthentication.signInAsync({
            requestedScopes: [
              AppleAuthentication.AppleAuthenticationScope.FULL_NAME,
              AppleAuthentication.AppleAuthenticationScope.EMAIL,
            ],
          });
          // signed in
        } catch (e) {
          if (e.code === 'ERR_CANCELED') {
            // handle that the user canceled the sign-in flow
          } else {
            // handle other errors
          }
        }
      }}
    />
  );
}

Development and Testing

Verifying the Response from Apple

API

import * as AppleAuthentication from 'expo-apple-authentication';

• AppleAuthentication.isAvailableAsync()
• AppleAuthentication.signInAsync(options)
• AppleAuthentication.getCredentialStateAsync(user)

• AppleAuthentication.AppleAuthenticationButton

• AppleAuthentication.AppleAuthenticationButtonProps

• AppleAuthentication.AppleAuthenticationButtonStyle
• AppleAuthentication.AppleAuthenticationButtonType
• AppleAuthentication.AppleAuthenticationCredentialState
• AppleAuthentication.AppleAuthenticationScope
• AppleAuthentication.AppleAuthenticationUserDetectionStatus

• AppleAuthentication.AppleAuthenticationCredential
• AppleAuthentication.AppleAuthenticationFullName
• AppleAuthentication.AppleAuthenticationSignInOptions

Methods

AppleAuthentication.isAvailableAsync()

Returns

AppleAuthentication.signInAsync(options)

Arguments

• requestedScopes (AppleAuthenticationScope[]) (optional) - Array of user information scopes to which your app is requesting access. Note that the user can choose to deny your app access to any scope at the time of logging in. You will still need to handle null values for any scopes you request. Additionally, note that the requested scopes will only be provided to you the first time each user signs into your app; in subsequent requests they will be null.
• state (string) (optional) - An arbitrary string that is returned unmodified in the corresponding credential after a successful authentication. This can be used to verify that the response was from the request you made and avoid replay attacks. More information on this property is available in the OAuth 2.0 protocol RFC6749.
• nonce (string) (optional) - An arbitrary string that is used to prevent replay attacks. See more information on this in the OpenID Connect specification.

Returns

AppleAuthentication.getCredentialStateAsync(user)

Note: This method must be tested on a real device. On the iOS simulator it always throws an error.

Arguments

• user (string) - The unique identifier for the user whose credential state you'd like to check. This should come from the user field of an AppleAuthenticationCredential object.

Returns

Components

AppleAuthentication.AppleAuthenticationButton

AppleAuthentication.AppleAuthenticationButtonProps

• onPress (function) - The method to call when the user presses the button. You should call AppleAuthentication.signInAsync in here.
• buttonType (AppleAuthenticationButtonType) - The type of button text to display ("Sign In with Apple" vs. "Continue with Apple").
• buttonStyle (AppleAuthenticationButtonStyle) - The Apple-defined color scheme to use to display the button.
• cornerRadius (number) - The border radius to use when rendering the button. This works similarly to style.borderRadius in other Views.

Enum Types

AppleAuthentication.AppleAuthenticationButtonStyle

• AppleAuthenticationButtonStyle.WHITE - White button with black text
• AppleAuthenticationButtonStyle.WHITE_OUTLINE - White button with a black outline and black text
• AppleAuthenticationButtonStyle.BLACK - Black button with white text

AppleAuthentication.AppleAuthenticationButtonType

• AppleAuthenticationButtonType.SIGN_IN - "Sign in with Apple"
• AppleAuthenticationButtonType.CONTINUE - "Continue with Apple"

AppleAuthentication.AppleAuthenticationCredentialState

• AppleAuthenticationCredentialState.REVOKED
• AppleAuthenticationCredentialState.AUTHORIZED
• AppleAuthenticationCredentialState.NOT_FOUND
• AppleAuthenticationCredentialState.TRANSFERRED

AppleAuthentication.AppleAuthenticationScope

• AppleAuthenticationScope.FULL_NAME
• AppleAuthenticationScope.EMAIL

AppleAuthentication.AppleAuthenticationUserDetectionStatus

• AppleAuthenticationUserDetectionStatus.UNSUPPORTED - The system does not support this determination and there is no data.
• AppleAuthenticationUserDetectionStatus.UNKNOWN - The system has not determined whether the user might be a real person.
• AppleAuthenticationUserDetectionStatus.LIKELY_REAL - The user appears to be a real person.

Object Types

AppleAuthentication.AppleAuthenticationCredential

• user (string) - An identifier associated with the authenticated user. You can use this to check if the user is still authenticated later. This is stable and can be shared across apps released under the same development team. The same user will have a different identifier for apps released by other developers.
• fullName (AppleAuthenticationFullName) - The user's name. May be null or contain null values if you didn't request the FULL_NAME scope, if the user denied access, or if this is not the first time the user has signed into your app.
• email (string) - The user's email address. Might not be present if you didn't request the EMAIL scope. May also be null if this is not the first time the user has signed into your app. If the user chose to withhold their email address, this field will instead contain an obscured email address with an Apple domain.
• realUserStatus (AppleAuthenticationUserDetectionStatus) - A value that indicates whether the user appears to the system to be a real person.
• state (string) - An arbitrary string that your app provided as state in the request that generated the credential. Used to verify that the response was from the request you made. Can be used to avoid replay attacks. If you did not provide state when making the sign-in request, this field will be null.
• identityToken (string) - A JSON Web Token (JWT) that securely communicates information about the user to your app.
• authorizationCode (string) - A short-lived session token used by your app for proof of authorization when interacting with the app's server counterpart. Unlike user, this is ephemeral and will change each session.

AppleAuthentication.AppleAuthenticationFullName

• namePrefix (string)
• givenName (string)
• middleName (string)
• familyName (string)
• nameSuffix (string)
• nickname (string)

AppleAuthentication.AppleAuthenticationSignInOptions

• requestedScopes (AppleAuthenticationScope[]) - The scope of personal information to which your app is requesting access. The user can choose to deny your app access to any scope at the time of logging in. Defaults to [] (no scopes).
• state (string) - Data that's returned to you unmodified in the corresponding credential after a successful authentication. Used to verify that the response was from the request you made. Can be used to avoid replay attacks.

Error Codes