Skip to main content

GetUsers

Retrieve users' information.

Parameters​

  • [optional] users: list of users for which information will be retrieved. By default, all users will be retrieved (subject to permissions).
  • [optional] roles: indicates if roles will be retrieved.
  • [optional] emails: indicates if emails will be retrieved.

Details​

If a user does not have permissions to retrieve other users's information, only information of the authenticated user will be retrieved.

Examples​

Retrieve all user information for users "john" and "frank", using GetUsers command:


    [{
        "GetUsers": {
            "users": ["john", "frank"],
            "roles": true,
            "emails": true
        }
    }]

Result from system containing both "john" and "frank":


    [{
        "GetUsers": {
            "frank": {
                "email": "fdr@aperturedata.io",
                "roles": ["architect"],
                "username": "frank"
            },
            "john": {
                "email": "jfk@aperturedata.io",
                "roles": ["researcher", "user"],
                "username": "john"
            },
            "status": 0
        }
    }]