Skip to content

Commit dee51b7

Browse files
authored
Merge pull request #198510 from MicrosoftDocs/main
5/17 AM Publishing
2 parents a4f71f0 + fb432b0 commit dee51b7

File tree

817 files changed

+5617
-3944
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

817 files changed

+5617
-3944
lines changed

articles/active-directory/index.yml

Lines changed: 170 additions & 292 deletions
Large diffs are not rendered by default.

articles/active-directory/privileged-identity-management/TOC.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -110,8 +110,8 @@
110110
href: pim-troubleshoot.md
111111
- name: Reference
112112
items:
113-
- name: Graph API
114-
href: /graph/api/resources/azure-ad-overview
113+
- name: Microsoft Graph API
114+
href: /graph/api/resources/privilegedidentitymanagementv3-overview
115115
- name: Azure AD CLI
116116
href: /cli/azure/ad
117117
- name: Azure AD PowerShell for Graph

articles/active-directory/privileged-identity-management/azure-ad-pim-approval-workflow.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,19 +37,19 @@ As a delegated approver, you'll receive an email notification when an Azure AD r
3737

3838
In the **Requests for role activations** section, you'll see a list of requests pending your approval.
3939

40-
## View pending requests using Graph API
40+
## View pending requests using Microsoft Graph API
4141

4242
### HTTP request
4343

4444
````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'
4646
````
4747

4848
### HTTP response
4949

5050
````HTTP
5151
{
52-
"@odata.context": "https://graph.microsoft.com/beta/$metadata#Collection(unifiedRoleAssignmentScheduleRequest)",
52+
"@odata.context": "https://graph.microsoft.com/v1.0/$metadata#Collection(unifiedRoleAssignmentScheduleRequest)",
5353
"value": [
5454
{
5555
"@odata.type": "#microsoft.graph.unifiedRoleAssignmentScheduleRequest",
@@ -105,7 +105,7 @@ GET https://graph.microsoft.com/beta/roleManagement/directory/roleAssignmentSche
105105

106106
![Approve notification showing request was approved](./media/pim-resource-roles-approval-workflow/resources-approve-pane.png)
107107

108-
## Approve pending requests using Graph API
108+
## Approve pending requests using Microsoft Graph API
109109

110110
### Get IDs for the steps that require approval
111111

articles/active-directory/privileged-identity-management/pim-apis.md

Lines changed: 35 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can perform Privileged Identity Management (PIM) tasks using the Microsoft G
2222

2323
For requests and other details about PIM APIs, check out:
2424

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)
2626
- [PIM for Azure resource roles API reference](/rest/api/authorization/roleeligibilityschedulerequests)
2727

2828
## PIM API history
@@ -35,11 +35,11 @@ Under the /beta/privilegedRoles endpoint, Microsoft had a classic version of the
3535

3636
### Iteration 2 – Supports Azure AD roles and Azure resource roles
3737

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.
3939

4040
### Current iteration – Azure AD roles in Microsoft Graph and Azure resource roles in Azure Resource Manager
4141

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:
4343

4444
- Alignment of the PIM API for regular role assignment API for both Azure AD roles and Azure Resource roles.
4545
- 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
5252

5353
### Azure AD roles
5454

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).
5656

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.
6158

6259
### Azure resource roles
6360

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.
6562

6663
## Calling PIM API with an app-only token
6764

@@ -80,52 +77,59 @@ In the current iteration, there is no API support for PIM alerts and privileged
8077

8178
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.
8279

83-
### Assignment and activation API
80+
### Assignment and activation APIs
8481

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:
8683

87-
- RoleAssignmentSchedule
88-
- RoleEligibilitySchedule
89-
- RoleAssignmentScheduleInstance
90-
- RoleEligibilityScheduleInstance
91-
- RoleAssignmentScheduleRequest
92-
- RoleEligibilityScheduleRequest
84+
- [unifiedRoleAssignmentScheduleRequest](/graph/api/resources/unifiedroleassignmentschedulerequest)
85+
- [unifiedRoleEligibilityScheduleRequest](/graph/api/resources/unifiedroleeligibilityschedulerequest)
9386

94-
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.
9588

9689
- 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
9790

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.
9996

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:
10198

102-
- To activate an eligible assignment, you should also use the write operation on roleAssignmentScheduleRequest with a modified action parameter called selfActivate
99+
- [unifiedRoleAssignmentSchedule](/graph/api/resources/unifiedroleassignmentschedule)
100+
- [unifiedRoleEligibilitySchedule](/graph/api/resources/unifiedroleeligibilityschedule)
101+
- [unifiedRoleAssignmentScheduleInstance](/graph/api/resources/unifiedroleassignmentscheduleinstance)
102+
- [unifiedRoleEligibilityScheduleInstance](/graph/api/resources/unifiedroleeligibilityscheduleinstance)
103103

104-
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.
105105

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.
107107

108108
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.
109109

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:
111115

112-
To manage the setting, we provide the following entities:
116+
- [unifiedroleManagementPolicy](/graph/api/resources/unifiedrolemanagementpolicy)
117+
- [unifiedroleManagementPolicyAssignment](/graph/api/resources/unifiedrolemanagementpolicyassignment)
113118

114-
- roleManagementPolicy
115-
- roleManagementPolicyAssignment
119+
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.
116120

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.
118122

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).
120124

121125
## Relationship between PIM entities and role assignment entities
122126

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:
124128

125129
- Persistent (active) assignments made outside of PIM
126130
- Persistent (active) assignments with a schedule made inside PIM
127131
- Activated eligible assignments
128132

129133
## Next steps
130134

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

Comments
 (0)