Login with Apple
Openfort Auth supports using Sign in with Apple on the web and in native apps for iOS, macOS, watchOS or tvOS.
Overview#
To support Sign in with Apple, you need to configure the Apple provider in the Openfort dashboard for your project.
There are three general ways to use Sign in with Apple, depending on the application you're trying to build:
- Sign in on the web or in web-based apps
- Using an OAuth flow initiated by Openfort Auth using the Sign in with Apple REST API.
- Sign in natively inside iOS, macOS, watchOS or tvOS apps using Apple's Authentication Services
In some cases you're able to use the OAuth flow within web-based native apps such as with React Native, Expo or other similar frameworks. It is best practice to use native Sign in with Apple capabilities on those platforms instead.
When developing with Expo, you can test Sign in with Apple via the Expo Go app, in all other cases you will need to obtain an Apple Developer account to enable the capability.
Using the OAuth flow for web#
Sign in with Apple's OAuth flow is designed for web or browser based sign in methods. It can be used on web-based apps as well as websites, though some users can benefit by using Sign in with Apple JS directly.
Behind the scenes, Openfort Auth uses the REST APIs provided by Apple.
Configuration#
You will require the following information:
- Your Apple Developer account's Team ID, which is an alphanumeric string of 10 characters that uniquely identifies the developer of the app. It's often accessible in the upper right-side menu on the Apple Developer Console.
- Register email sources for Sign in with Apple for Email Communication which can be found in the Services section of the Apple Developer Console.
- An App ID which uniquely identifies the app you are building. You can create a new App ID from the Identifiers section in the Apple Developer Console (use the filter menu in the upper right side to see all App IDs). These usually are a reverse domain name string, for example
com.example.app
. Make sure you configure Sign in with Apple once you create an App ID in the Capabilities list. At this time Openfort Auth does not support Server-to-Server notification endpoints, so you should leave that setting blank. (In the past App IDs were referred to as bundle IDs.) - A Services ID which uniquely identifies the web services provided by the app you registered in the previous step. You can create a new Services ID from the Identifiers section in the Apple Developer Console (use the filter menu in the upper right side to see all Services IDs). These usually are a reverse domain name string, for example
com.example.app.web
. - Configure Website URLs for the newly created Services ID. The web domain you should use is the domain your Openfort project is hosted on. The redirect URL is
https://api.openfort.xyz/iam/v1/oauth/callback/apple
. - Create a signing Key in the Keys section of the Apple Developer Console. You can use this key to generate a secret key using the tool below, which is added to your Openfort project's Auth configuration. Make sure you safely store the
AuthKey_XXXXXXXXXX.p8
file. If you ever lose access to it, or make it public accidentally, revoke it from the Apple Developer Console and create a new one immediately. You will have to generate a new secret key using this file every 6 months, so make sure you schedule a recurring meeting in your calendar! - Finally, add the information you configured above to the Apple provider configuration in the Openfort dashboard.
Use this tool to generate a new Apple client secret. No keys leave your browser! Be aware that this tool does not currently work in Safari, so use Firefox or a Chrome-based browser instead.