List Users 1 | X4Documentation

The List Users operation lists all users that exist in Keycloak.

Input

The adapter does not expect any input. Without input, only the first 100 users are returned. To list more users, use the following input:

XML

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

The function of the parameters briefRepresentation , firstName, lastName, username, and email corresponds to the function in the X4 API (Swagger UI), which you can call via the X4 Control Center. You can leave these parameters blank in the input document.

The offset and limit parameters have the following function:

offset: Number of users skipped from the top of the user list.
limit: Maximum number of users to return. The specified number of users is returned regardless of how many users are skipped with the offset parameter. Example: For 600 users, if offset is set to 50 and limit is set to 500, a list of users 51–550 is returned.

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>