Update credential

Update registered WebAuthn (passwordless authentication) credential of authenticated account

  • HTTP Method: PUT
  • URL: https://example.domain.tld/api/v1/webauthn/credentials/
  • Require authentication: Yes
  • Permission level required: MasterAdmin / DomainAdmin / MailUser

Request parameters

Parameter Type Description Required
new_friendly_name str New name of credential Required
old_friendly_name str Old name of credential Required

Response parameters

Parameter Type Description
new_friendly_name str New name of credential

Example request (Python)

import requests
import json
from pprint import pprint

data = {
    "new_friendly_name": "PC Windows Hello",
    "old_friendly_name": "Windows Hello",
}
url = "https://example.domain.tld/api/v1/webauthn/credentials/"
r = requests.put(url, json=data, auth=("masteradmin2","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)

{
    "new_friendly_name": "PC Windows Hello"
}