Get credentials

Get registered WebAuthn (passwordless authentication) credentials of authenticated account

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

Response parameters

Parameter Type Description
credentials list List of credentials
friendly_name str Name of credential
device_type str Type of credential
backed_up int Credential backed up (1) or not (0)

Example request (Python)

import requests
import json
from pprint import pprint

url = "https://example.domain.tld/api/v1/webauthn/credentials/"
r = requests.get(url, auth=("masteradmin2","long-auth_token-here"))
try:
    pprint(r.json())
except:
    print(r.text)

Example response (JSON)

credentials: [
    {
        "backed_up": 0,
        "device_type": "single_device",
        "friendly_name": "Windows Hello"
    },
    {
        "backed_up": 0,
        "device_type": "single_device",
        "friendly_name": "Yubikey Primary"
    },
    {
        "backed_up": 1,
        "device_type": "multi_device",
        "friendly_name": "Android passkey"
    }
]