TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-04-19 08:01:32 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update external-login.mdx according to api spec (#9058)

Browse Source 
# Which Problems Are Solved

Documentation update

# Additional Context

The guide is outdate, a few fields from the given example confuse and
must be update according to the api spec:
https://zitadel.com/docs/apis/resources/user_service_v2/user-service-add-human-user

---------

Co-authored-by: Livio Spring <livio.a@gmail.com>
This commit is contained in:
Denis Dvornikov 2025-01-10 11:30:26 +01:00 committed by GitHub
parent af09e51b1e
commit b0bcb051fc
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -152,7 +152,7 @@ curl --request POST \
If you didn't get a user ID in the parameters of your success page, you know that there is no existing user in ZITADEL with that provider, and you can register a new user or link it to an existing account (read the next section). If you didn't get a user ID in the parameters of your success page, you know that there is no existing user in ZITADEL with that provider, and you can register a new user or link it to an existing account (read the next section).
Fill the IdP links in the create user request to add a user with an external login provider. Fill the IdP links in the create user request to add a user with an external login provider.
The idpId is the ID of the provider in ZITADEL, the idpExternalId is the ID of the user in the external identity provider; usually, this is sent in the “sub”. The idpId is the ID of the provider in ZITADEL, the userId is the ID of the user in the external identity provider; usually, this is sent in the “sub”.
The display name is used to list the linkings on the users. 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)
@ -181,8 +181,8 @@ curl --request POST \
"idpLinks": [ "idpLinks": [
{ {
"idpId": "218528353504723201", "idpId": "218528353504723201",
"idpExternalId": "111392805975715856637", "userId": "111392805975715856637",
"displayName": "Minnie Mouse" "userName": "Minnie Mouse"
} }
] ]
}' }'
@ -205,8 +205,8 @@ curl --request POST \
--data '{ --data '{
"idpLink": { "idpLink": {
"idpId": "218528353504723201", "idpId": "218528353504723201",
"idpExternalId": "1113928059757158566371", "userId": "1113928059757158566371",
"displayName": "Minnie Mouse" "userName": "Minnie Mouse"
} }
}' }'
``` ```