Skip to content

Commit e30cbff

Browse files
committed
fix(8.8, 8.9): improve style consistency in external IdP via internal Keycloak guide
1 parent 7c25d0a commit e30cbff

File tree

2 files changed

+22
-24
lines changed

2 files changed

+22
-24
lines changed

docs/self-managed/deployment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For details on Keycloak identity provider mappers, see the [Keycloak documentati
4141

4242
#### Create attribute mappers
4343

44-
In Keycloak Admin Console, navigate to **Identity Providers** select your IdP **Mappers** tab.
44+
In Keycloak Admin Console, navigate to **Identity Providers** > select your IdP > **Mappers** tab.
4545

4646
Create attribute mappers to import user profile information:
4747

@@ -60,7 +60,7 @@ Create a username mapper:
6060

6161
#### Create group for external IdP users
6262

63-
Navigate to **Groups** **Create group** and create a group:
63+
Navigate to **Groups** > **Create group** and create a group:
6464

6565
- **Name**: `external-idp-users`
6666

@@ -82,7 +82,7 @@ Log in to **Orchestration Cluster Identity** as an administrator.
8282

8383
Create a mapping rule to identify external IdP users:
8484

85-
1. Navigate to **Mapping Rules** **Create a mapping rule**.
85+
1. Navigate to **Mapping Rules** > **Create a mapping rule**.
8686
1. Configure the mapping rule:
8787
- **Mapping Rule ID**: `external-idp-users-rule`
8888
- **Mapping Rule name**: `External IdP Users`
@@ -93,7 +93,7 @@ Create a mapping rule to identify external IdP users:
9393

9494
Grant access to Orchestration Cluster components:
9595

96-
1. Navigate to **Authorizations** select **Component** **Create authorization**.
96+
1. Navigate to **Authorizations** > select **Component** > **Create authorization**.
9797
1. Configure the authorization:
9898
- **Owner type**: `Mapping rule`
9999
- **Owner ID**: `external-idp-users-rule`
@@ -113,7 +113,7 @@ Grant additional permissions as needed. For example, to allow users to view proc
113113
For more details on authorizations, see [Orchestration Cluster authorization](/components/concepts/access-control/authorizations.md).
114114
:::
115115

116-
### Configure Management Identity access (optional)
116+
### Configure Management Identity access (Optional)
117117

118118
For access to Console, Web Modeler, and Optimize, external IdP users need the corresponding realm roles assigned in Keycloak. The recommended approach is to assign users to groups that have these roles.
119119

@@ -126,14 +126,14 @@ For access to Console, Web Modeler, and Optimize, external IdP users need the co
126126

127127
Ensure each group has the corresponding realm role assigned:
128128

129-
1. Select the group **Role Mappings** tab.
129+
1. Select the group > **Role Mappings** tab.
130130
1. Click **Assign role** and add the role with the same name (e.g., `Console`).
131131

132132
#### Create group mappers
133133

134134
Create mappers to assign federated users to these groups:
135135

136-
1. Navigate to **Identity Providers** select your IdP **Mappers** tab.
136+
1. Navigate to **Identity Providers** > select your IdP > **Mappers** tab.
137137
1. Click **Add mapper** for each component:
138138

139139
| Mapper Name | Mapper Type | Group |
@@ -148,14 +148,13 @@ You can also assign roles directly to users in Keycloak, or use [mapping rules i
148148

149149
## Understanding the two identity systems
150150

151-
Camunda 8.8 uses two separate identity systems:
151+
Camunda 8.8 uses two separate identity systems: Orchestration Cluster Identity and Management Identity. Each system manages access to different components and uses different configuration methods.
152152

153-
| System | Components | Configuration Method |
154-
| ------------------------------ | ------------------------------------ | -------------------------------- |
155-
| Orchestration Cluster Identity | Operate, Tasklist, Identity UI, APIs | Mapping rules and authorizations |
156-
| Management Identity | Console, Web Modeler, Optimize | Keycloak groups and roles |
153+
For a detailed explanation of the differences between these identity systems, see [Identity types in Camunda 8](/components/concepts/access-control/access-control-overview.md#identity-types-in-camunda-8).
157154

155+
:::note
158156
Orchestration Cluster Identity does not automatically recognize Keycloak groups. You must create mapping rules that match JWT claims and then assign authorizations to those mapping rules.
157+
:::
159158

160159
## Next steps
161160

versioned_docs/version-8.8/self-managed/deployment/helm/configure/authentication-and-authorization/external-idp-via-internal-keycloak.md

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ For details on Keycloak identity provider mappers, see the [Keycloak documentati
4141

4242
#### Create attribute mappers
4343

44-
In Keycloak Admin Console, navigate to **Identity Providers** select your IdP **Mappers** tab.
44+
In Keycloak Admin Console, navigate to **Identity Providers** > select your IdP > **Mappers** tab.
4545

4646
Create attribute mappers to import user profile information:
4747

@@ -60,7 +60,7 @@ Create a username mapper:
6060

6161
#### Create group for external IdP users
6262

63-
Navigate to **Groups** **Create group** and create a group:
63+
Navigate to **Groups** > **Create group** and create a group:
6464

6565
- **Name**: `external-idp-users`
6666

@@ -82,7 +82,7 @@ Log in to **Orchestration Cluster Identity** as an administrator.
8282

8383
Create a mapping rule to identify external IdP users:
8484

85-
1. Navigate to **Mapping Rules** **Create a mapping rule**.
85+
1. Navigate to **Mapping Rules** > **Create a mapping rule**.
8686
1. Configure the mapping rule:
8787
- **Mapping Rule ID**: `external-idp-users-rule`
8888
- **Mapping Rule name**: `External IdP Users`
@@ -93,7 +93,7 @@ Create a mapping rule to identify external IdP users:
9393

9494
Grant access to Orchestration Cluster components:
9595

96-
1. Navigate to **Authorizations** select **Component** **Create authorization**.
96+
1. Navigate to **Authorizations** > select **Component** > **Create authorization**.
9797
1. Configure the authorization:
9898
- **Owner type**: `Mapping rule`
9999
- **Owner ID**: `external-idp-users-rule`
@@ -113,7 +113,7 @@ Grant additional permissions as needed. For example, to allow users to view proc
113113
For more details on authorizations, see [Orchestration Cluster authorization](/components/concepts/access-control/authorizations.md).
114114
:::
115115

116-
### Configure Management Identity access (optional)
116+
### Configure Management Identity access (Optional)
117117

118118
For access to Console, Web Modeler, and Optimize, external IdP users need the corresponding realm roles assigned in Keycloak. The recommended approach is to assign users to groups that have these roles.
119119

@@ -126,14 +126,14 @@ For access to Console, Web Modeler, and Optimize, external IdP users need the co
126126

127127
Ensure each group has the corresponding realm role assigned:
128128

129-
1. Select the group **Role Mappings** tab.
129+
1. Select the group > **Role Mappings** tab.
130130
1. Click **Assign role** and add the role with the same name (e.g., `Console`).
131131

132132
#### Create group mappers
133133

134134
Create mappers to assign federated users to these groups:
135135

136-
1. Navigate to **Identity Providers** select your IdP **Mappers** tab.
136+
1. Navigate to **Identity Providers** > select your IdP > **Mappers** tab.
137137
1. Click **Add mapper** for each component:
138138

139139
| Mapper Name | Mapper Type | Group |
@@ -148,14 +148,13 @@ You can also assign roles directly to users in Keycloak, or use [mapping rules i
148148

149149
## Understanding the two identity systems
150150

151-
Camunda 8.8 uses two separate identity systems:
151+
Camunda 8.8 uses two separate identity systems: Orchestration Cluster Identity and Management Identity. Each system manages access to different components and uses different configuration methods.
152152

153-
| System | Components | Configuration Method |
154-
| ------------------------------ | ------------------------------------ | -------------------------------- |
155-
| Orchestration Cluster Identity | Operate, Tasklist, Identity UI, APIs | Mapping rules and authorizations |
156-
| Management Identity | Console, Web Modeler, Optimize | Keycloak groups and roles |
153+
For a detailed explanation of the differences between these identity systems, see [Identity types in Camunda 8](/components/concepts/access-control/access-control-overview.md#identity-types-in-camunda-8).
157154

155+
:::note
158156
Orchestration Cluster Identity does not automatically recognize Keycloak groups. You must create mapping rules that match JWT claims and then assign authorizations to those mapping rules.
157+
:::
159158

160159
## Next steps
161160

0 commit comments

Comments
 (0)