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 Microsoft Entra ID Governance. You can use the following methods to create and manage the Microsoft Entra Terms of Use feature according to your scenario.
Methods
| Method | Return Type | Description |
|---|---|---|
| Create | agreement | Create a new agreement by posting to the agreement collection. |
| List | agreement collection | Get an agreement object collection. |
| Get | agreement | Read properties and relationships of an agreement object. |
| Update | None | Update an agreement object. |
| Delete | 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 isn't shown to end users who view the agreement. Supports $filter (eq). |
| id | String | Read-only. Supports $filter (eq). |
| isPerDeviceAcceptanceRequired | Boolean | This setting enables you to require end users to accept this agreement on every device that they're accessing 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 | Boolean | Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq). |
| termsExpiration | termsExpiration | Expiration schedule and frequency of agreement for all users. Supports $filter (eq). |
| userReacceptRequiredFrequency | Duration | The duration after which the user must reaccept 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. |
| file | agreementFile | Default PDF linked to 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. |
JSON representation
The following JSON representation shows the resource type.
{
"@odata.type": "#microsoft.graph.agreement",
"id": "String (identifier)",
"displayName": "String",
"termsExpiration": {
"@odata.type": "microsoft.graph.termsExpiration"
},
"userReacceptRequiredFrequency": "String (duration)",
"isViewingBeforeAcceptanceRequired": "Boolean",
"isPerDeviceAcceptanceRequired": "Boolean"
}