Skip to content

Commit 2f277ed

Browse files
authored
Add platform_NAME role description. (#576)
* Fix typos, add `platform_NAME` role * Update docs/hosting/authentication.md
1 parent 6b515ac commit 2f277ed

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

docs/hosting/authentication.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ There are two ways to integrate external identity providers (e.g. Google, [EGI C
2626
Create both a private and a public client in the external provider (this step is required for both options below).
2727

2828
### Option 1: Update the configuration files
29-
- Replace `KEYCLOAK_CLIENT_SECRET` in `.env.override` with the value provided by the external IdP.
30-
- Update `server_url`, `client_idr`, `client_id_swagger` `openid_connect_url` and `scopes` in `./src/config.override.toml`.
29+
- Replace `KEYCLOAK_CLIENT_SECRET` in `override.env` with the value provided by the external IdP.
30+
- Update `server_url`, `client_id`, `client_id_swagger` `openid_connect_url` and `scopes` in `./src/config.override.toml`.
3131
- In this setup, the Keycloak container is not required and can be shut down.
3232
### Option 2: use keycloak as an identity broker
3333
- Details can be found in the Keycloak documentation: [Integrating identity providers](https://www.keycloak.org/docs/latest/server_admin/index.html#_identity_broker).
@@ -47,6 +47,7 @@ These are the roles the metadata catalogue uses (`*` in a role indicates its def
4747
* `update_*`: allows the user update permission for all assets on the platform, regardless of the asset-specific permissions.
4848
* `delete_*`: allows the user delete permission for all assets on the platform, regardless of the asset-specific permissions.
4949
* `create_platforms`: allows the user to define new platforms.
50+
* `platform_NAME`: identifies the 'user' as being allowed to register assets of platform 'NAME', used for connectors.
5051

5152
Note that roles may be used for services other than the metadata catalogue.
5253
New roles can be created from the admin console, see ["Creating a realm role"](https://www.keycloak.org/docs/latest/server_admin/index.html#proc-creating-realm-roles_server_administration_guide).

0 commit comments

Comments
 (0)