Function users_get

app/api.py:362–388

Lists all known users and indicates the currently logged-in user. Returns: On success, a JSON data structure with the following properties: users: array of objects containing usernames and roles (as strings). currentUsername: The username (as string) of the currently log

()

@api_blueprint.route('/users', methods=['GET'])
@required_auth(auth.Role.ADMIN)
def users_get():
    """Lists all known users and indicates the currently logged-in user.

    Returns:
        On success, a JSON data structure with the following properties:
        users: array of objects containing usernames and roles (as strings).
        currentUsername: The username (as string) of the currently logged-in
            user or null if not logged in.

        Example:
        {
            "users": [{
                "username": "little-hamster",
                "role": "ADMIN"
            }],
            "currentUsername": "little-hamster"
        }

        Returns error object on failure.
    """
    return json_response.success({
        'users': [{
            'username': u.username,
            'role': u.role.name,
        } for u in auth.get_all_accounts()],
        'currentUsername': session.get_username(),
    })


@api_blueprint.route('/users', methods=['DELETE'])