agreement resource type

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Represents a tenant's customizable terms of use agreement that is created and managed with Azure Active Directory (Azure AD). You can use the following methods to create and manage the Azure Active Directory Terms of Use feature according to your scenario.

Methods

Method Return Type Description
Create agreements agreement Create a new agreement by posting to the agreement collection.
List agreements agreement collection Get an agreement object collection.
Get agreement agreement Read properties and relationships of an agreement object.
Update agreement agreement Update an agreement object.
Delete agreement None Delete an agreement object.

Properties

Property Type Description
displayName String Display name of the agreement. The display name is used for internal tracking of the agreement but is not shown to end users who view the agreement.
id String Read-only.
isPerDeviceAcceptanceRequired Boolean This setting enables you to require end users to accept this agreement on every device that they are accessing it from. The end user will be required to register their device in Azure AD, if they haven't already done so.
isViewingBeforeAcceptanceRequired Boolean Indicates whether the user has to expand the agreement before accepting.
termsExpiration termsExpiration Expiration schedule and frequency of agreement for all users.
userReacceptRequiredFrequency Duration The duration after which the user must re-accept the terms of use. The value is represented in ISO 8601 format for durations.

Relationships

Relationship Type Description
acceptances agreementAcceptance collection Read-only. Information about acceptances of this agreement.
files agreementFileLocalization collection PDFs linked to this agreement. Note: This property is in the process of being deprecated. Use the file property instead.
file agreementFile Default PDF linked to this agreement.
file/localizations agreementFileLocalization collection The localized versions of the agreement files attached to the agreement.
file/localizations/{localizationId}/versions agreementFileVersion collection The version history for the localized agreement file.

JSON representation

The following is a JSON representation of the resource.

{
  "id": "String (identifier)",
  "displayName": "MSGraph Sample",
  "isViewingBeforeAcceptanceRequired": true,
  "isPerDeviceAcceptanceRequired": false,
  "termsExpiration": {
    "startDateTime": "2018-10-01T00:00:00.0000000Z",
    "frequency": "PT1M"
  }
}