terms_of_use_agreements

Creates, updates, deletes, gets or lists a terms_of_use_agreements resource.

Overview

Name	terms_of_use_agreements
Type	Resource
Id	entra_id.identity_governance.terms_of_use_agreements

Fields

The following fields are returned by SELECT queries:

get

Retrieved navigation property

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
acceptances	array	Read-only. Information about acceptances of this agreement.
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).
file		Default PDF linked to this agreement.
files	array	PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
isPerDeviceAcceptanceRequired	boolean	Indicates whether end users are required to accept this agreement on every device that they access 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		Expiration schedule and frequency of agreement for all users. Supports $filter (eq).
userReacceptRequiredFrequency	string (duration)	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). (pattern: ^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$)

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
acceptances	array	Read-only. Information about acceptances of this agreement.
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).
file		Default PDF linked to this agreement.
files	array	PDFs linked to this agreement. This property is in the process of being deprecated. Use the file property instead. Supports $expand.
isPerDeviceAcceptanceRequired	boolean	Indicates whether end users are required to accept this agreement on every device that they access 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		Expiration schedule and frequency of agreement for all users. Supports $filter (eq).
userReacceptRequiredFrequency	string (duration)	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). (pattern: ^-?P([0-9]+D)?(T([0-9]+H)?([0-9]+M)?([0-9]+([.][0-9]+)?S)?)?$)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agreement_id		Retrieve the properties and relationships of an agreement object.
list	select			Retrieve a list of agreement objects.
insert	insert			Create a new agreement object.
update	update	agreement_id		Update the properties of an agreement object.
delete	delete	agreement_id	If-Match	Delete an agreement object.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
agreement_id	string	The unique identifier of agreement
If-Match	string	ETag

SELECT examples

get

Retrieve the properties and relationships of an agreement object.

SELECT
id,
acceptances,
displayName,
file,
files,
isPerDeviceAcceptanceRequired,
isViewingBeforeAcceptanceRequired,
termsExpiration,
userReacceptRequiredFrequency
FROM entra_id.identity_governance.terms_of_use_agreements
WHERE agreement_id = '{{ agreement_id }}' -- required
;

list

Retrieve a list of agreement objects.

SELECT
id,
acceptances,
displayName,
file,
files,
isPerDeviceAcceptanceRequired,
isViewingBeforeAcceptanceRequired,
termsExpiration,
userReacceptRequiredFrequency
FROM entra_id.identity_governance.terms_of_use_agreements
;

INSERT examples

insert

Create a new agreement object.

INSERT INTO entra_id.identity_governance.terms_of_use_agreements (
id,
displayName,
isPerDeviceAcceptanceRequired,
isViewingBeforeAcceptanceRequired,
termsExpiration,
userReacceptRequiredFrequency,
acceptances,
file,
files
)
SELECT 
'{{ id }}',
'{{ displayName }}',
{{ isPerDeviceAcceptanceRequired }},
{{ isViewingBeforeAcceptanceRequired }},
'{{ termsExpiration }}',
'{{ userReacceptRequiredFrequency }}',
'{{ acceptances }}',
'{{ file }}',
'{{ files }}'
RETURNING
id,
acceptances,
displayName,
file,
files,
isPerDeviceAcceptanceRequired,
isViewingBeforeAcceptanceRequired,
termsExpiration,
userReacceptRequiredFrequency
;

Manifest

# Description fields are for documentation purposes
- name: terms_of_use_agreements
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      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).
  - name: isPerDeviceAcceptanceRequired
    value: {{ isPerDeviceAcceptanceRequired }}
    description: |
      Indicates whether end users are required to accept this agreement on every device that they access 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).
  - name: isViewingBeforeAcceptanceRequired
    value: {{ isViewingBeforeAcceptanceRequired }}
    description: |
      Indicates whether the user has to expand the agreement before accepting. Supports $filter (eq).
  - name: termsExpiration
    value: "{{ termsExpiration }}"
    description: |
      Expiration schedule and frequency of agreement for all users. Supports $filter (eq).
  - name: userReacceptRequiredFrequency
    value: "{{ userReacceptRequiredFrequency }}"
    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).
  - name: acceptances
    description: |
      Read-only. Information about acceptances of this agreement.
    value:
      - id: "{{ id }}"
        agreementFileId: "{{ agreementFileId }}"
        agreementId: "{{ agreementId }}"
        deviceDisplayName: "{{ deviceDisplayName }}"
        deviceId: "{{ deviceId }}"
        deviceOSType: "{{ deviceOSType }}"
        deviceOSVersion: "{{ deviceOSVersion }}"
        expirationDateTime: "{{ expirationDateTime }}"
        recordedDateTime: "{{ recordedDateTime }}"
        state: "{{ state }}"
        userDisplayName: "{{ userDisplayName }}"
        userEmail: "{{ userEmail }}"
        userId: "{{ userId }}"
        userPrincipalName: "{{ userPrincipalName }}"
  - name: file
    value: "{{ file }}"
    description: |
      Default PDF linked to this agreement.
  - name: files
    description: |
      PDFs linked to this agreement. This property is in the process of being deprecated. Use the  file property instead. Supports $expand.
    value:
      - id: "{{ id }}"
        createdDateTime: "{{ createdDateTime }}"
        displayName: "{{ displayName }}"
        fileData: "{{ fileData }}"
        fileName: "{{ fileName }}"
        isDefault: {{ isDefault }}
        isMajorVersion: {{ isMajorVersion }}
        language: "{{ language }}"
        versions: "{{ versions }}"

UPDATE examples

update

Update the properties of an agreement object.

UPDATE entra_id.identity_governance.terms_of_use_agreements
SET 
id = '{{ id }}',
displayName = '{{ displayName }}',
isPerDeviceAcceptanceRequired = {{ isPerDeviceAcceptanceRequired }},
isViewingBeforeAcceptanceRequired = {{ isViewingBeforeAcceptanceRequired }},
termsExpiration = '{{ termsExpiration }}',
userReacceptRequiredFrequency = '{{ userReacceptRequiredFrequency }}',
acceptances = '{{ acceptances }}',
file = '{{ file }}',
files = '{{ files }}'
WHERE 
agreement_id = '{{ agreement_id }}' --required
RETURNING
id,
acceptances,
displayName,
file,
files,
isPerDeviceAcceptanceRequired,
isViewingBeforeAcceptanceRequired,
termsExpiration,
userReacceptRequiredFrequency;

DELETE examples

delete

Delete an agreement object.

DELETE FROM entra_id.identity_governance.terms_of_use_agreements
WHERE agreement_id = '{{ agreement_id }}' --required
AND If-Match = '{{ If-Match }}'
;