microsoft.graph.agreementFile

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-graph/json-schema/microsoft-graph-microsoft-graph-agreement-file-schema.json",
  "title": "microsoft.graph.agreementFile",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-graph-agreements-agreementfile-api-openapi.yml#/components/schemas/microsoft.graph.agreementFile",
  "allOf": [
    {
      "$ref": "#/$defs/microsoft.graph.agreementFileProperties"
    },
    {
      "title": "agreementFile",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "localizations": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/microsoft.graph.agreementFileLocalization"
          },
          "description": "The localized version of the terms of use agreement files attached to the agreement.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.agreementFile",
  "$defs": {
    "microsoft.graph.agreementFileData": {
      "title": "agreementFileData",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "data": {
          "type": [
            "string",
            "null"
          ],
          "description": "Data that represents the terms of use PDF document. Read-only.",
          "format": "base64url"
        },
        "@odata.type": {
          "type": "string"
        }
      }
    },
    "microsoft.graph.agreementFileLocalization": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.agreementFileProperties"
        },
        {
          "title": "agreementFileLocalization",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "versions": {
              "type": "array",
              "items": {
                "$ref": "#/$defs/microsoft.graph.agreementFileVersion"
              },
              "description": "Read-only. Customized versions of the terms of use agreement in the Microsoft Entra tenant.",
              "x-ms-navigationProperty": true
            },
            "@odata.type": {
              "type": "string"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.agreementFileLocalization"
    },
    "microsoft.graph.agreementFileProperties": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.entity"
        },
        {
          "title": "agreementFileProperties",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "createdDateTime": {
              "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",
                "null"
              ],
              "description": "The date time representing when the file was created. 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.",
              "format": "date-time"
            },
            "displayName": {
              "type": [
                "string",
                "null"
              ],
              "description": "Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement."
            },
            "fileData": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.agreementFileData"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "Data that represents the terms of use PDF document. Read-only."
            },
            "fileName": {
              "type": [
                "string",
                "null"
              ],
              "description": "Name of the agreement file (for example, TOU.pdf). Read-only."
            },
            "isDefault": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only."
            },
            "isMajorVersion": {
              "type": [
                "boolean",
                "null"
              ],
              "description": "Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language."
            },
            "language": {
              "type": [
                "string",
                "null"
              ],
              "description": "The language of the agreement file in the format 'languagecode2-country/regioncode2'. 'languagecode2' is a lowercase two-letter code derived from ISO 639-1, while 'country/regioncode2' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only."
            },
            "@odata.type": {
              "type": "string"
            }
          }
        }
      ]
    },
    "microsoft.graph.agreementFileVersion": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.agreementFileProperties"
        },
        {
          "title": "agreementFileVersion",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "@odata.type": {
              "type": "string"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.agreementFileVersion"
    },
    "microsoft.graph.entity": {
      "title": "entity",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "id": {
          "type": "string",
          "description": "The unique identifier for an entity. Read-only."
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  }
}