|
| 1 | +:_mod-docs-content-type: CONCEPT |
| 2 | + |
| 3 | +[id="using-rbac-with-quickstarts_{context}"] |
| 4 | += About access to Quickstarts with Role-Based Access Control (RBAC) |
| 5 | +You can control user access to Quickstarts by using RBAC to define user roles that use the following logic in your RBAC configuration: |
| 6 | + |
| 7 | +* If RBAC is enabled (`permission.enabled: true`), the system determines user roles based on permissions, as follows: |
| 8 | +** Users with `policy.entity.create` permission are assigned the admin role. |
| 9 | +** Users without this permission are assigned the developer role. |
| 10 | + |
| 11 | +[NOTE] |
| 12 | +==== |
| 13 | +If RBAC is disabled (`permission.enabled: false`) or not configured, users are assumed to be platform engineers setting up {product} ({product-very-short}) and are assigned the admin role. |
| 14 | +==== |
| 15 | + |
| 16 | +The following two roles are supported for defining access to Quickstarts: |
| 17 | + |
| 18 | +admin:: Platform engineers, administrators, and users with elevated permissions |
| 19 | +developer:: Regular developers and users with standard permissions |
| 20 | + |
| 21 | +The following behavior applies when you use RBAC to assign roles for your Quickstarts: |
| 22 | + |
| 23 | +* Quickstart items without a `roles` property default to the admin role. |
| 24 | +* Items can specify multiple roles, for example, admin and developer. |
| 25 | +* Users see Quickstart items that match their assigned role. |
| 26 | + |
| 27 | +.Example configuring RBAC for a Quickstart in your {my-app-config-file} file |
| 28 | + |
| 29 | +[source,yaml] |
| 30 | +---- |
| 31 | +permission: |
| 32 | + enabled: true |
| 33 | +
|
| 34 | +app: |
| 35 | + quickstart: |
| 36 | + - title: 'Platform Configuration' |
| 37 | + titleKey: steps.platformConfiguration.title |
| 38 | + roles: ['admin'] |
| 39 | + # Only admins see this |
| 40 | + - title: 'Getting Started as Developer' |
| 41 | + titleKey: steps.gettingStarted.title |
| 42 | + roles: ['developer'] |
| 43 | + # Only developers see this |
| 44 | + - title: 'Universal Welcome Guide' |
| 45 | + titleKey: steps.universalWelcome.title |
| 46 | + roles: ['admin', 'developer'] |
| 47 | + # Both user roles see this |
| 48 | +---- |
0 commit comments