Edit

accessReviewHistoryDefinition resource type

  • Article

Namespace: microsoft.graph

Represents a collection of access review historical data and the scopes used to collect that data.

An accessReviewHistoryDefinition contains a list of accessReviewHistoryInstance objects. Each recurrence of the history definition creates an instance. In the case of a one-time history definition, only one instance is created.

Methods

Method Return type Description
List accessReviewHistoryDefinitions accessReviewHistoryDefinition collection Get a list of the accessReviewHistoryDefinition objects and their properties.
Create accessReviewHistoryDefinition accessReviewHistoryDefinition Create a new accessReviewHistoryDefinition object.
Get accessReviewHistoryDefinition accessReviewHistoryDefinition Read the properties and relationships of an accessReviewHistoryDefinition object.

Properties

Property Type Description
createdBy userIdentity User who created this review history definition.
createdDateTime DateTimeOffset Timestamp when the access review definition was created.
decisions String collection 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. Possible values are: approve, deny, dontKnow, notReviewed, and notNotified.
displayName String Name for the access review history data collection. Required.
id String The assigned unique identifier of an access review history definition.
reviewHistoryPeriodEndDateTime DateTimeOffset A timestamp. Reviews ending on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
reviewHistoryPeriodStartDateTime DateTimeOffset A timestamp. Reviews starting on or before this date will be included in the fetched history data. Only required if scheduleSettings isn't defined.
scheduleSettings accessReviewHistoryScheduleSettings The settings for a recurring access review history definition series. Only required if reviewHistoryPeriodStartDateTime or reviewHistoryPeriodEndDateTime aren't defined. Not supported yet.
scopes accessReviewScope collection Used to scope what reviews are included in the fetched history data. Fetches reviews whose scope matches with this provided scope. Required.
status accessReviewHistoryStatus Represents the status of the review history data collection. The possible values are: done, inProgress, error, requested, unknownFutureValue.

Relationships

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

JSON representation

The following JSON representation shows the resource type.

{
  "@odata.type": "#microsoft.graph.accessReviewHistoryDefinition",
  "createdBy": {
    "@odata.type": "microsoft.graph.userIdentity"
  },
  "createdDateTime": "String (timestamp)",
  "decisions": [
    "String"
  ],
  "displayName": "String",
  "id": "String (identifier)",
  "reviewHistoryPeriodEndDateTime": "String (timestamp)",
  "reviewHistoryPeriodStartDateTime": "String (timestamp)",
  "scopes": [
    {
      "@odata.type": "microsoft.graph.accessReviewScope"
    }
  ],
  "scheduleSettings": {
    "@odata.type": "microsoft.graph.accessReviewHistoryScheduleSettings"
  },
  "status": "String",
}