Skip to main content
Skip table of contents

List Users

Die Operation List Users listet alle Benutzer auf, die in Keycloak existieren.

Input

Der Adapter erwartet keinen Input. Ohne Input werden aber nur die ersten 100 Benutzer zurückgegeben. Um mehr Benutzer aufzulisten, verwenden Sie folgenden Input:

XML
<KeycloakListUsersParameters>
<briefRepresentation></briefRepresentation>
<firstName></firstName>
<lastName></lastName>
<username>demo_1</username>
<email></email>
<offset></offset>
<limit>500</limit>
</KeycloakListUsersParameters>

Die Funktion der Parameter briefRepresentationfirstNamelastNameusername und email entspricht der Funktion in der X4 API (Swagger UI), die Sie über das X4 Control Center aufrufen können. Sie können diese Parameter im Input-Dokument leer lassen.

Die Parameter offset und limit haben folgende Funktion:

  • offset: Anzahl der Benutzer, die ab dem Anfang der Benutzerliste übersprungen werden. 
  • limit: Maximale Anzahl der Benutzer, die zurückgegeben werden soll. Die angegebene Anzahl an Benutzern wird unabhängig davon zurückgegeben, wie viele Benutzer mit dem Parameter offset übersprungen werden. Beispiel: Wenn bei 600 Benutzern offset auf 50 und limit auf 500 gesetzt wird, wird eine Liste mit den Benutzern 51–550 zurückgegeben.

Output

XML
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Users>
    <User>
        <Id>2302cf2f-9b29-4d62-9c48-67ac5e3b0ddc</Id>
        <CreatedTimestamp>1634133393343</CreatedTimestamp>
        <Username>exampleuser</Username>
        <Enabled>true</Enabled>
        <Totp>false</Totp>
        <EmailVerified>true</EmailVerified>
        <FirstName>Jane</FirstName>
        <LastName>Doe</LastName>
        <Email>john.doe@example.com</Email>
        <Attributes>
            <Attribute>
                <Name>Employment Relationship</Name>
                <Values>
                    <Value>Software Developer</Value>
                    <Value>Sub-Team Lead</Value>
                </Values>
            </Attribute>
        </Attributes>
        <NotBefore>0</NotBefore>
        <access>
            <entry>
                <key>manageGroupMembership</key>
                <value>true</value>
            </entry>
            <entry>
                <key>view</key>
                <value>true</value>
            </entry>
            <entry>
                <key>mapRoles</key>
                <value>true</value>
            </entry>
            <entry>
                <key>impersonate</key>
                <value>false</value>
            </entry>
            <entry>
                <key>manage</key>
                <value>true</value>
            </entry>
        </access>
    </User>
</Users>
JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.