KeyCredential

A Windows Hello key credential

DesktopOperating SystemUWPWin32Windows

Properties

Name Type Description
accountId string Account identifier
publicKey string Base64-encoded public key (COSE format)
status string Credential operation status
keyName string Key name
View JSON Schema on GitHub

JSON Schema

microsoft-windows-10-keycredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyCredential",
  "title": "KeyCredential",
  "type": "object",
  "description": "A Windows Hello key credential",
  "properties": {
    "accountId": {
      "type": "string",
      "description": "Account identifier"
    },
    "publicKey": {
      "type": "string",
      "format": "byte",
      "description": "Base64-encoded public key (COSE format)"
    },
    "status": {
      "type": "string",
      "enum": [
        "Success",
        "UserCanceled",
        "NotFound",
        "UserPrefersPassword",
        "CredentialAlreadyExists"
      ],
      "description": "Credential operation status"
    },
    "keyName": {
      "type": "string",
      "description": "Key name"
    }
  },
  "required": [
    "accountId",
    "status"
  ]
}