X4 Produktdokumentation

Keycloak Management 2

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

Note

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

Properties

Operation

Operation executed by the adapter

Possible values:

  • User Management:

    • Activate User: Activate the user

    • Create new User: Create a new user

    • Deactivate User: Deactivate the user

    • Delete User: Delete the user

    • Get User by Id: Read user data by ID

    • List Users: List users

    • Update User: Update the user

  • Group management:

    • Add Member to Group: Add users to a group

    • Create new Group: Create a group

    • Create new Sub-Group: Create a sub-group

    • Delete Group: Delete a group

    • Get Group by Id: Read group data by ID

    • Get Members of Group: List group members

    • List Groups: List groups

    • Remove Member from Group: Remove users from a group

    • Update Group: Update the group

  • Role management:

    • Add Composite to Role: Add subordinate roles to a composite role

    • Add Roles to Group: Add roles to a group

    • Add Roles to User: Add roles to a user

    • Create new Role: Create a role

    • Delete Role: Delete a role

    • Get Composite of Role: Return subordinate roles of a composite role

    • Get Role by Id: Read role data by ID

    • Get Role by Name: Read role data by name

    • Get Users with Role: Return users with a specific role

    • List Roles: List roles

    • Remove Roles From a Group: Remove roles from a group

    • Remove Roles from a User: Remove roles from a user

    • Update Role: Update the role

Parameters

url

Base URL of the Keycloak server (required)

realm

Range used in Keycloak REST API calls (required)

clientId

Client ID for the Keycloak REST API authentication (required)

clientSecret

Secret client key for the Keycloak REST API authentication (required)

Status values

1

The adapter operation was successful.

-1

An error occurred while running the adapter.

For documentation of the ReST interface, see http://localhost:8080/X4/X4Api/.


Additional information: