Concerned about Okta's acquisition of Auth0?   Learn how to migrate from Auth0 to FusionAuth

FusionAuth logo
FusionAuth logo
  • Features
    FusionAuth Reactor

    FusionAuth Reactor is a powerful suite of features developed to extend FusionAuth's core functionality.

    • Flexible Architecture   Flexible Architecture
    • Auth the Way You Want It   Auth the Way You Want It
    • Security & Compliance   Security & Compliance
    • Ultimate Password Control   Ultimate Password Control
    • Customizable User Experience   Customizable User Experience
    • Advanced Registration Forms   Advanced Registration Forms
    • Built for Devs   Built for Devs
    • User Management & Reporting   User Management & Reporting
    • Scalability   Scalability
    • Single Sign-on   Single Sign-on
    • Breached Password Detection   Breached Password Detection
    • Connectors   Connectors
    • FusionAuth Reactor   FusionAuth Reactor
  • Pricing
    Cloud Pricing

    Let us host, monitor, manage, and maintain your deployments in your own private cloud.

    SEE PRICING cloud pricing   See FusionAuth Cloud Pricing
    Editions Pricing

    A powerful set of features with available support that extends FusionAuth's core functionality.

    SEE PRICING edition pricing   See FusionAuth Edition Pricing
    Editions + Cloud

    FusionAuth will handle everything so you can get back to building something awesome.

    GET STARTED Get started
  • Docs
  • Downloads
  • Resources
    FusionAuth Resources
    • Upgrade from SaaS
    • Upgrade from Open Source
    • Upgrade from Home Grown
    • Blog   Blog
    • Forum   Forum
    • Community & Support   Community & Support
    • Customer & Partners   Customers & Partners
    • Video & Podcasts   Videos & Podcasts
    • Getting Started   Getting Started
    • Auth0 Migration   Migrate from Auth0
  • Expert Advice
    Expert Advice for Developers

    Learn everything you need to know about authentication, authorization, identity, and access management from our team of industry experts.

    • Authentication   Authentication
    • CIAM   CIAM
    • Identity Basics   Identity Basics
    • OAuth   OAuth
    • Security   Security
    • Tokens   Tokens
    • Dev Tools   Dev Tools
  • Account
Navigate to...
  • Welcome
  • Getting Started
  • 5-Minute Setup Guide
  • Reactor
  • Core Concepts
    • Overview
    • Users
    • Roles
    • Groups
    • Entity Management
    • Registrations
    • Applications
    • Tenants
    • Identity Providers
    • Search
    • Authentication and Authorization
    • Integration Points
    • Localization and Internationalization
    • Roadmap
  • Installation Guide
    • Overview
    • System Requirements
    • Server Layout
    • Cloud
    • Cluster
    • Docker
    • Fast Path
    • Kickstart™
    • Homebrew
    • Packages
    • Database
    • FusionAuth App
    • FusionAuth Search
    • Securing
    • Upgrading
  • APIs
    • Overview
    • Authentication
    • Errors
    • Actioning Users
    • Applications
    • Audit Logs
    • Connectors
      • Overview
      • Generic
      • LDAP
    • Consent
    • Emails
    • Entity Types
    • Event Logs
    • Families
    • Forms
    • Form Fields
    • Groups
    • Identity Providers
      • Overview
      • Apple
      • Facebook
      • Google
      • HYPR
      • LinkedIn
      • Twitter
      • OpenID Connect
      • SAML v2
      • External JWT
    • Integrations
    • JWT
    • Keys
    • Lambdas
    • Login
    • Passwordless
    • Registrations
    • Reports
    • System
    • Tenants
    • Themes
    • Two Factor
    • Users
    • User Actions
    • User Action Reasons
    • User Comments
    • Webhooks
  • Client Libraries
    • Overview
    • Dart
    • Go
    • Java
    • JavaScript
    • .NET Core
    • Node
    • PHP
    • Python
    • Ruby
    • Typescript
  • Themes
    • Overview
    • Localization
    • Examples
  • Email & Templates
    • Overview
    • Configure Email
    • Email Templates
  • Events & Webhooks
    • Overview
    • Events
    • Writing a Webhook
    • Securing Webhooks
  • Example Apps
    • Overview
    • Go
    • Java
    • JavaScript
    • .NET Core
    • PHP
    • Python
    • Ruby
  • Lambdas
    • Overview
    • Apple Reconcile
    • External JWT Reconcile
    • Facebook Reconcile
    • Google Reconcile
    • HYPR Reconcile
    • JWT Populate
    • LDAP Connector Reconcile
    • LinkedIn Reconcile
    • OpenID Connect Reconcile
    • SAML v2 Populate
    • SAML v2 Reconcile
    • Twitter Reconcile
  • Identity Providers
    • Overview
    • Apple
    • Facebook
    • Google
    • HYPR
    • LinkedIn
    • Twitter
    • OpenID Connect
      • Overview
      • Azure AD
      • Github
      • Discord
    • SAML v2
      • Overview
      • ADFS
    • External JWT
      • Overview
      • Example
  • Connectors
    • Overview
    • Generic Connector
    • LDAP Connector
    • FusionAuth Connector
  • Integrations
    • Overview
    • CleanSpeak
    • Kafka
    • Twilio
  • OpenID Connect & OAuth 2.0
    • Overview
    • Endpoints
    • Tokens
  • SAML v2 IdP
    • Overview
    • Google
    • Zendesk
  • Plugins
    • Writing a Plugin
    • Password Encryptors
  • Guides
    • Overview
    • Advanced Registration Forms
    • Breached Password Detection
    • Migration
    • Migration From Auth0
    • Passwordless
    • Securing Your APIs
    • Silent Mode
    • Single Sign-on
  • Tutorials
    • Overview
    • Setup Wizard & First Login
    • Register/Login a User
    • Migrate Users
    • JSON Web Tokens
    • Authentication Tokens
    • Start and Stop FusionAuth
    • Switch Search Engines
    • User Account Lockout
    • Two Factor
  • Reference
    • CORS
    • Configuration
    • Data Types
    • Known Limitations
    • Password Encryptors
  • Release Notes
  • Troubleshooting

Apple Identity Provider

Overview

Available since 1.17.0

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.

Apple Login

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

Apple Identifiers

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.

Register 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

Apple Identifiers

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.

Register 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

Apple Identifiers

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.

Register a new Key

Enter a name for your key.

Register a new 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.

Import Private Key

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 administrative 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. You will need to manually register a user for this application before they may Sign in with Apple.

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

Add Apple

Form Fields

Services Id Required

The Apple Services identifier found in your Apple Developer Account which has been configured for Sign in with Apple.

From within your Apple Developer account, navigate to Certificates, Identifiers & Profiles → Identifiers → Services IDs

Team Id Required

The Apple App ID Prefix, or Team ID found in your Apple Developer Account which has been configured for Sign in with Apple.

From within your Apple Developer account, navigate to Certificates, Identifiers & Profiles → Identifiers → App IDs

Button text Required

The text to be displayed in the button on the login form. This value is defaulted to Sign in with Apple but it may be modified to your preference.

Scope Optional

The optional scope value, this is a space separated list of requested user attributes. You may request the User’s name, email or both.

Example: name email

Signing key Required

The private signing key provided by Apple which will be used to sign the client secret when requesting an access token from Apple.

Reconcile lambda Optional

A lambda may be utilized to map custom claims returned from Apple.

To configure a lambda, navigate to Settings → Lambdas.

Debug enabled Optional defaults to false

Enable debug to create an event log to assist you in debugging integration errors.

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.

Apple CORS Warning

Troubleshooting CORS

If you receive a 403 status code in the browser console during login when using Safari, additional configuration is required. The redirect flow is slightly different between the browsers.

To resolve this issue, navigate to Settings → System → CORS and add the GET method to the Allowed methods.

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.

Feedback

How helpful was this page?

See a problem?

File an issue in our docs repo

Quick Links

  • Download
  • Cloud Pricing
  • Editions Pricing
  • Contact Us
  • Jobs (come work with us)
  • My Account

Resources

  • Docs
  • Blog
  • Community & Support
  • Upgrade from SaaS
  • Upgrade from Homegrown
  • Upgrade from Open Source

Everything Else

  • Privacy Policy
  • Product Privacy Policy
  • License
  • License FAQ
  • Security (contact, bug bounty, etc)
  • Technical Support

Connect with Us

logo
Subscribe for Updates
We only send dev friendly newsletters. No marketing fluff!
© 2021 FusionAuth