Passkeys
Rename a passkey
Updates the display name of a passkey credential to help users identify their authenticators. Only the display name can be modified.
patch/api/v1/webauthn/credentials/{credential_id}
Path parameters
credential_idstring required
The credential ID to update
Request body
Example request
{
"display_name": "My iPhone 15 Pro"
}Response
Passkey successfully updated with new name
Example response
{
"credential": {
"attestation_type": "direct",
"authenticator": {
"attachment": "platform",
"name": "Apple Touch ID"
},
"client_info": {
"city": "San Francisco",
"ip": "192.0.2.1",
"region": "US",
"region_subdivision": "CA"
},
"created_at": "2025-02-15T06:23:44.560000Z",
"display_name": "My Yubikey",
"id": "cred_abc123",
"updated_at": "2025-02-15T06:23:44.560000Z",
"user_agent": {
"browser": "Chrome",
"browser_version": "120.0.6099.129",
"device_model": "iPhone15,2",
"device_type": "mobile",
"os": "macOS",
"os_version": "14.2"
},
"user_id": "user_xyz789"
}
}