.. _GetUsers: GetUsers ======== List users and selected account details. Requires ``access_control.read`` permission. No input or output blobs are used. Parameters ---------- * ``users`` (array of strings, optional): names to select; omitted selects all. * ``roles`` (boolean, optional): include role names; default true. * ``emails`` (boolean, optional): include email; default true. * ``tokens`` (boolean, optional): include personal-token tags; default false. Behavior -------- Unknown requested names are omitted. Every selected entry contains username; other fields follow the selection flags. Passwords and complete token values are never returned. Response -------- Success returns ``status: 0``, ``returned`` (the number of selected entries), and a ``users`` object keyed by username. Failures return a negative ``status`` and an ``info`` message; see :doc:`../Responses` for error envelopes and retry guidance. Examples -------- .. TESTED_EXAMPLE: GetUsers_1 .. code-block:: json [{ "GetUsers": { "users": ["john", "frank"], "roles": true, "emails": true } }] Response: .. TESTED_EXAMPLE: GetUsers_1_response .. code-block:: json [{ "GetUsers": { "status": 0, "returned": 2, "users": { "frank": { "email": "fdr@aperturedata.io", "roles": ["architect"], "username": "frank" }, "john": { "email": "jfk@aperturedata.io", "roles": ["researcher", "user"], "username": "john" } } } }]