Skip to content

Commit 48103fa

Browse files
authored
Merge branch 'main' into RHIDP-3976
2 parents 168e7bd + 2e353e8 commit 48103fa

12 files changed

+311
-205
lines changed

.github/pull_request_template.md

Lines changed: 2 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -6,23 +6,7 @@
66

77
**Version(s):**
88
<!--- Specify the version(s) of RHDH that your PR applies to. -->
9-
9+
Add the relevant labels to the Pull Request.
1010
**Issue:**
11-
<!--- Add a link to the Bugzilla, Jira, or GitHub issue. --->
12-
13-
**Link to docs preview:**
14-
<!--- Add direct link(s) to the exact page(s) that contain the updated content from the preview build. --->
15-
16-
**Reviews:**
17-
- [ ] SME: @ mention assignee
18-
- [ ] QE: @ mention assignee
19-
- [ ] Docs review: @ mention assignee
20-
- [ ] Additional review: @mention assignee (by writer)
21-
<!--- SME approval is required to merge a PR unless the changes are made by a subject matter expert. --->
22-
<!--- QE approval is required to merge a PR unless there are no technical changes to the content. --->
23-
<!--- Docs team approval is required for ALL PRs. --->
24-
25-
**Additional information:**
26-
<!--- Optional: Include additional context or expand the description here.--->
11+
<!--- Add a link to the Jira issue. --->
2712

28-
<!--- After you open your PR, request reviews from all required stakeholders via Slack GitHub, or Jira. --->

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

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,9 @@ include::modules/authorization/proc-enabling-the-rbac-plugin.adoc[leveloffset=+1
3333
include::assembly-managing-authorizations-by-using-the-rhdh-web-ui.adoc[leveloffset=+1]
3434

3535

36+
include::assembly-managing-authorizations-by-using-the-rest-api.adoc[leveloffset=+1]
37+
38+
3639
include::assembly-managing-authorizations-by-using-external-files.adoc[leveloffset=+1]
3740

3841

@@ -50,11 +53,3 @@ include::modules/authorization/con-user-stats-rhdh.adoc[leveloffset=+1]
5053

5154
include::modules/authorization/proc-download-user-stats-rhdh.adoc[leveloffset=+2]
5255

53-
54-
include::modules/authorization/con-rbac-rest-api.adoc[leveloffset=+1]
55-
56-
57-
include::modules/authorization/proc-rbac-send-request-rbac-rest-api.adoc[leveloffset=+2]
58-
59-
60-
include::modules/authorization/ref-rbac-rest-api-endpoints.adoc[leveloffset=+2]
Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
[id='managing-authorizations-by-using-the-rest-api']
2+
= Managing authorizations by using the REST API
3+
4+
To automate the maintenance of {product} permission policies and roles, you can use {product-short} role-based access control (RBAC) REST API.
5+
6+
You can perform the following actions with the REST API:
7+
8+
* Retrieve information about:
9+
** All permission policies
10+
** Specific permission policies
11+
** Specific roles
12+
** Static plugins permission policies
13+
* Create, update, or delete:
14+
** Permission policy
15+
** Role
16+
17+
18+
include::modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-curl.adoc[leveloffset=+1]
19+
20+
21+
include::modules/authorization/proc-sending-request-to-the-rbac-rest-api-by-using-a-rest-client.adoc[leveloffset=+1]
22+
23+
24+
include::modules/authorization/ref-rbac-rest-api-endpoints.adoc[leveloffset=+1]
25+

modules/authorization/con-rbac-rest-api.adoc

Lines changed: 0 additions & 119 deletions
This file was deleted.

modules/authorization/proc-rbac-send-request-rbac-rest-api.adoc

Lines changed: 0 additions & 53 deletions
This file was deleted.
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
[id='proc-rbac-sending-requests-to-the-rbac-rest-api-by-using-a-rest-client_{context}']
2+
= Sending requests to the RBAC REST API by using a REST client
3+
4+
You can send RBAC REST API requests using any REST client.
5+
6+
.Prerequisites
7+
* xref:enabling-and-giving-access-to-rbac[You have access to the RBAC feature].
8+
9+
.Procedure
10+
include::snip-finding-bearer-token.adoc[]
11+
12+
. In your REST client, run a command with the following parameters and review the response:
13+
+
14+
--
15+
Authorization::
16+
Enter your saved authorization token.
17+
18+
HTTP method::
19+
Enter the HTTP method for your xref:ref-rbac-rest-api-endpoints_{context}[API endpoint].
20+
21+
* `GET`: To retrieve specified information from a specified resource endpoint.
22+
* `POST`: To create or update a resource.
23+
* `PUT`: To update a resource.
24+
* `DELETE`: To delete a resource.
25+
26+
URL::
27+
Enter your {product-short} URL and xref:ref-rbac-rest-api-endpoints_{context}[API endpoint]: pass:c,a,q[{my-product-url}/__<endpoint>__], such as
28+
`pass:c,a,q[{my-product-url}/api/permission/policies]`.
29+
30+
Body::
31+
Enter the JSON body with data that your xref:ref-rbac-rest-api-endpoints_{context}[API endpoint] might need with the HTTP `POST` request.
32+
--
33+

0 commit comments

Comments
 (0)