file

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

Overview

Name	file
Type	Resource
Id	entra_id.agreements.file

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.
createdDateTime	string (date-time)	The date time representing when the file was created. 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])$)
displayName	string	Localized display name of the policy file of an agreement. The localized display name is shown to end users who view the agreement.
fileData	object	Data that represents the terms of use PDF document. Read-only. (title: agreementFileData)
fileName	string	Name of the agreement file (for example, TOU.pdf). Read-only.
isDefault	boolean	If none of the languages matches the client preference, indicates whether this is the default agreement file. If none of the files are marked as default, the first one is treated as the default. Read-only.
isMajorVersion	boolean	Indicates whether the agreement file is a major version update. Major version updates invalidate the agreement's acceptances on the corresponding language.
language	string	The language of the agreement file in the format 'languagecode2-country/regioncode2'. 'languagecode2' is a lowercase two-letter code derived from ISO 639-1, while 'country/regioncode2' is derived from ISO 3166 and usually consists of two uppercase letters, or a BCP-47 language tag. For example, U.S. English is en-US. Read-only.
localizations	array	The localized version of the terms of use agreement files attached to the agreement.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	agreement_id		Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.
update	update	agreement_id
delete	delete	agreement_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_id	string	The unique identifier of agreement
If-Match	string	ETag

SELECT examples

get

Retrieve the details of an agreement file, including the language and version information. The default file can have multiple versions, each with its own language, that can be retrieved by specifying the Accept-Language header.

SELECT
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
localizations
FROM entra_id.agreements.file
WHERE agreement_id = '{{ agreement_id }}' -- required
;

UPDATE examples

update

No description available.

UPDATE entra_id.agreements.file
SET 
id = '{{ id }}',
createdDateTime = '{{ createdDateTime }}',
displayName = '{{ displayName }}',
fileData = '{{ fileData }}',
fileName = '{{ fileName }}',
isDefault = {{ isDefault }},
isMajorVersion = {{ isMajorVersion }},
language = '{{ language }}',
localizations = '{{ localizations }}'
WHERE 
agreement_id = '{{ agreement_id }}' --required
RETURNING
id,
createdDateTime,
displayName,
fileData,
fileName,
isDefault,
isMajorVersion,
language,
localizations;

DELETE examples

delete

No description available.

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