Microsoft Graph · Schema

Agreement

Azure ADCollaborationContactsDocumentsEmailGraphIdentityMicrosoftOffice 365PresentationsProductivitySpreadsheetsT1Tasks
View JSON Schema on GitHub

JSON Schema

microsoft-graph-agreement-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/Agreement",
  "title": "Agreement",
  "allOf": [
    {
      "$ref": "#/components/schemas/Entity"
    },
    {
      "title": "Agreement",
      "required": [
        "@odata.type"
      ],
      "type": "object",
      "properties": {
        "displayName": {
          "type": "string",
          "description": "Display name of the agreement. Supports $filter (eq).",
          "nullable": true
        },
        "isPerDeviceAcceptanceRequired": {
          "type": "boolean",
          "description": "Indicates whether end users are required to accept this agreement on every device. Supports $filter (eq).",
          "nullable": true
        },
        "isViewingBeforeAcceptanceRequired": {
          "type": "boolean",
          "description": "Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).",
          "nullable": true
        },
        "termsExpiration": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/TermsExpiration"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "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",
          "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",
          "nullable": true
        },
        "acceptances": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/AgreementAcceptance"
          },
          "description": "Read-only. Information about acceptances of this agreement.",
          "x-ms-navigationProperty": true
        },
        "file": {
          "anyOf": [
            {
              "$ref": "#/components/schemas/AgreementFile"
            },
            {
              "type": "object",
              "nullable": true
            }
          ],
          "description": "Default PDF linked to this agreement.",
          "x-ms-navigationProperty": true
        },
        "files": {
          "type": "array",
          "items": {
            "$ref": "#/components/schemas/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"
}