Hanzo
OpenapiIam

Renames a registered passkey or security key, so a person can tell their…

Renames a registered passkey or security key, so a person can tell their devices apart.

POST /v1/iam/webauthn-credentials/update

Addresshttps://api.hanzo.ai/v1/iam/webauthn-credentials/update
MethodPOST
OperationupdateWebauthnCredential
AuthAuthorization: Bearer $HANZO_API_KEY

Renames a registered passkey or security key, so a person can tell their devices apart.

A credential that is not there answers "nothing changed" rather than an error, so the call is safe to repeat.

Request

21 fields, body application/json (required).

FieldInTypeRequiredDescription
aaguidbodystring
attachmentbodystring
attestationFormatbodystringAttestationFormat is the statement format the authenticator attested in ("packed", "apple", "none", …), which is a DIFFERENT value from the attestation type…
attestationTypebodystring
backupEligiblebodyboolean
backupStatebodyboolean
cloneWarningbodyboolean
createdAtbodystring (date-time)
createdTimebodystring
credentialIdbodystring
deletedbodyboolean
idbodystring
namebodystring
ownerbodystring
publicKeybodystring
signCountbodyinteger
transportbodystring[]
updatedAtbodystring (date-time)
userbodystring
userPresentbodyboolean
userVerifiedbodyboolean

Response

StatusBodyMeaning
200iam.webauthnCredentialMutationResultok

200 body — 23 fields.

FieldInTypeAlwaysDescription
affectedbodyboolean
webauthnCredentialbodyiam.WebauthnCredential
webauthnCredential.aaguidbodystring
webauthnCredential.attachmentbodystring
webauthnCredential.attestationFormatbodystringAttestationFormat is the statement format the authenticator attested in ("packed", "apple", "none", …), which is a DIFFERENT value from the attestation type…
webauthnCredential.attestationTypebodystring
webauthnCredential.backupEligiblebodyboolean
webauthnCredential.backupStatebodyboolean
webauthnCredential.cloneWarningbodyboolean
webauthnCredential.createdAtbodystring (date-time)
webauthnCredential.createdTimebodystring
webauthnCredential.credentialIdbodystring
webauthnCredential.deletedbodyboolean
webauthnCredential.idbodystring
webauthnCredential.namebodystring
webauthnCredential.ownerbodystring
webauthnCredential.publicKeybodystring
webauthnCredential.signCountbodyinteger
webauthnCredential.transportbodystring[]
webauthnCredential.updatedAtbodystring (date-time)
webauthnCredential.userbodystring
webauthnCredential.userPresentbodyboolean
webauthnCredential.userVerifiedbodyboolean

Failure carries the platform error shape — see Errors.

Examples

hanzo iam webauthn-credentials update

IAM API · All Hanzo APIs · Interactive reference

How is this guide?

On this page