Skip to main content

Apple

note

To add Apple as a social sign-in provider, you need an Apple Developer account. Go to Enrolling and Verifying Your Identity with the Apple Developer App to create one.

Webbrowser​

Follow these steps to add Apple as a social sign-in provider to your project using the Ory Console:

  1. Go to Authentication → Social Sign-In in the Ory Console.

  2. Click the switch next to the Apple logo to start the configuration.

  3. Copy the Redirect URI and save it for later use.

  4. Using an Apple Developer Account, create an app, a service, and a private key:

    1. To set up an application, navigate to the Apple Developer Dashboard and go to Certs, Identifiers, and Profiles then Identifiers.
    2. Create a new App IDs identifier. When prompted for a type select App.
    3. Enter a description and bundle ID of your liking.
    4. Scroll down and select Sign in with Apple.
    5. Click Continue, then Register.
    6. Go back to the Identifiers overview.
    7. Next to the search icon open the dropdown and select "Services IDs".
    8. Create a new Services ID.
    9. Choose a description of your liking. The identifier must match the App ID value.
    10. Click Continue, then Register.
    11. Click on the newly created service identifier and click the "Sign in with Apple" checkbox.
    12. Click the Configure button and set the domains and subdomain to match your Ory Network domain (or custom hostname).
    13. Add the Redirect URI you received earlier and set it here as the return URL and click Next.
    14. Click Continue, then Save.
    15. Next, go to Keys and register a new key.
    16. Set a key name and enable Sign in with Apple. Next to Sign in with Apple, click Configure.
    17. Use the App ID you created earlier as the primary AppID.
    18. Click Continue, then Register.
    19. Download the key and click Done.

  5. Copy the correct identifiers to the Ory Console Apple configuration:

    • Client ID: Add the identifier of the Services ID (not the Bundle ID) you created in Apple. Not the ID of the App ID. Not the Team ID. Not the Name.
    • Client Secret Signing Key: Paste the contents of your key file downloaded from Apple. Paste the entire key, including the BEGIN/END PRIVATE KEY lines.
    • Apple Team ID: Add your Apple Team ID. In the Apple Developer Console top right menu, navigate to View Membership > Membership > Team ID.
    • Key ID: Paste the key ID of your Apple key. To find this, navigate to your Apple Keys in the Apple Developer Console and open your key. Copy the Key ID.
    • Private Key: Paste the contents of the downloaded files into the field in the Ory Console.

  6. In the Scopes field of the form in the Ory Console, add the following scope:

    • email

  7. Copy the following details from your registered application in Apple to the corresponding fields in the Ory Console form:

    • Apple Team Id
    • Apple Private Key Id
    • Apple Private Key

  8. In the Data Mapping field of the form in the Ory Console, add the following Jsonnet code snippet, which maps the desired claims to the Ory Identity schema:

    local claims = {
      email_verified: false,
    } + std.extVar('claims');

    {
      identity: {
        traits: {
          // Allowing unverified email addresses enables account
          // enumeration attacks,  if the value is used for
          // verification or as a password login identifier.
          //
          // Therefore we only return the email if it (a) exists and (b) is marked verified
          // by Apple.
          [if 'email' in claims && claims.email_verified then 'email' else null]: claims.email,
        },
      },
    }
note

The provider ID for the web browser flow must be apple. This makes sure that the resulting callback URL will be exempt from CSRF middleware, as Apple uses a POST form request that does not include the CSRF cookie.

danger

Don't save secrets such as API keys, credentials, or personal data directly in Jsonnet code snippets. Jsonnet code snippets used for data mapping aren't stored in an encrypted format in Ory Network.

  1. Click Save Configuration.

Using the Apple SDK on native apps​

Apple provides a more integrated UX for native apps using the Apple SDK. This flow uses the native Apple SDK and does not require a browser. This results in a signed id_token on the client side (typically your app) which is exchanged at Ory for a session token.

The following steps are required to integrate the Apple SDK with Ory:

  1. Configure an Apple social sign-in provider in Ory using the same client_id as in your native app.
  2. Optional: iOS apps generate different token audiences per distribution (debug, release, etc.). You can add the ID of your current distribution to the additional_id_token_audiences field. Example: sh.ory.network-example-ios.debug.
  3. Generate a random value that you can use as a nonce.
  4. Obtain an id_token from Apple using the Apple SDK. Make sure to also submit the nonce.
  5. Submit the id_token and nonce (as the id_token_nonce) as part of the updateRegistrationFlow or updateLoginFlow request to Ory.
  6. Ory will validate the id_token and create an identity and optionally a session (if configured).

The id_token is verified using Apple's publicly available signing keys, available under https://appleid.apple.com/auth/keys.

The id_token issued by Apple only contains the user's email address. You can submit additional claims to Ory as part of the updateRegistrationFlow request, as traits.

info

As Ory does not communicate directly with Apple during this flow, it does not have access to the Access & Refresh Tokens. This means that Ory cannot return these in the admin APIs or SDK. If you need these tokens, you can exchange the authorization_code returned by Apple on the device manually.

apple-social-sign-in-react-native.tsx
import { FrontendApi } from "@ory/client"
import * as AppleAuthentication from "expo-apple-authentication"
import * as Crypto from "expo-crypto"

async function signInWithApplePayload(): Promise<{
  id_token: string
  id_token_nonce: string
  traits: Record<string, unknown>
}> {
  const digest = await Crypto.digestStringAsync(
    Crypto.CryptoDigestAlgorithm.SHA256,
    Crypto.getRandomBytes(16).toString(),
  )
  let credential: AppleAuthentication.AppleAuthenticationCredential
  try {
    credential = await AppleAuthentication.signInAsync({
      requestedScopes: [
        AppleAuthentication.AppleAuthenticationScope.EMAIL,
        AppleAuthentication.AppleAuthenticationScope.FULL_NAME,
      ],
      nonce: digest,
    })
  } catch (e) {
    console.error("Couldn't sign in with Apple: ", e)
    throw e
  }

  return {
    id_token: credential.identityToken || "",
    id_token_nonce: digest,
    traits: {
      name: {
        first: credential.fullName?.givenName || "given name",
        last: credential.fullName?.familyName || "last name",
      },
    },
  }
}

export async function signInWithApple(sdk: FrontendApi, flowId: string) {
  const payload = await signInWithApplePayload()
  return sdk.updateLoginFlow({
    flow: flowId,
    updateLoginFlowBody: {
      method: "oidc",
      provider: "apple",
      ...payload,
    },
  })
}

export async function registerWithApple(sdk: FrontendApi, flowId: string) {
  const payload = await signInWithApplePayload()
  return sdk.updateRegistrationFlow({
    flow: flowId,
    updateRegistrationFlowBody: {
      method: "oidc",
      provider: "apple",
      ...payload,
    },
  })
}

Troubleshooting​

When you add a social sign-in provider, you can encounter common problems such as:

  • Redirect URI mismatch
  • Redirect loops during registration
  • Domain verification issues

To troubleshoot those issues, read Social sign-in troubleshooting.

Error: token audience didn't match allowed audiences​

Make sure to either add your apps current identifier to the additional_id_token_audiences field or set it as the Client ID of the provider in the Ory Console.

Ory Network

The most flexible and scalable way to manage identi­ties, authen­tication, autho­rization and access control.Explore Ory Network

Explore Ory Network