Skip to content

Commit 56e2625

Browse files
authored
docs: add missing details of api setup (#49)
1 parent 9b64357 commit 56e2625

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/modules/reporting.md

+8-1
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,16 @@ Reports and their results are available for external services through the given
1414
### Initial setup of an API integration
1515

1616
1. Request client_id and client_secret from server administrator (--> admin has to [create new client grant in Keycloak](https://www.keycloak.org/docs/latest/server_admin/#_oidc_clients))
17+
1. check "Client authentication" toggle
18+
2. for "Authentication flow" only "Service accounts roles" needs to be checked
19+
3. after saving the Client, go to "Clent Scopes" section and create two scopes:
20+
1. `reporting_read` (Access to reporting-api GET endpoints)
21+
2. `reporting_write` (Access to reporting-api POST endpoints)
22+
4. in the Client section, edit the newly created client and add these two scopes in the "Client scopes" tab
23+
5. from the "Credentials" tab of the client you can now copy the secret:
1724
![Keycloak Client Setup](../assets/keycloak-client-setup.png)
1825

19-
2. Get the realm of your instance (e.g. https://[your_realm].aam-digital.com). This is both the subdomain of systems hosted on aam-digital.com and the Keycloak Realm for authentication (case-sensitive!).
26+
6. Get the realm of your instance (e.g. https://[your_realm].aam-digital.com). This is both the subdomain of systems hosted on aam-digital.com and the Keycloak Realm for authentication (case-sensitive!).
2027

2128
### Access a reporting via API (after setup)
2229

0 commit comments

Comments
 (0)