microsoft.graph.agreement

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-graph/json-schema/microsoft-graph-microsoft-graph-agreement-schema.json",
  "title": "microsoft.graph.agreement",
  "x-generated": "2026-11-04",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/microsoft-graph-agreements-agreement-api-openapi.yml#/components/schemas/microsoft.graph.agreement",
  "allOf": [
    {
      "$ref": "#/$defs/microsoft.graph.entity"
    },
    {
      "title": "agreement",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "displayName": {
          "type": [
            "string",
            "null"
          ],
          "description": "Display name of the agreement. The display name is used for internal tracking of the agreement but isn't shown to end users who view the agreement. Supports $filter (eq)."
        },
        "isPerDeviceAcceptanceRequired": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether end users are required to accept this agreement on every device that they access it from. The end user is required to register their device in Microsoft Entra ID, if they haven't already done so. Supports $filter (eq)."
        },
        "isViewingBeforeAcceptanceRequired": {
          "type": [
            "boolean",
            "null"
          ],
          "description": "Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq)."
        },
        "termsExpiration": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.termsExpiration"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Expiration schedule and frequency of agreement for all users. Supports $filter (eq)."
        },
        "userReacceptRequiredFrequency": {
          "pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
          "type": [
            "string",
            "null"
          ],
          "description": "The duration after which the user must reaccept the terms of use. The value is represented in ISO 8601 format for durations. Supports $filter (eq).",
          "format": "duration"
        },
        "acceptances": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/microsoft.graph.agreementAcceptance"
          },
          "description": "Read-only. Information about acceptances of this agreement.",
          "x-ms-navigationProperty": true
        },
        "file": {
          "anyOf": [
            {
              "$ref": "#/$defs/microsoft.graph.agreementFile"
            },
            {
              "type": [
                "object",
                "null"
              ]
            }
          ],
          "description": "Default PDF linked to this agreement.",
          "x-ms-navigationProperty": true
        },
        "files": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/microsoft.graph.agreementFileLocalization"
          },
          "description": "PDFs linked to this agreement. This property is in the process of being deprecated. Use the  file property instead. Supports $expand.",
          "x-ms-navigationProperty": true
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  ],
  "x-ms-discriminator-value": "#microsoft.graph.agreement",
  "$defs": {
    "microsoft.graph.agreementAcceptance": {
      "allOf": [
        {
          "$ref": "#/$defs/microsoft.graph.entity"
        },
        {
          "title": "agreementAcceptance",
          "required": [
            "@odata.type"
          ],
          "type": "object",
          "properties": {
            "agreementFileId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The identifier of the agreement file accepted by the user."
            },
            "agreementId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The identifier of the agreement."
            },
            "deviceDisplayName": {
              "type": [
                "string",
                "null"
              ],
              "description": "The display name of the device used for accepting the agreement."
            },
            "deviceId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values."
            },
            "deviceOSType": {
              "type": [
                "string",
                "null"
              ],
              "description": "The operating system used to accept the agreement."
            },
            "deviceOSVersion": {
              "type": [
                "string",
                "null"
              ],
              "description": "The operating system version of the device used to accept the agreement."
            },
            "expirationDateTime": {
              "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 expiration date time of the acceptance. 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. Supports $filter (eq, ge, le) and eq for null values.",
              "format": "date-time"
            },
            "recordedDateTime": {
              "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 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"
            },
            "state": {
              "anyOf": [
                {
                  "$ref": "#/$defs/microsoft.graph.agreementAcceptanceState"
                },
                {
                  "type": [
                    "object",
                    "null"
                  ]
                }
              ],
              "description": "The state of the agreement acceptance. The possible values are: accepted, declined. Supports $filter (eq)."
            },
            "userDisplayName": {
              "type": [
                "string",
                "null"
              ],
              "description": "Display name of the user when the acceptance was recorded."
            },
            "userEmail": {
              "type": [
                "string",
                "null"
              ],
              "description": "Email of the user when the acceptance was recorded."
            },
            "userId": {
              "type": [
                "string",
                "null"
              ],
              "description": "The identifier of the user who accepted the agreement. Supports $filter (eq)."
            },
            "userPrincipalName": {
              "type": [
                "string",
                "null"
              ],
              "description": "UPN of the user when the acceptance was recorded."
            },
            "@odata.type": {
              "type": "string"
            }
          }
        }
      ],
      "x-ms-discriminator-value": "#microsoft.graph.agreementAcceptance"
    },
    "microsoft.graph.agreementAcceptanceState": {
      "title": "agreementAcceptanceState",
      "enum": [
        "accepted",
        "declined",
        "unknownFutureValue"
      ],
      "type": "string"
    },
    "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"
    },
    "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"
        }
      }
    },
    "microsoft.graph.termsExpiration": {
      "title": "termsExpiration",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "frequency": {
          "pattern": "^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$",
          "type": [
            "string",
            "null"
          ],
          "description": "Represents the frequency at which the terms will expire, after its first expiration as set in startDateTime. The value is represented in ISO 8601 format for durations. For example, PT1M represents a time period of one month.",
          "format": "duration"
        },
        "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",
            "null"
          ],
          "description": "The DateTime when the agreement is set to expire for all users. 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"
        },
        "@odata.type": {
          "type": "string"
        }
      }
    }
  }
}