Apple Social Identity Provider

To configure Apple as a social identity provider (Sign in with Apple), you'll need an Apple developer account.

Configure Apple Login

You need a client ID and client secret for your application. In the Apple developer portal, the client ID is called a Services ID.

  1. Log in to the Apple Developer Portal.

  2. Select Certificates, Identifiers and Profiles > Identifiers.

  3. On the Identifiers page, select Register a New Identifier, then select Services IDs.

  4. Enter a Description and Identifier for this Services ID, and make sure that Sign in With Apple is enabled.

    Important

    The Identifier you specify here will be your OAuth Client ID.

  5. Click Configure.

  6. On the Web Authentication Configuration screen, enter the Web Domain on which IDM runs, and specify the redirect URL used during the OAuth flow (Return URLs).

    The redirect URL must have the following format:

    https://idm.example.com/redirect

    Note

    You must use a real domain (FQDN) here. Apple does not allow localhost URLs. If you enter an IP address such as 127.0.0.1, it will fail later in the OAuth flow.

  7. Click Save > Continue > Register.

  8. Generate the client secret.

    Instead of using simple strings as OAuth client secrets, Apple uses a public/private key pair, where the client secret is a signed JWT. To register the private key with Apple:

    1. Select Certificates, Identifiers and Profiles > Keys, then click the + icon to register a new key.

    2. Enter a Key Name and enable Sign In with Apple.

    3. Click Configure, then select the primary App ID that you created previously.

    4. Apple generates a new private key, in a .p8 file.

      Caution

      You can only download this key once. Ensure that you save this file, because you will not be able to download it again.

      Rename the file to key.txt, then locate the Key ID in that file.

    5. Use this private key to generate a client secret JWT. Sign the JWT with your private key, using an ES256 algorithm.

Configure an Apple Identity Provider

  1. To configure an Apple social identity provider, log in to the Admin UI and select Configure > Social ID Providers.

  2. Enable the Apple social identity provider.

    In the Apple Provider window, enter the Redirect URI that you set up in "Configure Apple Login".

  3. Enter your Client ID and Client Secret.

Configure User Registration through Apple

When you have configured the Apple social identity provider, you can activate it through User Registration.

  1. In the Admin UI, select Configure > User Registration > Enable User Registration.

  2. On the Social tab, enable Social Registration.

    For more information, see "Self-Service End User UI".

Apple Social Identity Provider Configuration Details

You can set up the Apple social identity provider through the Admin UI or in a conf/identityProvider-apple.json file. IDM generates the identityProvider-apple.json file when you configure and enable this social identity provider in the Admin UI. Alternatively, you can create the file manually.

The following table includes the information shown in the Admin UI Apple Provider pop-up window, along with associated information in the identityProvider-apple.json file.

Apple Social Identity Provider Configuration Properties
Property (UI)Property (JSON file)Description
Client IDclientIdThe client identifier for your Apple App. In the Apple developer portal, the client ID is called a Services ID.
Client SecretclientSecretUsed with the Client ID to access the applicable Apple API.
ScopescopeAn array of strings that allows access to user data.
Authorization EndpointauthorizationEndpointTypically, https://appleid.apple.com/auth/authorize.
Token EndpointtokenEndpointEndpoint that receives a one-time authorization code, and returns an access token. Typically, https://appleid.apple.com/auth/token.
Well-Known EndpointwellKnownEndpointAccess for other URIs. Typically, https://appleid.apple.com/.well-known/openid-configuration.
IssuerissuerThe token issuer. Typically, https://appleid.apple.com.
Not in the Admin UIproviderName of the social identity provider.
Not in the Admin UIconfigClassConfiguration class for the authentication module.
Not in the Admin UIbasicAuthWhether to use basic authentication.
Not in the Admin UIpropertyMapMapping between Apple and IDM.

For information on social identity provider buttons and badges, see "Social Identity Provider Button and Badge Properties".

Read a different version of :