Skip to main content

access_reviews_history_definitions_instances

Creates, updates, deletes, gets or lists an access_reviews_history_definitions_instances resource.

Overview​

Nameaccess_reviews_history_definitions_instances
TypeResource
Identra_id.identity_governance.access_reviews_history_definitions_instances

Fields​

The following fields are returned by SELECT queries:

Retrieved navigation property

NameDatatypeDescription
idstringThe unique identifier for an entity. Read-only.
downloadUristringUri that can be used to retrieve review history data. This URI will be active for 24 hours after being generated. Required.
expirationDateTimestring (date-time)Timestamp when this instance and associated data expires and the history is deleted. Required. (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])$)
fulfilledDateTimestring (date-time)Timestamp when all of the available data for this instance was collected and is set after this instance's status is set to done. Required. (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])$)
reviewHistoryPeriodEndDateTimestring (date-time)Timestamp reviews ending on or before this date will be included in the fetched history data. (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])$)
reviewHistoryPeriodStartDateTimestring (date-time)Timestamp reviews starting on or after this date will be included in the fetched history data. (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])$)
runDateTimestring (date-time)Timestamp when the instance's history data is scheduled to be generated. (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])$)
statusRepresents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue. Once the status has been marked as done, a link can be generated to retrieve the instance's data by calling generateDownloadUri method.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectaccess_review_history_definition_id, access_review_history_instance_idIf the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.
listselectaccess_review_history_definition_idRetrieve the instances of an access review history definition created in the last 30 days.
insertinsertaccess_review_history_definition_id
updateupdateaccess_review_history_definition_id, access_review_history_instance_id
deletedeleteaccess_review_history_definition_id, access_review_history_instance_idIf-Match
generate_download_uriexecaccess_review_history_definition_id, access_review_history_instance_idGenerates a URI for an accessReviewHistoryInstance object the status for which is done. Each URI can be used to retrieve the instance's review history data. Each URI is valid for 24 hours and can be retrieved by fetching the downloadUri property from the accessReviewHistoryInstance 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.

NameDatatypeDescription
access_review_history_definition_idstringThe unique identifier of accessReviewHistoryDefinition
access_review_history_instance_idstringThe unique identifier of accessReviewHistoryInstance
If-MatchstringETag

SELECT examples​

If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.

SELECT
id,
downloadUri,
expirationDateTime,
fulfilledDateTime,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
runDateTime,
status
FROM entra_id.identity_governance.access_reviews_history_definitions_instances
WHERE access_review_history_definition_id = '{{ access_review_history_definition_id }}' -- required
AND access_review_history_instance_id = '{{ access_review_history_instance_id }}' -- required
;

INSERT examples​

No description available.

INSERT INTO entra_id.identity_governance.access_reviews_history_definitions_instances (
id,
downloadUri,
expirationDateTime,
fulfilledDateTime,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
runDateTime,
status,
access_review_history_definition_id
)
SELECT 
'{{ id }}',
'{{ downloadUri }}',
'{{ expirationDateTime }}',
'{{ fulfilledDateTime }}',
'{{ reviewHistoryPeriodEndDateTime }}',
'{{ reviewHistoryPeriodStartDateTime }}',
'{{ runDateTime }}',
'{{ status }}',
'{{ access_review_history_definition_id }}'
RETURNING
id,
downloadUri,
expirationDateTime,
fulfilledDateTime,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
runDateTime,
status
;

UPDATE examples​

No description available.

UPDATE entra_id.identity_governance.access_reviews_history_definitions_instances
SET 
id = '{{ id }}',
downloadUri = '{{ downloadUri }}',
expirationDateTime = '{{ expirationDateTime }}',
fulfilledDateTime = '{{ fulfilledDateTime }}',
reviewHistoryPeriodEndDateTime = '{{ reviewHistoryPeriodEndDateTime }}',
reviewHistoryPeriodStartDateTime = '{{ reviewHistoryPeriodStartDateTime }}',
runDateTime = '{{ runDateTime }}',
status = '{{ status }}'
WHERE 
access_review_history_definition_id = '{{ access_review_history_definition_id }}' --required
AND access_review_history_instance_id = '{{ access_review_history_instance_id }}' --required
RETURNING
id,
downloadUri,
expirationDateTime,
fulfilledDateTime,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
runDateTime,
status;

DELETE examples​

No description available.

DELETE FROM entra_id.identity_governance.access_reviews_history_definitions_instances
WHERE access_review_history_definition_id = '{{ access_review_history_definition_id }}' --required
AND access_review_history_instance_id = '{{ access_review_history_instance_id }}' --required
AND If-Match = '{{ If-Match }}'
;

Lifecycle Methods​

Generates a URI for an accessReviewHistoryInstance object the status for which is done. Each URI can be used to retrieve the instance's review history data. Each URI is valid for 24 hours and can be retrieved by fetching the downloadUri property from the accessReviewHistoryInstance object.

EXEC entra_id.identity_governance.access_reviews_history_definitions_instances.generate_download_uri 
@access_review_history_definition_id='{{ access_review_history_definition_id }}' --required, 
@access_review_history_instance_id='{{ access_review_history_instance_id }}' --required
;