Edit

accessReviewStage resource type

  • Article

Namespace: microsoft.graph

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported. To determine whether an API is available in v1.0, use the Version selector.

Note

This is the recommended API for access reviews. The previous version of the access reviews API is deprecated.

Represents a stage of a Microsoft Entra access review recurrence. If the parent accessReviewScheduleDefinition has defined the stageSettings property, the accessReviewInstance is comprised of up to three subsequent stages. Each stage can have a different set of reviewers who can act on the stage decisions, and settings determining which decisions pass from stage to stage.

Every accessReviewStage contains a list of decisions that reviewers can take action on. 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 DateTime when review stage is scheduled to end. The DatetimeOffset 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. 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 are notified to take action if no users are found from the list of reviewers specified. This can 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 DateTime when review stage is scheduled to start. May be in the future. The DateTimeOffset 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. 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 JSON representation shows the resource type.

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