voxel.hapi.users.list

List Users

Parameters

None

Example Response

<rsp stat="ok">
    <users>
        <user authkey="a8083f0ad0511140786cd719fd9a24d3" type="user">
            <name>Example Name</name>
            <username>login_name</username>
            <email>@example.com</email>
            <phone_number>(555) 555-3421</phone_number>
            <description>An Example User</description>
        </user>
        <user authkey="63d587fd693351c7713daae5342a6595" type="hapi_only">
            <description>A user who can only accss hAPI</description>
        </user>
        <user authkey="cb103cb1d3ec1ba1d5dfdab535d3e94g" type="superuser">
            <name>Example Name</name>
            <username>XXXX</username>
            <email>example.name@example.com</email>
            <phone_number>(555) 555-3421</phone_number>
        </user>
    </users>
</rsp>

Notes

This method returns a list of users associated with a customer's account. The primary user for the account (or, "super user") is labeled as such. Users who have a username specified may login to Voxel's portal. All users can connect to hAPI. For more details about the primary account user, see voxel.hapi.accounts.list.

Method Specific Error Codes

None