| title | approvalStep resource type |
|---|---|
| description | Specifies a decision step in an approval in entitlement management and PIM. |
| ms.localizationpriority | medium |
| author | markwahl-msft |
| ms.subservice | entra-id-governance |
| doc_type | resourcePageType |
| ms.date | 07/22/2024 |
Namespace: microsoft.graph
[!INCLUDE beta-disclaimer]
Specifies a decision step in an approval in entitlement management and PIM.
| Method | Return Type | Description |
|---|---|---|
| List | approvalStep collection | List the approvalStep objects associated with an approval object in entitlement management and PIM. |
| Get | approvalStep | Retrieve the properties of an approvalStep object in entitlement management and PIM. |
| Update | None | Apply approve or deny decision on an approvalStep object in entitlement management and PIM. |
| Property | Type | Description |
|---|---|---|
| assignedToMe | Boolean | Indicates whether the step is assigned to the calling user to review. Read-only. |
| displayName | String | The label provided by the policy creator to identify an approval step. Read-only. |
| id | String | The identifier of the step associated with an approval object. Read-only. |
| justification | String | The justification associated with the approval step decision. |
| reviewResult | String | The result of this approval record. Possible values include: NotReviewed, Approved, Denied. |
| reviewedBy | userIdentity collection | The identifier of the reviewer. 00000000-0000-0000-0000-000000000000 if the assigned reviewer hasn't reviewed. Read-only. |
| reviewedDateTime | DateTimeOffset | The date and time when a decision was recorded. The date and time information uses 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 | The step status. Possible values: InProgress, Initializing, Completed, Expired. Read-only. |
| Relationship | Type | Description |
|---|---|---|
| approval | approval collection | The approval object for decisions associated with the accessPackageAssignmentRequest in entitlement management, the roleAssignmentScheduleRequest in PIM for Microsoft Entra roles, or the assignmentScheduleRequest in PIM for Groups. |
The following JSON representation shows the resource type.
{
"@odata.type":"#microsoft.graph.approvalStep",
"id":"String (identifier)",
"displayName":"String",
"status":"String",
"assignedToMe":true,
"reviewedBy": [{"@odata.type": "microsoft.graph.userIdentity"}],
"reviewedDateTime":"String (timestamp)",
"reviewResult":"String",
"justification":"String"
}