title | description | ms.localizationpriority | doc_type | ms.subservice | author |
---|---|---|---|---|---|
agreementAcceptance resource type |
Represents the current status of a user within scope of a company's customizable terms of use powered by Microsoft Entra ID Governance. |
medium |
resourcePageType |
entra-id-governance |
AlexFilipin |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Represents the current status of a user's response to a company's customizable terms of use agreement powered by Microsoft Entra ID Governance.
Method | Return Type | Description |
---|---|---|
List agreement acceptances for a user | agreementAcceptance | Retrieve a user's agreementAcceptance objects. |
List acceptances | agreementAcceptance | Retrieve acceptance for an agreement. |
Property | Type | Description |
---|---|---|
agreementFileId | String | ID of the agreement file accepted by the user. |
agreementId | String | ID of the agreement. |
deviceDisplayName | String | The display name of the device used for accepting the agreement. |
deviceId | String | The unique identifier of the device used for accepting the agreement. Supports $filter (eq ) and eq for null values. |
deviceOSType | String | The operating system used for accepting the agreement. |
deviceOSVersion | String | The operating system version of the device used for accepting the agreement. |
expirationDateTime | DateTimeOffset | 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. |
id | String | The identifier of the agreement acceptance. Read-only. Supports $filter (eq ). |
recordedDateTime | DateTimeOffset | 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 ) and eq for null values. |
state | string | Possible values are: accepted , declined . Supports $filter (eq ). |
userDisplayName | String | Display name of the user when the acceptance was recorded. |
userEmail | String | Email of the user when the acceptance was recorded. |
userId | String | ID of the user who accepted the agreement. Supports $filter (eq ). |
userPrincipalName | String | UPN of the user when the acceptance was recorded. |
None.
The following is a JSON representation of the resource.
{
"id": "String (identifier)",
"agreementId": "String",
"userId": "String",
"deviceId": "String",
"deviceDisplayName": "String",
"deviceOSType": "String",
"deviceOSVersion": "String",
"agreementFileId": "String",
"userDisplayName": "String",
"userPrincipalName": "String",
"userEmail": "String",
"recordedDateTime": "String (timestamp)",
"expirationDateTime": "String",
"state": "String"
}