Keycloak Management

This adapter manages users, groups, and roles in Keycloak.

Note

If a Realm other than the Default X4 Realm is created in Keycloak (http://localhost:8085/auth), the corresponding role must be assigned to the respective Client (http://localhost:8085/auth/admin/master/console/#/YourRealm/clients) in Service Account Roles.

Properties

Operation

Operation executed by the adapter

Possible values:

Activate User
Create new User
Deactivate User
Delete User
Get User by Id
List Users
Update User
Add Member to Group
Create new Group
Create new Sub-Group
Delete Group
Get Group by Id
Get Members of Group
List Groups
Remove Member from Group
Update Group
Add Composite to Role
Add Roles to Group
Add Roles to User
Create new Role
Delete Role
Get Composite of Role
Get Role by Id
Get Role by Name
Get Users with Role
List Roles
Remove Roles From a Group
Remove Roles from a User
Update Role

Parameters

`Adapter`	Main adapter class (do not change!) Possible values: de.softproject.x4.auth.keycloak.KeycloakAdapter: Main class (Default)
`realm`	Realm to be used in Keycloak REST API calls.
`clientId`	Client ID for Keycloak REST API authentication.
`clientSecret`	Client Secret for Keycloak REST API authentication.

Status values

`1`	The adapter operation was executed successfully.
`-1`	An error occurred during the execution of the adapter.

The documentation of the ReST interface can be found at http://localhost:8080/X4/X4Api/.