Skip to content

Commit 6ee76bf

Browse files
authored
Merge pull request #231210 from dlepow/wsown
[APIM] Update workspace roles
2 parents b550f57 + c8f5837 commit 6ee76bf

File tree

4 files changed

+17
-20
lines changed

4 files changed

+17
-20
lines changed

articles/api-management/api-management-in-workspace.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This article is an introduction to managing APIs, products, subscriptions, and o
2525

2626
* An API Management instance. If needed, ask an administrator to [create one](get-started-create-service-instance.md).
2727
* A workspace. If needed, ask an administrator of your API Management instance to [create one](how-to-create-workspace.md).
28-
* Permissions to collaborate in the workspace. If needed, ask a workspace owner to assign you appropriate [roles](api-management-role-based-access-control.md#built-in-workspace-roles) in the workspace.
28+
* Permissions to collaborate in the workspace. If needed, ask an administrator of your API Management instance to assign you appropriate [roles](api-management-role-based-access-control.md#built-in-workspace-roles) in the service and the workspace.
2929

3030
## Go to the workspace - portal
3131

articles/api-management/api-management-role-based-access-control.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,11 @@ A workspace collaborator must be assigned both a workspace-scoped role and a ser
4444

4545
|Role |Scope |Description |
4646
|---------|---------|---------|
47-
|API Management Workspace Owner | workspace | Can modify workspace details, manage members and their role assignments; has read and write access to all entities within the workspace. This role should be assigned on the workspace scope. |
4847
|API Management Workspace Contributor | workspace | Can manage the workspace and view, but not modify its members. This role should be assigned on the workspace scope. |
4948
|API Management Workspace Reader | workspace | Has read-only access to entities in the workspace. This role should be assigned on the workspace scope. |
5049
|API Management Workspace API Developer | workspace | Has read access to entities in the workspace and read and write access to entities for editing APIs. This role should be assigned on the workspace scope. |
5150
|API Management Workspace API Product Manager | workspace | Has read access to entities in the workspace and read and write access to entities for publishing APIs. This role should be assigned on the workspace scope. |
52-
| API Management Workspace API Developer | service | Has read access to tags and products and write access to allow: <br/><br/> ▪️ Assigning APIs to products<br/> ▪️ Assigning tags to products and APIs<br/><br/> This role should be assigned on the service scope. |
51+
| API Management Service Workspace API Developer | service | Has read access to tags and products and write access to allow: <br/><br/> ▪️ Assigning APIs to products<br/> ▪️ Assigning tags to products and APIs<br/><br/> This role should be assigned on the service scope. |
5352
| API Management Service Workspace API Product Manager | service | Has the same access as API Management Service Workspace API Developer as well as read access to users and write access to allow assigning users to groups. This role should be assigned on the service scope. |
5453

5554

articles/api-management/how-to-create-workspace.md

Lines changed: 9 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -39,37 +39,33 @@ The new workspace appears in the list on the **Workspaces** page. Select the wor
3939

4040
## Assign users to workspace - portal
4141

42-
After creating a workspace, assign permissions to users to manage the workspace's resources. Each workspace user must be assigned a workspace-specific RBAC role at the service level and at the workspace level, or granted equivalent permissions using custom roles.
42+
After creating a workspace, assign permissions to users to manage the workspace's resources. Each workspace user must be assigned both a service-scoped workspace RBAC role and a workspace-scoped RBAC role, or granted equivalent permissions using custom roles.
4343

44-
At minimum, assign an *owner* of the workspace. Optionally, assign permissions to other workspace collaborators.
44+
> [!NOTE]
45+
> For easier management, set up Azure AD groups to assign workspace permissions to multiple users.
46+
>
4547
4648
* For a list of built-in workspace roles, see [How to use role-based access control in API Management](api-management-role-based-access-control.md).
4749
* For steps to assign a role, see [Assign Azure roles using the portal](../role-based-access-control/role-assignments-portal.md?tabs=current).
4850

4951

50-
### Assign a service-level role
52+
### Assign a service-scoped role
5153

5254
1. Sign in to the [Azure portal](https://portal.azure.com), and navigate to your API Management instance.
5355

5456
1. In the left menu, select **Access control (IAM)** > **+ Add**.
5557

56-
1. Assign the owner the following role:
57-
* **API Management Service Workspace API Product Manager**
58+
1. Assign one of the following service-scoped roles to each member of the workspace:
5859

59-
1. Assign one of the following roles to other members of the workspace:
60-
* **API Management Workspace API Developer**
60+
* **API Management Service Workspace API Developer**
6161
* **API Management Service Workspace API Product Manager**
6262

63-
### Assign a workspace-level role
63+
### Assign a workspace-scoped role
6464

6565
1. In the menu for your API Management instance, select **Workspaces (preview)** > the name of the workspace that you created.
6666
1. In the **Workspace** window, select **Access control (IAM)**> **+ Add**.
6767

68-
1. Assign the owner the following role:
69-
70-
* **API Management Workspace Owner**
71-
72-
1. Optionally, assign one of the following workspace-level roles to other workspace members to manage workspace APIs and other resources. The owner of the workspace can also assign workspace-level roles.
68+
1. Assign one of the following workspace-scoped roles to the workspace members to manage workspace APIs and other resources.
7369

7470
* **API Management Workspace Reader**
7571
* **API Management Workspace Contributor**

articles/api-management/workspaces-overview.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,10 @@ An organization that manages APIs using Azure API Management may have multiple d
3131

3232
The following is a sample workflow for creating and using a workspace.
3333

34-
1. A central API platform team that manages the API Management instance creates a workspace and assigns its owners and workspace members.
34+
1. A central API platform team that manages the API Management instance creates a workspace and assigns permissions to workspace collaborators using RBAC roles - for example, permissions to create or read resources in the workspace.
3535

3636
1. A central API platform team uses DevOps tools to create a DevOps pipeline for APIs in that workspace.
3737

38-
1. Workspace owners assign permissions to workspace members using RBAC roles - for example, permissions to create or read resources in the workspace.
39-
4038
1. Workspace members develop, publish, productize, and maintain APIs in the workspace.
4139

4240
1. The central API platform team manages the infrastructure of the service, such as network connectivity, monitoring, resiliency, and enforcement of all-APIs policies.
@@ -83,7 +81,11 @@ The following resources can be managed in the workspaces preview.
8381

8482
Azure RBAC is used to configure workspace collaborators' permissions to read and edit entities in the workspace. For a list of roles, see [How to use role-based access control in API Management](api-management-role-based-access-control.md).
8583

86-
Workspace members must be assigned both a service-level role and a workspace-level role, or granted equivalent permissions using custom roles. The service-level role enables referencing service-level resources from workspace-level resources. For example, publish an API from a workspace with a service-level product, assign a service-level tag to an API, or organize a user into a workspace-level group to control API and product visibility.
84+
Workspace members must be assigned both a service-scoped role and a workspace-scoped role, or granted equivalent permissions using custom roles. The service-scoped role enables referencing service-level resources from workspace-level resources. For example, publish an API from a workspace with a service-level product, assign a service-level tag to an API, or organize a user into a workspace-level group to control API and product visibility.
85+
86+
> [!NOTE]
87+
> For easier management, set up Azure AD groups to assign workspace permissions to multiple users.
88+
>
8789
8890
## Workspaces and other API Management features
8991

0 commit comments

Comments
 (0)