Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,13 @@ Groups are a way to apply a set of [roles](/self-managed/identity/user-guide/rol

To create a group, take the following steps:

1. Navigate to the **Groups** tab:

![create-group-tab](../img/create-group-tab.png)

2. Click the **Add Group** button located on the top right of the table and a modal will open.

3. Fill in the name of the group and click **Add**:
1. Navigate to the **Groups** tab.

![create-group-modal-2](../img/create-group-modal-2.png)
2. Click the **Create group** button located on the top right of the table and a modal will open.

On confirmation, the modal closes, the table updates, and your new group is shown:
3. Fill in the name of the group and click **Create group**.

![create-group-refreshed-table](../img/create-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your new group is shown.

## Modify or delete a group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,28 @@ description: "Groups are a way to apply a set of roles and authorizations to use
Head over to our documentation on [groups](/self-managed/identity/user-guide/groups/manage-groups.md) to learn more.
:::

## Assign users to a group
## Assign members to a group

:::caution Write access needed
To assign a user to a group, you must have write access to Identity.
Read our [guide on managing user access](/self-managed/identity/user-guide/authorizations/managing-user-access.md) to learn more.
:::

1. Navigate to the **Groups** tab. Select the group you would like to assign a user to from the table:
1. Navigate to the **Groups** tab. Select the group you would like to assign a member to from the table.

![assign-user-to-group-tab](../img/assign-user-to-group-tab.png)
2. Click **Assign members** and a modal will open.

2. Click **Assign Members** and a modal will open.
3. Search and select the member to assign to the group. After selecting the member, click **Assign**.

3. Search and select the users to assign to the group. After selecting the users, click **Assign**.

On confirmation, the modal closes, the table updates, and your assigned members are shown:

![assign-user-to-group-refreshed-table](../img/assign-user-to-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your assigned members are shown.

## Remove a user from a group

1. Navigate to the **Groups** tab.

2. Click the trash icon next to the user you want to remove from the group.
2. Click the trash icon next to the member you want to remove from the group.

On confirmation, the modal closes, the table updates, and your user is removed from the group.
On confirmation, the modal closes, the table updates, and your member is removed from the group.

## Assign roles to a group

Expand All @@ -44,23 +40,19 @@ To assign a role to a group, you must have write access to Identity.
Read our [guide on managing user access](/self-managed/identity/user-guide/authorizations/managing-user-access.md) to learn more.
:::

1. Navigate to the **Groups** tab. Select the group you would like to assign a role to from the table, and click on the **Roles** tab:
1. Navigate to the **Groups** tab. Select the group you would like to assign a role to from the table, and click on the **Roles** tab.

![assign-role-to-group-tab](../img/assign-role-to-group-tab.png)

2. Click **Assign Role** and a modal will open.
2. Click **Assign roles** and a modal will open.

3. Select the roles to assign to the group. When you have selected the roles, click **Add**.

On confirmation, the modal closes, the table updates, and your assigned roles are shown:

![assign-role-to-group-refreshed-table](../img/assign-role-to-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your assigned roles are shown.

## Remove a role from a group

1. Navigate to the **Groups** tab. Select the group.

2. Navigate to **Assigned roles**.
2. Navigate to the **Roles** tab.

3. Click the trash icon next to the user you want to remove from the group.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Permissions are assigned to [APIs](/self-managed/identity/user-guide/additional-
You can create permissions for granular access control over your APIs. Permissions granted to a user or M2M application are added to the `permissions.{audience}` claim of the access token.
:::

## Preset permissions

The preset permissions for Camunda components are:

| Component | Permissions | Descriptions |
Expand All @@ -32,54 +34,48 @@ To assign a permission to a role and assign a role to a user, you need to have w
Read our [guide on managing user access](/self-managed/identity/user-guide/authorizations/managing-user-access.md) to learn more.
:::

## Add and assigning a permission to a role
## Add and assign a permission to a role

:::note
Identity does not check permission definitions for typos or misspelled words.
:::

### Add a permission

To create a permission using Identity, take the following steps:

1. Navigate to the **API** tab:

![add-permission-api-tab](../img/add-api-tab.png)
1. Navigate to the **APIs** tab:

2. Click the API you would like to create a permission for. This will open the details page.

3. Click the **Permissions** tab beneath the API name.

4. Click **Add Permission** located on the top right of the table and a modal will open.
4. Click **Add permission** located on the top right of the table and a modal will open.

5. We are now able to fill out the details of the permission. For this guide, we will use a set of example values. When you have inserted the details, click **Add**:
5. Fill out the [definition](#preset-permissions) and description of the permission. When you have inserted the details, click **Add**.

![add-permission-modal-2](../img/add-permission-modal-2.png)

On confirmation, the modal will close, the table will update, and your new permission will be shown:

![add-permission-refreshed-table](../img/add-permission-refreshed-table.png)
On confirmation, the modal will close, the table will update, and your new permission will be shown.

### Assign a permission to a role

To assign a permission to a role, take the following steps:

1. Navigate to the **Roles** tab, select **Permissions > Assign Permission**:

![assign-a-permission-tab](../img/assign-a-permission-tab.png)

2. Select the API which contains the permission you want to assign.
1. Navigate to the **Roles** tab, click the role, and select **Permissions > Assign permissions**.

3. Select the permission you would like to assign and click **Add**.
2. Select the API which contains the permission(s) you want to assign.

On confirmation, the modal will close, the table will update, and your assigned permission will be shown:
3. Select the permission(s) you would like to assign and click **Add**.

![assign-a-permission-refreshed-table](../img/assign-a-permission-refreshed-table.png)
On confirmation, the modal will close, the table will update, and your assigned permission will be shown.

### Delete a permission from a role

To delete a permission from a role, take the following steps:

1. Navigate to the **Roles** tab.
1. Navigate to the **Roles** tab. Click the role you would like to delete permissions from.

2. Navigate to the **Permissions** tab.

3. Click the trash icon next to the permission you want to remove.

4. On confirmation, the modal will close, the table will update, and the assigned permission will be removed from the role.
On confirmation, the modal will close, the table will update, and the assigned permission will be removed from the role.
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ description: "Use Identity to manage users and roles"

Access to the components within Camunda 8 can be controlled by the roles assigned to a user.

Roles are a way to group sets of [permissions](/self-managed/identity/user-guide/roles/manage-permissions.md) which can be assigned to users using the Identity UI.
Roles are a way to group sets of [permissions](/self-managed/identity/user-guide/roles/manage-permissions.md). Roles can be assigned to users.

:::caution Write access needed
To add and assign a role to a user, you need to have write access to Identity.
Expand All @@ -16,40 +16,52 @@ Read our [guide on managing user access](/self-managed/identity/user-guide/autho

## Add a role

1. Navigate to the **Roles** tab:
To add a role, take the following steps:

![add-role-tab](../img/add-role-tab.png)
1. Navigate to the **Roles** tab.

2. Click the **Add Role** button located on the top right of the table and a modal will open to fill out the details of the role.
2. Click the **Add role** button located on the top right of the table and a modal will open to fill out the name and description.

On confirmation, the modal will close, the table will update, and the new role will be shown.

## Delete a role

Roles can be deleted in two ways: through the trash button in the table view, or in the overflow menu once the role is selected.

1. Navigate to the **Roles** tab.

2. Search for a role by clicking the magnifying glass next to **Add role**.

3. Click the trash button next to the role or click the role, click the overflow menu, then **Delete**.

On confirmation, the modal will close, the table will update, and the role will be removed.

## Assign a role to a user

To assign a role to a user using Identity, take the following steps:
To assign a role to a user, take the following steps:

1. Navigate to the **Users** tab.

2. Click on the user you want to assign a role to to view their details.

3. Click on **Assigned Roles** to view the roles currently assigned to the user.
3. Click on **Assigned roles** to view the roles currently assigned to the user.

4. Click the **Assign Role** button located on the top right of the table and a modal will open.
4. Click the **Assign roles** button located on the top right of the table and a modal will open.

5. Select the role you want to assign to the user and click **Add**.

On confirmation, the modal will close, the table will update, and the newly assigned role will be shown:
On confirmation, the modal will close, the table will update, and the newly assigned role will be shown for the user.

![assign-a-role-refreshed-table](../img/assign-a-role-refreshed-table.png)
## Delete an assigned role from a user

## Delete a role

To delete a role from a user, take the following steps:
To delete an assigned role from a user, take the following steps:

1. Navigate to the **Users** tab.

2. Click on the user you want to remove a role from to view their details.

3. Click on **Assigned Roles** to view the roles currently assigned to the user.
3. Click on **Assigned roles** to view the roles currently assigned to the user.

4. Click the trash icon next to the role.

On confirmation, the modal will close, the table will update, and the role will be removed.
On confirmation, the modal will close, the table will update, and the role will be removed from the user.
Original file line number Diff line number Diff line change
Expand Up @@ -10,19 +10,13 @@ Groups are a way to apply a set of [roles](/self-managed/identity/user-guide/rol

To create a group, take the following steps:

1. Navigate to the **Groups** tab:

![create-group-tab](../img/create-group-tab.png)

2. Click the **Add Group** button located on the top right of the table and a modal will open.

3. Fill in the name of the group and click **Add**:
1. Navigate to the **Groups** tab.

![create-group-modal-2](../img/create-group-modal-2.png)
2. Click the **Create group** button located on the top right of the table and a modal will open.

On confirmation, the modal closes, the table updates, and your new group is shown:
3. Fill in the name of the group and click **Create group**.

![create-group-refreshed-table](../img/create-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your new group is shown.

## Modify or delete a group

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,32 +10,28 @@ description: "Groups are a way to apply a set of roles and authorizations to use
Head over to our documentation on [groups](/self-managed/identity/user-guide/groups/manage-groups.md) to learn more.
:::

## Assign users to a group
## Assign members to a group

:::caution Write access needed
To assign a user to a group, you must have write access to Identity.
Read our [guide on managing user access](/self-managed/identity/user-guide/authorizations/managing-user-access.md) to learn more.
:::

1. Navigate to the **Groups** tab. Select the group you would like to assign a user to from the table:
1. Navigate to the **Groups** tab. Select the group you would like to assign a member to from the table.

![assign-user-to-group-tab](../img/assign-user-to-group-tab.png)
2. Click **Assign members** and a modal will open.

2. Click **Assign Members** and a modal will open.
3. Search and select the member to assign to the group. After selecting the member, click **Assign**.

3. Search and select the users to assign to the group. After selecting the users, click **Assign**.

On confirmation, the modal closes, the table updates, and your assigned members are shown:

![assign-user-to-group-refreshed-table](../img/assign-user-to-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your assigned members are shown.

## Remove a user from a group

1. Navigate to the **Groups** tab.

2. Click the trash icon next to the user you want to remove from the group.
2. Click the trash icon next to the member you want to remove from the group.

On confirmation, the modal closes, the table updates, and your user is removed from the group.
On confirmation, the modal closes, the table updates, and your member is removed from the group.

## Assign roles to a group

Expand All @@ -44,23 +40,19 @@ To assign a role to a group, you must have write access to Identity.
Read our [guide on managing user access](/self-managed/identity/user-guide/authorizations/managing-user-access.md) to learn more.
:::

1. Navigate to the **Groups** tab. Select the group you would like to assign a role to from the table, and click on the **Roles** tab:
1. Navigate to the **Groups** tab. Select the group you would like to assign a role to from the table, and click on the **Roles** tab.

![assign-role-to-group-tab](../img/assign-role-to-group-tab.png)

2. Click **Assign Role** and a modal will open.
2. Click **Assign roles** and a modal will open.

3. Select the roles to assign to the group. When you have selected the roles, click **Add**.

On confirmation, the modal closes, the table updates, and your assigned roles are shown:

![assign-role-to-group-refreshed-table](../img/assign-role-to-group-refreshed-table.png)
On confirmation, the modal closes, the table updates, and your assigned roles are shown.

## Remove a role from a group

1. Navigate to the **Groups** tab. Select the group.

2. Navigate to **Assigned roles**.
2. Navigate to the **Roles** tab.

3. Click the trash icon next to the user you want to remove from the group.

Expand Down
Loading
Loading