Add Apple login

You can add Apple login to your applications using Asgardeo and enable users to log in with their Apple IDs.

Follow this guide for instructions.

Register Asgardeo on Apple

Before you begin

You need a paid subscription to get access to an Apple developer account.

To register Asgardeo on Apple, you need to create the following components on Apple's Developer Portal:

Step 1: Register an App ID

To register an App ID:

1. On the Apple Developer portal, go to Program resources > Certificates, Identifiers & Profiles > Identifiers.

   

2. Click + to register an App ID.

3. Select App IDs and click Continue.
4. Select App as the type and click Continue.

5. Enter the values for the following parameters.

   Parameter	Definition
   Description	A description for the services ID.
   Bundle ID	A unique identifier for the application. It is usually a string of characters in reverse domain name notation. Example: com.domainname.appname

   

6. Under the Capabilities tab, select Sign in with Apple.

7. Click Continue and then click Register.

Step 2: Register a Services ID

To register a services ID:

1. On the Apple Developer portal, go to Program resources > Certificates, Identifiers & Profiles > Identifiers.

   

2. Click + and select Services IDs and click Continue.

3. Enter values for the following parameters:

   Parameter	Definition
   Description	A description for the services ID.
   Identifier	A unique identifier for the application. It is usually a string of characters in reverse domain name notation. This value is considered the client ID of the application. Example: com.domainname.appname

4. Click Continue and then click Register.

5. Go back to the Identifiers section and click on the Services ID you created.
6. Enable Sign in with Apple and click Configure.
7. Under Web Authentication Configuration, select the App ID you created as the Primary App ID.

8. Enter the following values under Register Website URLs.

   Parameter	Value
   Domain	api.asgardeo.io
   Return URL	https://api.asgardeo.io/t/{organization_name}/commonauth

9. Click Continue and then click Save.

Step 3: Register a new key

To register a new key:

1. On Apple Developer portal, go to Program resources > Certificates, Identifiers & Profiles > Keys.

   

2. Click + to register a new key.

3. Enter a name for the key, enable Sign in with Apple, and click Configure.
4. Under Configure Keys, select the App ID you created previously and click Save. Then click Continue.

5. Click Register.

   Note

   You will now see that your app's Private key is ready to be downloaded. Download and save it securely, as you cannot download it again. Also, take note of the Key ID that is displayed on this page.

6. Click Done.

Note down the Team ID displayed in the top right corner under your name.

You can follow the Apple documentation for detailed instructions.

Tip

A client secret is required to integrate the Apple application with Asgardeo. Usually, the external IdP generates a client secret, but in this scenario, Apple expects Asgardeo to generate the client secret.

Register the Apple IdP

Now, let's register the Apple IdP in Asgardeo.

1. On the Asgardeo Console, go to Connections.
2. Click New Connections and select Apple.

3. Enter the following details of the Apple identity provider and click Finish:

   

   Parameter	Description
   Name	A unique name for this Apple identity provider.
   Services ID	The services ID obtained from Apple..
   Team ID	Apple developer team ID obtained from Apple.
   Key ID	Key identifier of the private key generated for the app.
   Private Key	Private key generated for the app.

After creating the Apple identity provider, go to the Settings tab and see the list of scopes to which Apple has granted permissions.

• email: Allows to view the user's email address.
• name: Allows to view the user's name fields.

Note

Asgardeo needs these scopes to get user information. Asgardeo checks the attribute configurations of the application and sends the relevant attributes received from Apple to the app. You can read the Apple documentation to learn more.

Update the client secret validity period

Asgardeo generates a client secret for the IdP. This client secret has the default maximum validity period of six months.

If you wish to reduce the validity period:

1. On the Asgardeo Console, go to Connections.
2. Click Setup on your Apple IdP.
3. On the Settings tab update the value of the Client Secret Validity Period.

Enable Apple login

Before you begin

You need to register an application with Asgardeo. You can register your own application or use one of the sample applications provided.

1. On the Asgardeo Console, go to Applications.

2. Select your application, go to the Login Flow tab and add Apple login from your preferred editor:

   Classic EditorVisual Editor

   To add Apple login using the Classic Editor: 1. If you haven't already defined a sign-in flow, click Start with Default configuration to get started.

   1. Click Add Authentication on the step, select your Apple identity provider, and click Add.

      

   To add Apple login using the Visual Editor:

   1. Switch to the Visual Editor tab, by default the Username & Password login flow will be added onto the Visual Editor's workspace.

   2. Click on + Add Sign In Option to add a new authenticator to the same step and select your Apple connection.

      

   ---

   Recommendations

   It is recommended to add your social and enterprise connections to the first authentication step as they are used for identifying the user.

3. Click Update to save your changes.

Try it out

Follow the steps given below.

1. Access the application URL.

2. Click Login to open the Asgardeo login page.

3. On the Asgardeo login page, click Sign in with Apple.

   

4. Log in to Apple with an existing Apple ID.

Note

When a user successfully logs in with Apple for the first time,

• Apple will prompt you to create an account for the Apple IDP application.
• A user account is created in the Asgardeo Console with the Apple username. Apple will manage this new user account.

Configure connection

To learn more about other configurations available for the connection, refer to the add federated login documentation.