TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-08-11 22:57:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve readability of idps callback (#9793)

Browse Source 
This PR improves the readability of the difference in the IDP callback
of the new V2 login compared to the legacy login.
This commit is contained in:
Max Peintner
2025-04-24 09:01:01 +02:00
committed by GitHub
parent 8d28e727e1
commit 44651b6e8d
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
docs/docs/guides/integrate/login-ui/external-login.mdx
View File

@@ -16,6 +16,7 @@ ZITADEL will handle as much as possible from the authentication flow with the ex
This requires you to initiate the flow with your desired provider. This requires you to initiate the flow with your desired provider.
Send the following two URLs in the request body: Send the following two URLs in the request body:
1. SuccessURL: Page that should be shown when the login was successful 1. SuccessURL: Page that should be shown when the login was successful
2. ErrorURL: Page that should be shown when an error happens during the authentication 2. ErrorURL: Page that should be shown when an error happens during the authentication
@@ -63,6 +64,10 @@ https://accounts.google.com/o/oauth2/v2/auth?client_id=Test&prompt=select_accoun
After the user has successfully authenticated, a redirect to the ZITADEL backend /idps/callback will automatically be performed. After the user has successfully authenticated, a redirect to the ZITADEL backend /idps/callback will automatically be performed.
:::warning
Note that the redirect URL is `https://{YOUR-DOMAIN}/idps/callback` when using the new V2 hosted login compared to the V1 hosted login, which was `https://{YOUR-DOMAIN}/ui/login/login/externalidp/callback`.
:::
## Get Provider Information ## Get Provider Information
ZITADEL will take the information of the provider. After this, a redirect will be made to either the success page in case of a successful login or to the error page in case of a failure will be performed. In the parameters, you will provide the IDP intentID, a token, and optionally, if a user could be found, a user ID. ZITADEL will take the information of the provider. After this, a redirect will be made to either the success page in case of a successful login or to the error page in case of a failure will be performed. In the parameters, you will provide the IDP intentID, a token, and optionally, if a user could be found, a user ID.
@@ -71,6 +76,7 @@ To get the information of the provider, make a request to ZITADEL.
[Retrieve Identity Provider Intent Documentation](/docs/apis/resources/user_service_v2/user-service-retrieve-identity-provider-intent) [Retrieve Identity Provider Intent Documentation](/docs/apis/resources/user_service_v2/user-service-retrieve-identity-provider-intent)
### Request ### Request
```bash ```bash
curl --request POST \ curl --request POST \
--url https://$ZITADEL_DOMAIN/v2/idp_intents/$INTENT_ID \ --url https://$ZITADEL_DOMAIN/v2/idp_intents/$INTENT_ID \
@@ -115,7 +121,9 @@ curl --request POST \
``` ```
## Handle Provider Information ## Handle Provider Information
After successfully authenticating using your identity provider, you have three possible options. After successfully authenticating using your identity provider, you have three possible options.
1. Login 1. Login
2. Register user 2. Register user
3. Add social login to existing user 3. Add social login to existing user
@@ -127,6 +135,7 @@ Create a new session and include the IDP intent ID and the token in the checks.
This check requires that the previous step ended on the successful page and didn't’t result in an error. This check requires that the previous step ended on the successful page and didn't’t result in an error.
#### Request #### Request
```bash ```bash
curl --request POST \ curl --request POST \
--url https://$ZITADEL_DOMAIN/v2/sessions \ --url https://$ZITADEL_DOMAIN/v2/sessions \
@@ -158,6 +167,7 @@ The display name is used to list the linkings on the users.
[Create User API Documentation](/docs/apis/resources/user_service_v2/user-service-add-human-user) [Create User API Documentation](/docs/apis/resources/user_service_v2/user-service-add-human-user)
#### Request #### Request
```bash ```bash
curl --request POST \ curl --request POST \
--url https://$ZITADEL_DOMAIN/v2/users/human \ --url https://$ZITADEL_DOMAIN/v2/users/human \
@@ -196,6 +206,7 @@ If you want to link/connect to an existing account you can perform the add ident
[Add IDP Link to existing user documentation](/docs/apis/resources/user_service_v2/user-service-add-idp-link) [Add IDP Link to existing user documentation](/docs/apis/resources/user_service_v2/user-service-add-idp-link)
#### Request #### Request
```bash ```bash
curl --request POST \ curl --request POST \
--url https://$ZITADEL_DOMAIN/v2/users/users/218385419895570689/links \ --url https://$ZITADEL_DOMAIN/v2/users/users/218385419895570689/links \