TheArchive/zitadel
1
0
Fork 0
mirror of https://github.com/zitadel/zitadel.git synced 2025-03-01 01:27:24 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: update passkey usage in session api (#6386)

Browse Source 
Co-authored-by: Stefan Benz <46600784+stebenz@users.noreply.github.com>
This commit is contained in:
Livio Spring 2023-08-19 08:26:51 +02:00 committed by GitHub
parent 69b49ac0ed
commit aa2d547eb2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
docs/docs/guides/integrate/login-ui/passkey.mdx
View File

@ -212,7 +212,7 @@ Next step is to authenticate the user with the new registered passkey.
### Create Session ### Create Session
First step is to ask the user for his username and create a new session with the ZITADEL API. First step is to ask the user for his username and create a new session with the ZITADEL API.
When creating the new session make sure to include the challenge for passkey. When creating the new session make sure to include the challenge for passkey, resp. webAuthN with a required user verification and the domain of your login UI.
The response will include the public key credential request options for the passkey in the challenges. The response will include the public key credential request options for the passkey in the challenges.
More detailed information about the API: [Create Session Documentation](/apis/resources/session_service/session-service-create-session) More detailed information about the API: [Create Session Documentation](/apis/resources/session_service/session-service-create-session)
@ -231,9 +231,12 @@ curl --request POST \
} }
}, },
"metadata": {}, "metadata": {},
"challenges": [ "challenges": {
"CHALLENGE_KIND_PASSKEY" "webAuthN": {
] "domain": "example.domain.com",
"userVerificationRequirement": "USER_VERIFICATION_REQUIREMENT_REQUIRED"
}
}
}' }'
``` ```
@ -248,7 +251,7 @@ Example Response:
"sessionId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a", "sessionId": "d654e6ba-70a3-48ef-a95d-37c8d8a7901a",
"sessionToken": "string", "sessionToken": "string",
"challenges": { "challenges": {
"passkey": { "webAuthN": {
"publicKeyCredentialRequestOptions": { "publicKeyCredentialRequestOptions": {
"publicKey": { "publicKey": {
"allowCredentials": [ "allowCredentials": [
@ -274,7 +277,7 @@ After starting the passkey authentication on the side of ZITADEL you have to cha
To do this you need to call the browser API to get the credentials. To do this you need to call the browser API to get the credentials.
Make sure to send the public key credential request options you got from ZITADEL. Make sure to send the public key credential request options you got from ZITADEL.
```bash ```javascript
const credential = await navigator.credentials.get({ const credential = await navigator.credentials.get({
publicKey: publicKeyCredentialRequestOptions publicKey: publicKeyCredentialRequestOptions
}); });
@ -300,7 +303,7 @@ curl --request PATCH \
--data '{ --data '{
"sessionToken": "yMDi6uVPJAcphbbz0LaxC07ihWkNTe7m0Xqch8SzfM5Cz3HSIQIDZ65x1f5Qal0jxz0MEyo-_zYcUg", "sessionToken": "yMDi6uVPJAcphbbz0LaxC07ihWkNTe7m0Xqch8SzfM5Cz3HSIQIDZ65x1f5Qal0jxz0MEyo-_zYcUg",
"checks": { "checks": {
"passkey": { "webAuthN": {
"credentialAssertionData": {} "credentialAssertionData": {}
} }
} }