Apple sign-in with Embedded Wallets

Sign in with Apple lets users authenticate with their Apple Account. Choose the default connection for the quickest setup, or configure a custom connection when you need your own Apple credentials, consent screen, or identity provider.

Default Apple sign-in

The default connection uses the Apple OAuth credentials managed by Embedded Wallets. You don't need an Apple Developer account or an Apple Services ID.

Caveats

• The Apple consent screen identifies the OAuth application managed by Embedded Wallets, not your dapp.
• You can't change the Apple application configuration, such as its scopes or branding, because you don't own the credentials.
• Apple scopes its user identifier to the developer team that owns the credentials. The same person receives a different identifier on the default connection and on a connection that uses your own Apple credentials. See Receiving a user's identity token.
• The default connection and a custom connection are separate connections, so they produce different wallet addresses for the same person. You can't reconcile them later, because the default Apple connection can't join a group connection.

Configure the default connection

1. Open your project in the MetaMask Developer Dashboard.
2. Select Social Connections.
3. Enable Apple.

The SDK reads the connection from the dashboard. You don't need to add Apple credentials to your SDK configuration.

Custom Apple sign-in

Use a custom connection when the Apple authorization belongs to your dapp or an identity platform you control. Your Apple credentials sit in an identity provider such as Auth0, Firebase, or Amazon Cognito, or in your own backend. That service runs Sign in with Apple and issues an ID token, which Embedded Wallets validates through a custom connection.

Apple credentials can't go in the dashboard

Google, Discord, and Twitch connections take only a client ID, because they accept https://auth.web3auth.io/auth as a redirect URI for a public client. Apple can't work that way: its token exchange requires a client secret signed with your private key, and a Services ID can only return to domains you verify.

Preserve wallet addresses

Decide between the default and a custom connection before you onboard users. Moving from the default Apple connection to Auth0, Firebase, Amazon Cognito, or your own JWT connection changes every user's wallet address, and a group connection can't merge the two, because the default Apple connection can't be grouped.

Auth0

Auth0 can host the Apple authorization flow and either redirect through Embedded Wallets (implicit flow) or provide an ID token to your dapp (JWT flow).

1. Configure Sign in with Apple in Auth0. Apple requires an App ID, Services ID, Team ID, Key ID, and private signing key.
2. Enable the Apple social connection for your Auth0 application.
3. Create an Auth0 connection in the MetaMask Developer Dashboard.
4. For an implicit flow, call Embedded Wallets with the Auth0 connection ID and set the Auth0 connection name to apple.
5. For a JWT flow, authenticate with the Auth0 SDK, retrieve its raw ID token, and pass that token to Embedded Wallets.

Use sub as the user identifier unless your identity architecture deliberately normalizes a different stable claim.

Firebase Authentication

Firebase handles Apple authorization and returns a Firebase ID token. Embedded Wallets validates that token through a Firebase custom connection.

1. Enable Apple authentication in Firebase.
2. Create a Firebase connection in the MetaMask Developer Dashboard.
3. Sign the user in with the Firebase SDK and obtain a fresh Firebase ID token.
4. Pass the Firebase ID token and your Firebase connection ID to Embedded Wallets using the JWT flow.

Amazon Cognito

Amazon Cognito can federate Apple accounts into a user pool and issue Cognito ID tokens.

1. Configure Apple as a social identity provider in Amazon Cognito.
2. Map a stable Apple claim to the Cognito user attribute you use as the user identifier.
3. Create an Amazon Cognito connection in the MetaMask Developer Dashboard.
4. Authenticate through Cognito, obtain a fresh Cognito ID token, and pass it to Embedded Wallets using the JWT flow.

Your own backend

Use this flow when your backend owns user records and token issuance.

