X4 Produktdokumentation
X4 Produktdokumentation
Breadcrumbs

Keycloak Management

Dieser Adapter verwaltet Benutzer, Gruppen und Rollen in Keycloak.


Hinweis

Wenn ein anderer Realm als der Standard-X4-Realm in Keycloak (http://localhost:8085/auth) angelegt wurde, muss dem jeweiligen Client (http://localhost:8085/auth/admin/master/console/#/YourRealm/clients) die entsprechende Rolle in Service Account Roles zugewiesen werden.

Eigenschaften (Properties)

Operation

Vom Adapter ausgeführte Operationen

Mögliche Werte:

  • Activate User: Benutzer aktivieren

  • Create new User: Neuen Benutzer erstellen

  • Deactivate User: Benutzer deaktivieren

  • Delete User: Benutzer löschen

  • Get User by Id: Benutzerdaten anhand der ID auslesen

  • List Users: Benutzer auflisten

  • Update User: Benutzer aktualisieren

  • Add Member to Group: Benutzer einer Gruppe hinzufügen

  • Create new Group: Gruppe erstellen

  • Create new Sub-Group: Sub-Gruppe erstellen

  • Delete Group: Gruppe löschen

  • Get Group by Id: Gruppendaten anhand der ID auslesen

  • Get Members of Group: Gruppenmitglieder auflisten

  • List Groups: Gruppen auflisten

  • Remove Member from Group: Benutzer aus einer Gruppe entfernen

  • Update Group: Gruppe aktualisieren

  • Add Composite to Role: Untergeordnete Rollen einer zusammengesetzten Rolle hinzufügen

  • Add Roles to Group: Rollen einer Gruppe hinzufügen

  • Add Roles to User: Rollen einem Benutzer hinzufügen

  • Create new Role: Rolle erstellen

  • Delete Role: Rolle löschen

  • Get Composite of Role: Untergeordnete Rollen einer zusammengesetzten Rolle ausgeben

  • Get Role by Id: Rollendaten anhand der ID auslesen

  • Get Role by Name: Rollendaten anhand des Namens auslesen

  • Get Users with Role: Benutzer mit bestimmter Rolle ausgeben

  • List Roles: Rollen auflisten

  • Remove Roles From a Group: Rollen einer Gruppe entfernen 

  • Remove Roles from a User: Rollen eines Benutzers entfernen

  • Update Role: Rolle aktualisieren

Parameter

Adapter

Hauptklasse des Adapters (nicht verändern!)

Mögliche Werte:

de.softproject.x4.auth.keycloak.KeycloakAdapter: Hauptklasse (Standard)

Realm

Bereich, der in Keycloak REST API-Aufrufen verwendet wird.

Client ID

Client ID für die Keycloak REST API-Authentifizierung

Client Secret

Geheimer Client-Schlüssel für die Keycloak REST API-Authentifizierung

Statuswerte

1

Die Adapter-Operation wurde erfolgreich ausgeführt.

-1

Bei der Ausführung des Adapters ist ein Fehler aufgetreten.


Die Dokumentation der ReST-Schnittstelle finden Sie unter http://localhost:8080/X4/X4Api/.