Updates a Passkey or WebAuthn registration.
Update WebAuthn registration
PUT
https://test.stytch.com/v1/webauthn/{webauthn_registration_id}Path parameters
webauthn_registration_id* string
Globally unique UUID that identifies a Passkey or WebAuthn registration in the Stytch API. The webauthn_registration_id is used when you need to operate on a specific User's WebAuthn registration.
Body parameters
name string
The name of the WebAuthn registration or Passkey.
Response fields
status_code int
The HTTP status code of the response. Stytch follows standard HTTP response status code patterns, e.g. 2XX values equate to success, 3XX values are redirects, 4XX are client errors, and 5XX are server errors.
request_id string
Globally unique UUID that is returned with every API call. This value is important to log for debugging purposes; we may ask for this value to help identify a specific API call when helping you debug an issue.
webauthn_registration object
A Passkey or WebAuthn registration.
webauthn_registration_id string
The unique ID for the Passkey or WebAuthn registration.
domain string
The domain on which Passkey or WebAuthn registration was started. This will be the domain of your app.
user_agent string
The user agent of the User.
authenticator_type string
The authenticator_type string displays the requested authenticator type of the Passkey or WebAuthn device. The two valid types are "platform" and "cross-platform". If no value is present, the Passkey or WebAuthn device was created without an authenticator type preference.
verified boolean
The verified boolean denotes whether or not this send method, e.g. phone number, email address, etc., has been successfully authenticated by the User.
name string
The name of the Passkey or WebAuthn registration.
const stytch = require('stytch');
const client = new stytch.Client({
project_id: 'PROJECT_ID',
secret: 'SECRET',
});
const params = {
webauthn_registration_id: "webauthn-registration-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6",
name: "Google Passkey",
};
client.webauthn.update(params)
.then(resp => { console.log(resp) })
.catch(err => { console.log(err) });RESPONSE 200
200
{
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"webauthn_registration": {
"webauthn_registration_id": "webauthn-registration-test-5c44cc6a-8af7-48d6-8da7-ea821342f5a6",
"domain": "example.com",
"user_agent": "Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/51.0.2704.103 Safari/537.36",
"authenticator_type": "platform",
"verified": true,
"name": "Google Passkey"
}
}RESPONSE 404
200
{
"status_code": 404,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "webauthn_registration_not_found",
"error_message": "WebAuthn registration could not be found.",
"error_url": "https://stytch.com/docs/api/errors/404"
}RESPONSE 429
200
{
"status_code": 429,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "too_many_requests",
"error_message": "Too many requests have been made.",
"error_url": "https://stytch.com/docs/api/errors/429"
}RESPONSE 500
200
{
"status_code": 500,
"request_id": "request-id-test-b05c992f-ebdc-489d-a754-c7e70ba13141",
"error_type": "internal_server_error",
"error_message": "Oops, something seems to have gone wrong, please reach out to support@stytch.com to let us know what went wrong.",
"error_url": "https://stytch.com/docs/api/errors/500"
}