Skip to content

Add documentation for the passkey credential delete endpoint #19044

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
InfiniteSyntax wants to merge 1 commit into
base: main
Choose a base branch
from
+19 −0
Open

Add documentation for the passkey credential delete endpoint #19044

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions docs/modules/ROOT/pages/servlet/authentication/passkeys.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -399,3 +399,22 @@ HTTP/1.1 200 OK
HTTP/1.1 401 OK

----

[[passkeys-delete]]
== Delete a Credential

A credential can be deleted by making a request to `DELETE /webauthn/register/{id}` where the `id` path variable is the base64url encoded unique id of the credential.

[NOTE]
====
Spring Security uses an AuthorizationManager to authorize credential deletion. When using javadoc:org.springframework.security.config.annotation.web.configurers.WebAuthnConfigurer[] this defaults to javadoc:org.springframework.security.web.webauthn.management.CredentialRecordOwnerAuthorizationManager[]. It checks if a user is currently authenticted and if the authenticted user is the owner of the requested credential.
====

.Example Deletion Request
[source,http]
----
DELETE /webauthn/register/dYF7EGnRFFIXkpXi9XU2wg
X-CSRF-TOKEN: 4bfd1575-3ad1-4d21-96c7-4ef2d9f86721
----

The request above will delete the credential with the id `dYF7EGnRFFIXkpXi9XU2wg`.