You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/active-directory/privileged-identity-management/azure-ad-pim-approval-workflow.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -37,19 +37,19 @@ As a delegated approver, you'll receive an email notification when an Azure AD r
37
37
38
38
In the **Requests for role activations** section, you'll see a list of requests pending your approval.
39
39
40
-
## View pending requests using Graph API
40
+
## View pending requests using Microsoft Graph API
41
41
42
42
### HTTP request
43
43
44
44
````HTTP
45
-
GET https://graph.microsoft.com/beta/roleManagement/directory/roleAssignmentScheduleRequests/filterByCurrentUser(on='approver')?$filter=status eq 'PendingApproval'
45
+
GET https://graph.microsoft.com/v1.0/roleManagement/directory/roleAssignmentScheduleRequests/filterByCurrentUser(on='approver')?$filter=status eq 'PendingApproval'
Copy file name to clipboardExpand all lines: articles/active-directory/privileged-identity-management/pim-apis.md
+35-31Lines changed: 35 additions & 31 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -22,7 +22,7 @@ You can perform Privileged Identity Management (PIM) tasks using the Microsoft G
22
22
23
23
For requests and other details about PIM APIs, check out:
24
24
25
-
-[PIM for Azure AD roles API reference](/graph/api/resources/unifiedroleeligibilityschedulerequest?view=graph-rest-beta&preserve-view=true)
25
+
-[PIM for Azure AD roles API reference](/graph/api/resources/privilegedidentitymanagementv3-overview)
26
26
-[PIM for Azure resource roles API reference](/rest/api/authorization/roleeligibilityschedulerequests)
27
27
28
28
## PIM API history
@@ -35,11 +35,11 @@ Under the /beta/privilegedRoles endpoint, Microsoft had a classic version of the
35
35
36
36
### Iteration 2 – Supports Azure AD roles and Azure resource roles
37
37
38
-
Under the /beta/privilegedAccess endpoint, Microsoft supported both /aadRoles and /azureResources. This endpoint is still available in your tenant but Microsoft recommends against starting any new development with this API. This beta API will never be released to general availability and will be eventually deprecated.
38
+
Under the `/beta/privilegedAccess` endpoint, Microsoft supported both `/aadRoles` and `/azureResources`. This endpoint is still available in your tenant but Microsoft recommends against starting any new development with this API. This beta API will never be released to general availability and will be eventually deprecated.
39
39
40
40
### Current iteration – Azure AD roles in Microsoft Graph and Azure resource roles in Azure Resource Manager
41
41
42
-
Now in beta, Microsoft has the final iteration of the PIM API before we release the API to general availability. Based on customer feedback, the Azure AD PIM API is now under the unifiedRoleManagement set of API and the Azure Resource PIM API is now under the Azure Resource Manager role assignment API. These locations also provide a few additional benefits including:
42
+
Currently in general availability, this is the final iteration of the PIM API. Based on customer feedback, the PIM API for managing Azure AD roles is now under the **unifiedRoleManagement** set of APIs and the Azure Resource PIM API is now under the Azure Resource Manager role assignment API. These locations also provide a few additional benefits including:
43
43
44
44
- Alignment of the PIM API for regular role assignment API for both Azure AD roles and Azure Resource roles.
45
45
- Reducing the need to call additional PIM API to onboard a resource, get a resource, or get role definition.
@@ -52,16 +52,13 @@ In the current iteration, there is no API support for PIM alerts and privileged
52
52
53
53
### Azure AD roles
54
54
55
-
To call the PIM Graph API for Azure AD roles, you will need at least one of the following permissions:
55
+
To understand the permissions that you need to call the PIM Microsoft Graph API for Azure AD roles, see [Role management permissions](/graph/permissions-reference#role-management-permissions).
56
56
57
-
- RoleManagement.ReadWrite.Directory
58
-
- RoleManagement.Read.Directory
59
-
60
-
The easiest way to specify the required permissions is to use the Azure AD consent framework.
57
+
The easiest way to specify the required permissions is to use the Azure AD consent framework.
61
58
62
59
### Azure resource roles
63
60
64
-
The PIM API for Azure resource roles is developed on top of the Azure Resource Manager framework. You will need to give consent to Azure Resource Management but won’t need any Graph API permission. You will also need to make sure the user or the service principal calling the API has at least the Owner or User Access Administrator role on the resource you are trying to administer.
61
+
The PIM API for Azure resource roles is developed on top of the Azure Resource Manager framework. You will need to give consent to Azure Resource Management but won’t need any Microsoft Graph API permission. You will also need to make sure the user or the service principal calling the API has at least the Owner or User Access Administrator role on the resource you are trying to administer.
65
62
66
63
## Calling PIM API with an app-only token
67
64
@@ -80,52 +77,59 @@ In the current iteration, there is no API support for PIM alerts and privileged
80
77
81
78
PIM API consists of two categories that are consistent for both the API for Azure AD roles and Azure resource roles: assignment and activation API requests, and policy settings.
82
79
83
-
### Assignment and activation API
80
+
### Assignment and activation APIs
84
81
85
-
To make eligible assignments, time-bound eligible/active assignments, and to activate assignments, PIM provides the following entities:
82
+
To make eligible assignments, time-bound eligible or active assignments, and to activate eligible assignments, PIM provides the following resources:
These entities work alongside pre-existing roleDefinition and roleAssignment entities for both Azure AD roles and Azure roles to allow you to create end to end scenarios.
87
+
These entities work alongside pre-existing **roleDefinition** and **roleAssignment** resources for both Azure AD roles and Azure roles to allow you to create end to end scenarios.
95
88
96
89
- If you are trying to create or retrieve a persistent (active) role assignment that does not have a schedule (start or end time), you should avoid these PIM entities and focus on the read/write operations under the roleAssignment entity
97
90
98
-
- To create an eligible assignment with or without an expiration time you can use the write operation on roleEligibilityScheduleRequest
91
+
- To create an eligible assignment with or without an expiration time you can use the write operation on the [unifiedRoleEligibilityScheduleRequest](/graph/api/resources/unifiedroleeligibilityschedulerequest) resource
92
+
93
+
- To create a persistent (active) assignment with a schedule (start or end time), you can use the write operation on the [unifiedRoleAssignmentScheduleRequest](/graph/api/resources/unifiedroleassignmentschedulerequest) resource
94
+
95
+
- To activate an eligible assignment, you should also use the [write operation on roleAssignmentScheduleRequest](/graph/api/rbacapplication-post-roleassignmentschedulerequests) with a `selfActivate`**action** property.
99
96
100
-
- To create a persistent (active) assignment with a schedule (start or end time), you can use the write operation on roleAssignmentScheduleRequest
97
+
Each of the request objects would create the following read-only objects:
101
98
102
-
- To activate an eligible assignment, you should also use the write operation on roleAssignmentScheduleRequest with a modified action parameter called selfActivate
Each of the request objects would either create a roleAssignmentSchedule or a roleEligibilitySchedule object. These objects are read-only and show a schedule of all the current and future assignments.
104
+
The **unifiedRoleAssignmentSchedule** and **unifiedRoleEligibilitySchedule** objects show a schedule of all the current and future assignments.
105
105
106
-
When an eligible assignment is activated, the roleEligibilityScheduleInstance continues to exist. The roleAssignmentScheduleRequest for the activation would create a separate roleAssignmentSchedule and roleAssignmentScheduleInstance for that activated duration.
106
+
When an eligible assignment is activated, the **unifiedRoleEligibilityScheduleInstance** continues to exist. The **unifiedRoleAssignmentScheduleRequest** for the activation would create a separate **unifiedRoleAssignmentSchedule** object and a **unifiedRoleAssignmentScheduleInstance** for that activated duration.
107
107
108
108
The instance objects are the actual assignments that currently exist whether it is an eligible assignment or an active assignment. You should use the GET operation on the instance entity to retrieve a list of eligible assignments / active assignments to a role/user.
109
109
110
-
### Policy setting API
110
+
For more information about assignment and activation APIs, see [PIM API for managing role assignments and eligibilities](/graph/api/resources/privilegedidentitymanagementv3-overview#pim-api-for-managing-role-assignment).
111
+
112
+
### Policy settings APIs
113
+
114
+
To manage the settings of Azure AD roles, we provide the following entities:
111
115
112
-
To manage the setting, we provide the following entities:
The [unifiedroleManagementPolicy](/graph/api/resources/unifiedrolemanagementpolicy) resource through it's **rules** relationship defines the rules or settings of the Azure AD role. For example, whether MFA/approval is required, whether and who to send the email notifications to, or whether permanent assignments are allowed or not. The [unifiedroleManagementPolicyAssignment](/graph/api/resources/unifiedrolemanagementpolicyassignment) object attaches the policy to a specific role.
116
120
117
-
The *role management policy* defines the setting of the rule. For example, whether MFA/approval is required, whether and who to send the email notifications to, or whether permanent assignments are allowed or not. The *policy assignment* attaches the policy to a specific role.
121
+
Use the APIs supported by these resources retrieve role management policy assignments for all Azure AD role or filter the list by a **roleDefinitionId**, and then update the rules or settings in the policy associated with the Azure AD role.
118
122
119
-
Use this API is to get a list of all the roleManagementPolicyAssignments, filter it by the roleDefinitionID you want to modify, and then update the policy associated with the policyAssignment.
123
+
For more information about the policy settings APIs, see [role settings and PIM](/graph/api/resources/privilegedidentitymanagementv3-overview#role-settings-and-pim).
120
124
121
125
## Relationship between PIM entities and role assignment entities
122
126
123
-
The only link between the PIM entity and the role assignment entity for persistent (active) assignment for either Azure AD roles or Azure roles is the roleAssignmentScheduleInstance. There is a one-to-one mapping between the two entities. That mapping means roleAssignment and roleAssignmentScheduleInstance would both include:
127
+
The only link between the PIM entity and the role assignment entity for persistent (active) assignment for either Azure AD roles or Azure roles is the unifiedRoleAssignmentScheduleInstance. There is a one-to-one mapping between the two entities. That mapping means roleAssignment and unifiedRoleAssignmentScheduleInstance would both include:
124
128
125
129
- Persistent (active) assignments made outside of PIM
126
130
- Persistent (active) assignments with a schedule made inside PIM
127
131
- Activated eligible assignments
128
132
129
133
## Next steps
130
134
131
-
-[Azure AD Privileged Identity Management API reference](/graph/api/resources/privilegedidentitymanagement-root?view=graph-rest-beta&preserve-view=true)
135
+
-[Azure AD Privileged Identity Management API reference](/graph/api/resources/privilegedidentitymanagementv3-overview)
0 commit comments