1. Implement Sign in with Apple in your client and send the Apple authorization result to your backend.
2. Validate the Apple ID token against Apple's OpenID Connect configuration. Validate its signature, issuer, audience, expiry, and nonce before trusting the identity.
3. Resolve the Apple subject to your own stable user ID.
4. Issue a fresh JWT with an iat no more than 60 seconds old and expose the signing public key through a JSON Web Key Set (JWKS) endpoint.
5. Create a custom JWT connection that validates your issuer, audience, JWKS, and user identifier.
6. Pass your JWT and custom connection ID to Embedded Wallets.

Don't send an Apple private signing key, Auth0 client secret, or your backend JWT signing key to a client application.

Group Apple connections

A group connection gives the same person one wallet address across several login methods, for example Apple and Google.

Apple can't be grouped directly

You can't add the default Apple social connection to a group. Group Apple through an Auth0 connection that runs Sign in with Apple, and set the Auth0 connection's JWT user identifier to email.

The identifier must be email because grouping links accounts that resolve to the same identifier value. Apple's sub is scoped to the Apple developer team that issued it, so it never matches the identifier any other connection returns. The email address is the only claim that can match across providers.

This puts two requirements on your setup:

• Every connection in the group must use email as its user identifier.
• Apple must return an email address that matches the one the other providers return. A user who selects Hide My Email gets a private relay address, which won't match their Google or passwordless email, so they receive a separate wallet. Test this case before you onboard users.

Pass both the child connection ID and grouped connection ID when you bypass the modal:

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<APPLE_AUTH_CONNECTION_ID>',
  groupedAuthConnectionId: '<GROUPED_AUTH_CONNECTION_ID>',
  idToken,
})

Usage examples

The implicit examples open an Apple or Auth0 authorization flow. The JWT examples assume your Auth0, Firebase, Cognito, or backend integration has already returned a fresh ID token.

Default implicit flow

React

import { AUTH_CONNECTION, WALLET_CONNECTORS } from '@web3auth/modal'
import { useWeb3AuthConnect } from '@web3auth/modal/react'

const { connectTo } = useWeb3AuthConnect()

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.APPLE,
})

Vue

import { AUTH_CONNECTION, WALLET_CONNECTORS } from '@web3auth/modal'
import { useWeb3AuthConnect } from '@web3auth/modal/vue'

const { connectTo } = useWeb3AuthConnect()

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.APPLE,
})

JavaScript

import { AUTH_CONNECTION, WALLET_CONNECTORS } from '@web3auth/modal'

await web3auth.connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.APPLE,
})

React Native

import { AUTH_CONNECTION, useWeb3AuthConnect } from '@web3auth/react-native-sdk'

const { connectTo } = useWeb3AuthConnect()

await connectTo({
  authConnection: AUTH_CONNECTION.APPLE,
})

Android

val response = web3Auth.connectTo(
  LoginParams(AuthConnection.APPLE)
)

iOS

let response = try await web3Auth.connectTo(
    loginParams: LoginParams(authConnection: .APPLE)
)

Flutter

final response = await Web3AuthFlutter.login(
  LoginParams(loginProvider: Provider.apple),
);

Unity

var options = new LoginParams
{
    loginProvider = Provider.APPLE
};

web3Auth.login(options);

Unreal Engine

FWeb3AuthLoginParams LoginParams;
LoginParams.LoginProvider = TEXT("apple");

UWeb3AuthSDK::GetInstance()->Login(LoginParams);

Auth0 implicit flow

These examples use the Auth0 custom connection configured for your SDK. Replace the connection ID and domain with your Auth0 values. For Android and iOS, add the connection to authConnectionConfig during initialization. Flutter, Unity, and Unreal Engine currently use their platform's loginConfig; configure it by following the custom authentication guide for Flutter, Unity, or Unreal Engine.

React

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<AUTH0_CONNECTION_ID>',
  extraLoginOptions: {
    connection: 'apple',
  },
})

Vue

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<AUTH0_CONNECTION_ID>',
  extraLoginOptions: {
    connection: 'apple',
  },
})

