accessReviewStage resource type

Namespace: microsoft.graph

Represents a stage of an Azure AD access review. If the parent accessReviewScheduleDefinition has defined the stageSettings property, the accessReviewInstance will be comprised of up to three subsequent stages. Each stage may have a different set of reviewers who can act on the stage decisions, and settings determining which decisions will pass from stage to stage.

Every accessReviewStage contains a list of decision items for reviewers. There is only one decision per identity being reviewed.

Methods

Method Return type Description
List accessReviewStages accessReviewStage collection Get a list of the accessReviewStage objects and their properties.
Get accessReviewStage accessReviewStage Read the properties and relationships of an accessReviewStage object.
Update accessReviewStage accessReviewStage Update the properties of an accessReviewStage object.
stop None Manually stop an accessReviewStage.
filterByCurrentUser accessReviewStage collection Returns all stages on a given accessReviewInstance for which the calling user is a reviewer.
List decisions accessReviewInstanceDecisionItem collection Get the decisions made in an accessReviewStage.

Properties

Property Type Description
endDateTime DateTimeOffset The date and time in ISO 8601 format and UTC time when the review stage is scheduled to end. This property is the cumulative total of the durationInDays for all stages. Read-only.
fallbackReviewers accessReviewReviewerScope collection This collection of reviewer scopes is used to define the list of fallback reviewers. These fallback reviewers will be notified to take action if no users are found from the list of reviewers specified. This could occur when either the group owner is specified as the reviewer but the group owner does not exist, or manager is specified as reviewer but a user's manager does not exist.
id String Unique identifier of the stage. Read-only.
reviewers accessReviewReviewerScope collection This collection of access review scopes is used to define who the reviewers are. For examples of options for assigning reviewers, see Assign reviewers to your access review definition using the Microsoft Graph API.
startDateTime DateTimeOffset The date and time in ISO 8601 format and UTC time when the review stage is scheduled to start. Read-only.
status String Specifies the status of an accessReviewStage. Possible values: Initializing, NotStarted, Starting, InProgress, Completing, Completed, AutoReviewing, and AutoReviewed. Supports $orderby, and $filter (eq only). Read-only.

Relationships

Relationship Type Description
decisions accessReviewInstanceDecisionItem collection Each user reviewed in an accessReviewStage has a decision item representing if they were approved, denied, or not yet reviewed.

JSON representation

The following is a JSON representation of the resource.

{
  "@odata.type": "#microsoft.graph.accessReviewStage",
  "endDateTime": "String (timestamp)",
  "fallbackReviewers": [
    {
      "@odata.type": "microsoft.graph.accessReviewReviewerScope"
    }
  ],
  "id": "String (identifier)",
  "reviewers": [
    {
      "@odata.type": "microsoft.graph.accessReviewReviewerScope"
    }
  ],
  "startDateTime": "String (timestamp)",
  
  "status": "String"
  
}