KeyCredential

Contains a key credential (certificate) associated with an application or service principal.

AuthenticationAuthorizationIdentityMicrosoftMicrosoft EntraOAuthOpenID ConnectSAMLSCIMSingle Sign-OnZero Trust

Properties

Name Type Description
customKeyIdentifier stringnull Custom key identifier.
displayName stringnull
endDateTime string The date and time at which the credential expires.
key stringnull The certificate raw data in byte array converted to Base64 string.
keyId string
startDateTime string
type string The type of key credential (e.g., AsymmetricX509Cert).
usage string Describes the purpose of the key. Valid values are Verify and Sign.
View JSON Schema on GitHub

JSON Schema

microsoft-azure-active-directory-keycredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/KeyCredential",
  "title": "KeyCredential",
  "type": "object",
  "description": "Contains a key credential (certificate) associated with an application or service principal.",
  "properties": {
    "customKeyIdentifier": {
      "type": [
        "string",
        "null"
      ],
      "description": "Custom key identifier.",
      "example": "example_value"
    },
    "displayName": {
      "type": [
        "string",
        "null"
      ],
      "example": "example_value"
    },
    "endDateTime": {
      "type": "string",
      "format": "date-time",
      "description": "The date and time at which the credential expires.",
      "example": "2026-01-15T10:30:00Z"
    },
    "key": {
      "type": [
        "string",
        "null"
      ],
      "format": "byte",
      "description": "The certificate raw data in byte array converted to Base64 string.",
      "example": "example_value"
    },
    "keyId": {
      "type": "string",
      "format": "uuid",
      "example": "500123"
    },
    "startDateTime": {
      "type": "string",
      "format": "date-time",
      "example": "2026-01-15T10:30:00Z"
    },
    "type": {
      "type": "string",
      "description": "The type of key credential (e.g., AsymmetricX509Cert).",
      "example": "example_value"
    },
    "usage": {
      "type": "string",
      "description": "Describes the purpose of the key. Valid values are Verify and Sign.",
      "enum": [
        "Sign",
        "Verify"
      ],
      "example": "Sign"
    }
  }
}