JavaScript

await web3auth.connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<AUTH0_CONNECTION_ID>',
  extraLoginOptions: {
    connection: 'apple',
  },
})

React Native

await connectTo({
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<AUTH0_CONNECTION_ID>',
  extraLoginOptions: {
    connection: 'apple',
  },
})

Android

val response = web3Auth.connectTo(
  LoginParams(
    authConnection = AuthConnection.CUSTOM,
    authConnectionId = "<AUTH0_CONNECTION_ID>",
    extraLoginOptions = ExtraLoginOptions(
      domain = "https://<AUTH0_DOMAIN>",
      connection = "apple"
    )
  )
)

iOS

let response = try await web3Auth.connectTo(
    loginParams: LoginParams(
        authConnection: .CUSTOM,
        authConnectionId: "<AUTH0_CONNECTION_ID>",
        extraLoginOptions: ExtraLoginOptions(
            domain: "https://<AUTH0_DOMAIN>",
            connection: "apple"
        )
    )
)

Flutter

final response = await Web3AuthFlutter.login(
  LoginParams(
    loginProvider: Provider.jwt,
    extraLoginOptions: ExtraLoginOptions(
      domain: 'https://<AUTH0_DOMAIN>',
      verifierIdField: 'sub',
      connection: 'apple',
    ),
  ),
);

Unity

var options = new LoginParams
{
    loginProvider = Provider.JWT,
    extraLoginOptions = new ExtraLoginOptions
    {
        domain = "https://<AUTH0_DOMAIN>",
        verifierIdField = "sub",
        connection = "apple"
    }
};

web3Auth.login(options);

Unreal Engine

The current Unreal Engine SDK documentation provides this flow through Blueprint configuration, not a verified C++ example. Configure the Auth0 connection by following the Unreal Engine custom authentication guide.

JWT flow

Obtain a fresh ID token from your identity aggregator or backend before calling Embedded Wallets. The token issuer and claims must match the custom connection in the dashboard.

React

const idToken = await getIdToken()

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<CUSTOM_CONNECTION_ID>',
  idToken,
})

Vue

const idToken = await getIdToken()

await connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<CUSTOM_CONNECTION_ID>',
  idToken,
})

JavaScript

const idToken = await getIdToken()

await web3auth.connectTo(WALLET_CONNECTORS.AUTH, {
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<CUSTOM_CONNECTION_ID>',
  idToken,
})

React Native

const idToken = await getIdToken()

await connectTo({
  authConnection: AUTH_CONNECTION.CUSTOM,
  authConnectionId: '<CUSTOM_CONNECTION_ID>',
  idToken,
})

Android

val response = web3Auth.connectTo(
  LoginParams(
    authConnection = AuthConnection.CUSTOM,
    authConnectionId = "<CUSTOM_CONNECTION_ID>",
    idToken = idToken
  )
)

iOS

let response = try await web3Auth.connectTo(
    loginParams: LoginParams(
        authConnection: .CUSTOM,
        authConnectionId: "<CUSTOM_CONNECTION_ID>",
        idToken: idToken
    )
)

Flutter

final response = await Web3AuthFlutter.login(
  LoginParams(
    loginProvider: Provider.jwt,
    extraLoginOptions: ExtraLoginOptions(
      id_token: idToken,
    ),
  ),
);

Unity

var options = new LoginParams
{
    loginProvider = Provider.JWT,
    extraLoginOptions = new ExtraLoginOptions
    {
        id_token = idToken
    }
};

web3Auth.login(options);

Unreal Engine

The current Unreal Engine SDK documentation doesn't provide a verified C++ JWT example. Configure the JWT connection and login in Blueprint by following the Unreal Engine custom authentication guide.

Node.js

const result = await web3auth.connect({
  authConnectionId: '<CUSTOM_CONNECTION_ID>',
  idToken,
})