Microsoft Graph · Schema

passwordCredential

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks

Properties

Name Type Description
customKeyIdentifier string Do not use.
displayName string Friendly name for the password. Optional.
endDateTime string The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.
hint string Contains the first three characters of the password. Read-only.
keyId string The unique identifier for the password.
secretText string Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPasswo
startDateTime string The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014
@odata.type string
View JSON Schema on GitHub

JSON Schema

microsoft-graph-microsoftgraphpasswordcredential-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/microsoft.graph.passwordCredential",
  "title": "passwordCredential",
  "required": [
    "@odata.type"
  ],
  "type": "object",
  "properties": {
    "customKeyIdentifier": {
      "type": "string",
      "description": "Do not use.",
      "format": "base64url",
      "nullable": true
    },
    "displayName": {
      "type": "string",
      "description": "Friendly name for the password. Optional.",
      "nullable": true
    },
    "endDateTime": {
      "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
      "type": "string",
      "description": "The date and time at which the password expires represented using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.",
      "format": "date-time",
      "nullable": true
    },
    "hint": {
      "type": "string",
      "description": "Contains the first three characters of the password. Read-only.",
      "nullable": true
    },
    "keyId": {
      "pattern": "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$",
      "type": "string",
      "description": "The unique identifier for the password.",
      "format": "uuid",
      "nullable": true
    },
    "secretText": {
      "type": "string",
      "description": "Read-only; Contains the strong passwords generated by Microsoft Entra ID that are 16-64 characters in length. The generated password value is only returned during the initial POST request to addPassword. There is no way to retrieve this password in the future.",
      "nullable": true
    },
    "startDateTime": {
      "pattern": "^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$",
      "type": "string",
      "description": "The date and time at which the password becomes valid. The Timestamp type represents date and time information using ISO 8601 format and is always in UTC time. For example, midnight UTC on Jan 1, 2014 is 2014-01-01T00:00:00Z. Optional.",
      "format": "date-time",
      "nullable": true
    },
    "@odata.type": {
      "type": "string"
    }
  }
}