mirror of
https://github.com/zitadel/zitadel.git
synced 2026-08-19 01:14:48 -05:00
cbf05dbe16
# Which Problems Are Solved - Apple Sign-In uses a Form Post method to return the authorization response, which ZITADEL handles at a specific endpoint ending in /form for the login v1. - The Console previously displayed the standard callback URL (without `/form`), causing confusion and configuration errors.. # How the Problems Are Solved - **Console**: Updated ProviderNextService to accept a suffix string . - **Console**: Updated ProviderAppleComponent to append the suffix to the urls. # Additional Changes - Updated `docs/docs/guides/integrate/identity-providers/apple.mdx` to explicitly state that the callback URL end with `/form` - Updated `docs/docs/guides/integrate/login-ui/external-login.mdx` to clarify the `/form` suffix requirement for Apple Sign-In in the hosted login documentation. # Additional Context - fixes #11438 --------- Co-authored-by: Ramon <mail@conblem.me> Co-authored-by: Florian Forster <florian@zitadel.com>
96 lines
4.0 KiB
Plaintext
96 lines
4.0 KiB
Plaintext
---
|
|
title: Set up Apple as an Identity Provider in ZITADEL
|
|
description: "Configure Apple as an OIDC identity provider in ZITADEL to allow your users to sign in with their Apple IDs."
|
|
sidebar_label: Apple
|
|
---
|
|
|
|
import GeneralConfigDescription from './_general_config_description.mdx';
|
|
import Intro from './_intro.mdx';
|
|
import CustomLoginPolicy from './_custom_login_policy.mdx';
|
|
import IDPsOverview from './_idps_overview.mdx';
|
|
import Activate from './_activate.mdx';
|
|
import TestSetup from './_test_setup.mdx';
|
|
|
|
<Intro components={props.components} provider="Apple"/>
|
|
|
|
## Open the Apple Identity Provider Template
|
|
|
|
<IDPsOverview components={props.components} templates="Apple"/>
|
|
|
|
Click on the ZITADEL Callback URL to copy it to your clipboard.
|
|
You will have to paste it in the Apple service later.
|
|
|
|
<Callout>
|
|
For Apple with V1 hosted login, the callback URL ends with `/form` (e.g., `${CUSTOM_DOMAIN}/ui/login/login/externalidp/callback/form`) because Apple uses a Form Post to return the authorization response.
|
|
|
|
For V2, use the standard callback URL `${CUSTOM_DOMAIN}/idps/callback`, which already accepts POST requests.
|
|
</Callout>
|
|
|
|
|
|
|
|
## Apple Configuration
|
|
|
|
### Register a new App
|
|
|
|
1. Go to the Identifiers of your Apple Developer Account
|
|
2. Click the add button "+" on the top left
|
|
3. Choose App IDs and click "continue"
|
|
4. Add a description and a unique identifier
|
|
5. Enable "Sign in with Apple" and click "continue"
|
|
|
|
### Register a new service
|
|
|
|
1. Go to the Identifiers of your Apple Developer Account: [https://developer.apple.com/account/resources/identifiers/list](https://developer.apple.com/account/resources/identifiers/list)
|
|
2. Click the add button "+" on the top left
|
|
3. Choose Services IDs and click "continue"
|
|
4. Add a description and a unique identifier and click "register"
|
|
5. Select your registered service from the list and enable sign in with Apple, then click "configure"
|
|
6. Choose the previously created App in the Primary App ID List
|
|
7. Add your Custom Domain in the domains and subdomains field
|
|
- Example domain for `https://acme-gzoe4x.zitadel.cloud` would look like this: `acme-gzoe4x.zitadel.cloud`
|
|
8. [Paste the ZITADEL Callback URL you copied before](#open-the-apple-identity-provider-template) to the Return URLs
|
|
|
|
|
|
|
|
### Register a new key
|
|
|
|
1. Go to the keys list of your Apple Developer Account: [https://developer.apple.com/account/resources/authkeys/list](https://developer.apple.com/account/resources/authkeys/list)
|
|
2. Click the add button "+" on the top left
|
|
3. Give your key a name
|
|
4. Enable "Sign in with Apple" and click configure
|
|
5. Choose your app from the list
|
|
6. Register the key and download it
|
|
|
|
## ZITADEL Setup
|
|
|
|
Go back [to the Apple provider template you opened before in ZITADEL](#open-the-apple-identity-provider-template).
|
|
|
|
1. Add the Client ID, this is [the identifier of the service you created in your Apple Account](#register-a-new-service)
|
|
2. Fill the Team ID, you can find it when you log in to your Apple Developer account, in your membership
|
|
3. Enter the [Key ID and upload the Private Key you created before](#register-a-new-key)
|
|
|
|
You can optionally configure the following settings.
|
|
A useful default will be filled if you don't change anything.
|
|
|
|
**Scopes**: The scopes define which scopes will be sent to the provider, `name` and `email` are prefilled. This information will be taken to create/update the user within ZITADEL.
|
|
|
|
<GeneralConfigDescription components={props.components} provider_account="Apple account" />
|
|
|
|
### Activate IdP
|
|
|
|
<Activate components={props.components} />
|
|
|
|
|
|
|
|
### Ensure your Login Policy allows External IDPs
|
|
|
|
<CustomLoginPolicy components={props.components} />
|
|
|
|
## Test the setup
|
|
|
|
<TestSetup components={props.components} loginscreen="your Apple login"/>
|
|
|
|
|
|
|
|
|