access_reviews_history_definitions

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

Overview

Name	`access_reviews_history_definitions`
Type	Resource
Id	`entra_id.identity_governance.access_reviews_history_definitions`

Fields

The following fields are returned by SELECT queries:

get
list

Retrieved navigation property

Name	Datatype	Description
`id`	`string`	The unique identifier for an entity. Read-only.
`createdBy`	`object`	(x-ms-discriminator-value: #microsoft.graph.userIdentity, title: identity)
`createdDateTime`	`string (date-time)`	Timestamp when the access review definition was created. (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])$`)
`decisions`	`array`	Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. The possible values are: approve, deny, dontKnow, notReviewed, and notNotified.
`displayName`	`string`	Name for the access review history data collection. Required.
`instances`	`array`	If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.
`reviewHistoryPeriodEndDateTime`	`string (date-time)`	A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined. (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])$`)
`reviewHistoryPeriodStartDateTime`	`string (date-time)`	A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined. (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])$`)
`scheduleSettings`		The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime aren't defined. Not supported yet.
`scopes`	`array`	Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
`status`		Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.

Retrieved collection

Name	Datatype	Description
`id`	`string`	The unique identifier for an entity. Read-only.
`createdBy`	`object`	(x-ms-discriminator-value: #microsoft.graph.userIdentity, title: identity)
`createdDateTime`	`string (date-time)`	Timestamp when the access review definition was created. (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])$`)
`decisions`	`array`	Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. The possible values are: approve, deny, dontKnow, notReviewed, and notNotified.
`displayName`	`string`	Name for the access review history data collection. Required.
`instances`	`array`	If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.
`reviewHistoryPeriodEndDateTime`	`string (date-time)`	A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined. (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])$`)
`reviewHistoryPeriodStartDateTime`	`string (date-time)`	A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined. (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])$`)
`scheduleSettings`		The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime aren't defined. Not supported yet.
`scopes`	`array`	Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
`status`		Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`access_review_history_definition_id`		Retrieve an accessReviewHistoryDefinition object by its identifier. All the properties of the access review history definition object are returned. If the definition is 30 days or older, a 404 Not Found error is returned.
`list`	`select`			Retrieve the accessReviewHistoryDefinition objects created in the last 30 days, including all nested properties.
`insert`	`insert`			Create a new accessReviewHistoryDefinition object.
`update`	`update`	`access_review_history_definition_id`
`delete`	`delete`	`access_review_history_definition_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
`access_review_history_definition_id`	`string`	The unique identifier of accessReviewHistoryDefinition
`If-Match`	`string`	ETag

`SELECT` examples

get
list

Retrieve an accessReviewHistoryDefinition object by its identifier. All the properties of the access review history definition object are returned. If the definition is 30 days or older, a 404 Not Found error is returned.

SELECT
id,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scheduleSettings,
scopes,
status
FROM entra_id.identity_governance.access_reviews_history_definitions
WHERE access_review_history_definition_id = '{{ access_review_history_definition_id }}' -- required
;

Retrieve the accessReviewHistoryDefinition objects created in the last 30 days, including all nested properties.

SELECT
id,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scheduleSettings,
scopes,
status
FROM entra_id.identity_governance.access_reviews_history_definitions
;

`INSERT` examples

insert
Manifest

Create a new accessReviewHistoryDefinition object.

INSERT INTO entra_id.identity_governance.access_reviews_history_definitions (
id,
createdBy,
createdDateTime,
decisions,
displayName,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scheduleSettings,
scopes,
status,
instances
)
SELECT 
'{{ id }}',
'{{ createdBy }}',
'{{ createdDateTime }}',
'{{ decisions }}',
'{{ displayName }}',
'{{ reviewHistoryPeriodEndDateTime }}',
'{{ reviewHistoryPeriodStartDateTime }}',
'{{ scheduleSettings }}',
'{{ scopes }}',
'{{ status }}',
'{{ instances }}'
RETURNING
id,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scheduleSettings,
scopes,
status
;

# Description fields are for documentation purposes
- name: access_reviews_history_definitions
props:
  - name: id
    value: "{{ id }}"
    description: |
      The unique identifier for an entity. Read-only.
  - name: createdBy
    value:
      displayName: "{{ displayName }}"
      id: "{{ id }}"
      ipAddress: "{{ ipAddress }}"
      userPrincipalName: "{{ userPrincipalName }}"
  - name: createdDateTime
    value: "{{ createdDateTime }}"
    description: |
      Timestamp when the access review definition was created.
  - name: decisions
    value: "{{ decisions }}"
    description: |
      Determines which review decisions will be included in the fetched review history data if specified. Optional on create. All decisions are included by default if no decisions are provided on create. The possible values are: approve, deny, dontKnow, notReviewed, and notNotified.
  - name: displayName
    value: "{{ displayName }}"
    description: |
      Name for the access review history data collection. Required.
  - name: reviewHistoryPeriodEndDateTime
    value: "{{ reviewHistoryPeriodEndDateTime }}"
    description: |
      A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
  - name: reviewHistoryPeriodStartDateTime
    value: "{{ reviewHistoryPeriodStartDateTime }}"
    description: |
      A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
  - name: scheduleSettings
    value: "{{ scheduleSettings }}"
    description: |
      The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime aren't defined. Not supported yet.
  - name: scopes
    description: |
      Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
    value:
  - name: status
    value: "{{ status }}"
    description: |
      Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.
  - name: instances
    description: |
      If the accessReviewHistoryDefinition is a recurring definition, instances represent each recurrence. A definition that doesn't recur will have exactly one instance.
    value:
      - id: "{{ id }}"
        downloadUri: "{{ downloadUri }}"
        expirationDateTime: "{{ expirationDateTime }}"
        fulfilledDateTime: "{{ fulfilledDateTime }}"
        reviewHistoryPeriodEndDateTime: "{{ reviewHistoryPeriodEndDateTime }}"
        reviewHistoryPeriodStartDateTime: "{{ reviewHistoryPeriodStartDateTime }}"
        runDateTime: "{{ runDateTime }}"
        status: "{{ status }}"

`UPDATE` examples

update

No description available.

UPDATE entra_id.identity_governance.access_reviews_history_definitions
SET 
id = '{{ id }}',
createdBy = '{{ createdBy }}',
createdDateTime = '{{ createdDateTime }}',
decisions = '{{ decisions }}',
displayName = '{{ displayName }}',
reviewHistoryPeriodEndDateTime = '{{ reviewHistoryPeriodEndDateTime }}',
reviewHistoryPeriodStartDateTime = '{{ reviewHistoryPeriodStartDateTime }}',
scheduleSettings = '{{ scheduleSettings }}',
scopes = '{{ scopes }}',
status = '{{ status }}',
instances = '{{ instances }}'
WHERE 
access_review_history_definition_id = '{{ access_review_history_definition_id }}' --required
RETURNING
id,
createdBy,
createdDateTime,
decisions,
displayName,
instances,
reviewHistoryPeriodEndDateTime,
reviewHistoryPeriodStartDateTime,
scheduleSettings,
scopes,
status;

`DELETE` examples

delete

No description available.

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

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​