Skip to content

Commit d4cb3bc

Browse files
committed
RHIDP-4896 Determining the permission policy and role configuration source
Signed-off-by: Fabrice Flore-Thébault <[email protected]>
1 parent 0c9aec5 commit d4cb3bc

File tree

2 files changed

+45
-10
lines changed

2 files changed

+45
-10
lines changed

assemblies/assembly-configuring-authorization-in-rhdh.adoc

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -11,25 +11,25 @@ Role-Based Access Control (RBAC) is a security concept that controls access to r
1111
You define roles with specific permissions, and then assign the roles to users and groups.
1212

1313
RBAC on {product-short} is built on top of the Permissions framework, which defines RBAC policies in code.
14-
Rather than defining policies in code,
15-
the {product-short} RBAC feature allows you
16-
to define policies in a declarative fashion using a simple CSV based format.
14+
Rather than defining policies in code, the {product-short} RBAC feature allows you to define policies in a declarative fashion using a simple CSV based format.
1715
You can define the policies by using {product-short} web interface or REST API, rather than editing the CSV directly.
1816

19-
To apply RBAC in {product-short}:
17+
To define authorizations in {product-short}:
2018

21-
. The {product-short} administrator sets up the RBAC feature:
22-
.. Enable the RBAC feature
23-
.. Configure Policy Administrators
19+
. The {product-short} administrator enables and gives access to the RBAC feature.
2420

25-
. The {product-short} policy administrator configures your RBAC policies:
26-
.. Define roles with specific permissions
27-
.. Assign the roles to users and groups
21+
. You define your roles and policies by combining following methods:
2822

23+
* The {product-short} policy administrator uses the {product-short} web interface or REST API.
24+
* The {product-short} administrator edits the main {product-short} configuration file.
25+
* The {product-short} administrator edits external files.
2926

3027
include::modules/authorization/proc-enabling-the-rbac-plugin.adoc[leveloffset=+1]
3128

3229

30+
include::modules/authorization/proc-determining-permission-policy-and-role-configuration-source.adoc[leveloffset=+1]
31+
32+
3333
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
3434

3535

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
[id='proc-determining-policy-and-role-source']
2+
= Determining permission policy and role configuration source
3+
4+
You can configure {product} policy and roles by using different sources.
5+
To maintain data consistency, {product-short} associates each permission policy and role with one unique source.
6+
You can only use this source to change the resource.
7+
8+
The available sources are:
9+
10+
Configuration file::
11+
12+
13+
Configure roles and policies in the {product-short} `app-config.yaml` configuration file, for instance to xref:enabling-and-giving-access-to-rbac[declare your policy administrators].
14+
+
15+
The Configuration file pertains to the default `role:default/rbac_admin` role provided by the RBAC plugin.
16+
The default role has limited permissions to create, read, update, and delete permission policies or roles, and to read catalog entities.
17+
+
18+
[NOTE]
19+
====
20+
In case the default permissions are insufficient for your administrative requirements, you can create a custom admin role with required permission policies.
21+
====
22+
23+
REST API::
24+
Configure roles and policies xref:managing-authorizations-by-using-the-seb-ui[by using the {product-short} Web UI] or xref:managing-authorizations-by-using-the-rest-api[by using the REST API].
25+
26+
CSV file::
27+
Configure roles and policies by using external CSV files.
28+
29+
Legacy::
30+
The legacy source applies to policies and roles defined before RBAC backend plugin version `2.1.3`, and is the least restrictive among the source location options.
31+
+
32+
IMPORTANT: Replace the permissions and roles using the legacy source by permissions using the REST API or the CSV file sources.
33+
34+
.Procedure
35+
* To determine the source of a role or policy, use a `GET` request.

0 commit comments

Comments
 (0)