agreement resource type

  • 2 minutes to read

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

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.
id String Read-only.
isViewingBeforeAcceptanceRequired Boolean Indicates whether the user has to expand and view the agreement before accepting.

Relationships

Relationship Type Description
files agreementFile collection Read-only. PDFs linked to this agreement.

JSON representation

The following is a JSON representation of the resource.

{
  "displayName": "String",
  "id": "String (identifier)",
  "isViewingBeforeAcceptanceRequired": true
}