terms_of_use_agreement_acceptances

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

Overview

Name	terms_of_use_agreement_acceptances
Type	Resource
Id	entra_id.identity_governance.terms_of_use_agreement_acceptances

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.
agreementFileId	string	The identifier of the agreement file accepted by the user.
agreementId	string	The identifier 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 to accept the agreement.
deviceOSVersion	string	The operating system version of the device used to accept the agreement.
expirationDateTime	string (date-time)	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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
recordedDateTime	string (date-time)	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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
state		The state of the agreement acceptance. The 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	The identifier of the user who accepted the agreement. Supports $filter (eq).
userPrincipalName	string	UPN of the user when the acceptance was recorded.

list

Retrieved collection

Name	Datatype	Description
id	string	The unique identifier for an entity. Read-only.
agreementFileId	string	The identifier of the agreement file accepted by the user.
agreementId	string	The identifier 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 to accept the agreement.
deviceOSVersion	string	The operating system version of the device used to accept the agreement.
expirationDateTime	string (date-time)	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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
recordedDateTime	string (date-time)	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. (pattern: ^[0-9]{4,}-(0[1-9]|1[012])-(0[1-9]|[12][0-9]|3[01])T([01][0-9]|2[0-3]):[0-5][0-9]:[0-5][0-9]([.][0-9]{1,12})?(Z|[+-][0-9][0-9]:[0-9][0-9])$)
state		The state of the agreement acceptance. The 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	The identifier of the user who accepted the agreement. Supports $filter (eq).
userPrincipalName	string	UPN of the user when the acceptance was recorded.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agreement_acceptance_id		Represents the current status of a user's response to a company's customizable terms of use agreement.
list	select			Represents the current status of a user's response to a company's customizable terms of use agreement.
insert	insert
update	update	agreement_acceptance_id
delete	delete	agreement_acceptance_id	If-Match

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_acceptance_id	string	The unique identifier of agreementAcceptance
If-Match	string	ETag

SELECT examples

get

Represents the current status of a user's response to a company's customizable terms of use agreement.

SELECT
id,
agreementFileId,
agreementId,
deviceDisplayName,
deviceId,
deviceOSType,
deviceOSVersion,
expirationDateTime,
recordedDateTime,
state,
userDisplayName,
userEmail,
userId,
userPrincipalName
FROM entra_id.identity_governance.terms_of_use_agreement_acceptances
WHERE agreement_acceptance_id = '{{ agreement_acceptance_id }}' -- required
;

list

Represents the current status of a user's response to a company's customizable terms of use agreement.

SELECT
id,
agreementFileId,
agreementId,
deviceDisplayName,
deviceId,
deviceOSType,
deviceOSVersion,
expirationDateTime,
recordedDateTime,
state,
userDisplayName,
userEmail,
userId,
userPrincipalName
FROM entra_id.identity_governance.terms_of_use_agreement_acceptances
;

INSERT examples

insert

No description available.

INSERT INTO entra_id.identity_governance.terms_of_use_agreement_acceptances (
id,
agreementFileId,
agreementId,
deviceDisplayName,
deviceId,
deviceOSType,
deviceOSVersion,
expirationDateTime,
recordedDateTime,
state,
userDisplayName,
userEmail,
userId,
userPrincipalName
)
SELECT 
'{{ id }}',
'{{ agreementFileId }}',
'{{ agreementId }}',
'{{ deviceDisplayName }}',
'{{ deviceId }}',
'{{ deviceOSType }}',
'{{ deviceOSVersion }}',
'{{ expirationDateTime }}',
'{{ recordedDateTime }}',
'{{ state }}',
'{{ userDisplayName }}',
'{{ userEmail }}',
'{{ userId }}',
'{{ userPrincipalName }}'
RETURNING
id,
agreementFileId,
agreementId,
deviceDisplayName,
deviceId,
deviceOSType,
deviceOSVersion,
expirationDateTime,
recordedDateTime,
state,
userDisplayName,
userEmail,
userId,
userPrincipalName
;

Manifest

# Description fields are for documentation purposes
- name: terms_of_use_agreement_acceptances
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: agreementFileId
    value: "{{ agreementFileId }}"
    description: |
      The identifier of the agreement file accepted by the user.
  - name: agreementId
    value: "{{ agreementId }}"
    description: |
      The identifier of the agreement.
  - name: deviceDisplayName
    value: "{{ deviceDisplayName }}"
    description: |
      The display name of the device used for accepting the agreement.
  - name: deviceId
    value: "{{ deviceId }}"
    description: |
      The unique identifier of the device used for accepting the agreement. Supports $filter (eq) and eq for null values.
  - name: deviceOSType
    value: "{{ deviceOSType }}"
    description: |
      The operating system used to accept the agreement.
  - name: deviceOSVersion
    value: "{{ deviceOSVersion }}"
    description: |
      The operating system version of the device used to accept the agreement.
  - name: expirationDateTime
    value: "{{ expirationDateTime }}"
    description: |
      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.
  - name: recordedDateTime
    value: "{{ recordedDateTime }}"
    description: |
      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.
  - name: state
    value: "{{ state }}"
    description: |
      The state of the agreement acceptance. The possible values are: accepted, declined. Supports $filter (eq).
  - name: userDisplayName
    value: "{{ userDisplayName }}"
    description: |
      Display name of the user when the acceptance was recorded.
  - name: userEmail
    value: "{{ userEmail }}"
    description: |
      Email of the user when the acceptance was recorded.
  - name: userId
    value: "{{ userId }}"
    description: |
      The identifier of the user who accepted the agreement. Supports $filter (eq).
  - name: userPrincipalName
    value: "{{ userPrincipalName }}"
    description: |
      UPN of the user when the acceptance was recorded.

UPDATE examples

update

No description available.

UPDATE entra_id.identity_governance.terms_of_use_agreement_acceptances
SET 
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 }}'
WHERE 
agreement_acceptance_id = '{{ agreement_acceptance_id }}' --required
RETURNING
id,
agreementFileId,
agreementId,
deviceDisplayName,
deviceId,
deviceOSType,
deviceOSVersion,
expirationDateTime,
recordedDateTime,
state,
userDisplayName,
userEmail,
userId,
userPrincipalName;

DELETE examples

delete

No description available.

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