Apple Identity Provider

Overview

Adding a Sign in with Apple button to FusionAuth is simple, and this guide will walk you through the steps necessary to collect the configuration details from your Apple Developer account in order to enable this Social login.

• Create an Apple Developer Account

• Configure your Apple Developer Account

  • Register a new App ID

  • Register a new Service ID

  • Register a new Key

• Import the Private Key

• Create an Apple Identity Provider

• Apple Private Mail Relay Configuration

• CORS Configuration

• Building Your Own Integration

Once you have completed this configuration you will be able to enable the Sign in with Apple login button for one or more FusionAuth Applications. Below is an example login page with the Apple Identity Provider enabled.

Create an Apple Developer Account

Ensure you have an Apple Developer account, and then navigate to your Apple Developer account.

• https://developer.apple.com/

If you do not yet have an Apple Developer account, please do this now. Once you have logged into Apple and have obtained access to your Apple Developer account, continue to the next step.

Configure your Apple Developer Account

If you already have an App ID, Service ID and key configured for Sign in with Apple, you may utilize these existing values. If you have yet to configure your Apple developer account for Sign in with Apple, complete the following steps.

Register a new App ID

From your Apple Developer account, navigate to Certificates, Identifiers & Profiles and select Identifiers from the left column. Click on plus icon to add a new identifier.

Select App IDs and click Continue. On the next panel, fill in the Description field and Sign in with Apple from the list of capabilities and then click Continue. On the next panel confirm your selection, make a note of the App ID Prefix (Team ID) and click Register.

Register a new Service ID

From your Apple Developer account, navigate to Certificates, Identifiers & Profiles and select Identifiers from the left column. Click on plus icon to add a new identifier.

Select Service IDs and click Continue. On the next panel, fill in the Description the Identifier fields and click Continue. Complete this step by clicking Register on the following panel.

Edit your newly created Service Id, enable and then configure Sign In with Apple. Clicking the Configure button will open a Web Authentication Configuration panel. In this step you will need to configure your application domain and return URL of your FusionAuth service.

If you do not see the Domains and Subdomains and the Return URLs text input fields, click the plus icon next to Website URLs.

Next, enter your application domain and Return URL.

For example, if the FusionAuth URL is https://login.piedpiper.com then the origin would be login.piedpiper.com. The Return URL is the FusionAuth URL with the a path of /oauth2/callback, so in this example the return URL would be https://login.piedpiper.com/oauth2/callback.

Additional domains and return URLs may be added at a later time as well. Once you have completed this configuration, save your changes and click Continue. Confirm your changes to the Services ID by clicking Save.

Register a new Key

From your Apple Developer account, navigate to Certificates, Identifiers & Profiles and select Keys from the left column. Click on plus icon to add a new key.

Enter a name for your key.

Enable the Sign in with Apple checkbox, and then click the Configure button.

On the next panel select the previously created App ID and click Save. Click Continue, and then confirm key registration by clicking Register. When prompted to download the key, do so and make a note of the Key ID.

Import the Private Key

Now that we have completed the Apple configuration, we can import the private key we collected in the previous step. To import the private key, navigate to Settings → Key Master and select Import Private Key from the actions in the top right.

Enter the Key ID from the previous step and enter it into the Key identifier field. Using a text editor, open the key file you downloaded in the previous step and copy the value into the Private key field.

Create an Apple Identity Provider

The last step will be to create an Apple Identity Provider in FusionAuth. To create an Identity Provider navigate to Settings → Identity Providers and click Add provider and select Apple from the dialog.

This will take you to the Add Apple panel, and you’ll fill out the required fields using the values from your Apple Developer account. The button text is also required but it will be defaulted to Sign in with Apple, you may optionally modify this default value.

To enable this identity provider for an application, find your application name in the Applications configuration section at the bottom of this panel. You will always see the FusionAuth application, this application represents the FusionAuth user interface. If you wish to be able to log into FusionAuth with this provider you may enable this application.

In the following screenshot you will see that we have enabled this login provider for the Pied Piper application and enabled Create registration. Enabling create registration means that a user does not need to be manually registered for the application prior to using this login provider.

For example, when a new user attempts to log into Pied Piper using Apple, if their user does not exist in FusionAuth it will be created dynamically, and if the Create registration toggle has been enabled, the user will also be registered for Pied Piper and assigned any default roles assigned by the application.

If you do not wish to automatically provision a user for this Application when logging in with Apple, leave Create registration off and you will need to manually register a user for this application before they may complete login with Apple.

That’s it, now the Sign in with Apple button will show up on the login page for Pied Piper.

Apple Private Mail Relay Configuration

When a user logs in with Apple, they will be provided an option to send their actual email address or an anonymous email address back to FusionAuth.

For example, if the user selects to use an anonymous email address, FusionAuth will receive an email that ends in @privaterelay.appleid.com. This email address may be used to communicate with the user, however it means that the email will be routed through Apple’s Private Email Relay service. To ensure your email is delivered you will want to register your email domain and perform any necessary configuration with your SMTP service provider.

• Apple - Communicating Using the Private Email Relay Service

Some Email Service providers may provide documentation to assist you in making the necessary configuration changes. For example, the following article is provided by SendGrid to help you send email through Apple’s Private Email Relay.

• SendGrid - Configuring Sign in with Apple

CORS Configuration

In order to complete the login request, Apple will make an HTTP POST request to the callback URL in FusionAuth. In order for this request to be allowed through the CORS filter you will need to navigate to Settings → System → CORS and add https://appleid.apple.com as an Allowed Origin the CORS configuration.

Once you complete your Apple Identity Provider configuration, if your CORS configuration is not yet configured to allow the Apple login request to complete you wil be shown the following warning prompting you to complete the CORS configuration. See the CORS Filter reference for additional details on modifying the CORS configuration.

Building Your Own Integration

If you are building your own login experience, you’ll want to start the identity provider flow yourself and then complete the login.

You might do this if you are using the Login API rather than using the hosted FusionAuth login pages.

Completing the login is documented further in the API.