:py:mod:`laceworksdk.api.v2.user_groups`
========================================

.. py:module:: laceworksdk.api.v2.user_groups

.. autoapi-nested-parse::

   Lacework UserGroups API wrapper (Experimental).



Module Contents
---------------

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.user_groups.UserGroupsAPI




.. py:class:: UserGroupsAPI(session)


   Bases: :py:obj:`laceworksdk.api.base_endpoint.BaseEndpoint`

   A class used to represent the `User Groups API endpoint <https://docs.lacework.net/api/v2/docs/#tag/UserGroups>`_ .

   A user group associates Lacework service and standard users with specific permissions in Lacework.

   .. py:property:: session

      Get the :class:`HttpSession` instance the object is using.

   .. py:method:: add_users(guid, user_guids)

      A method to add users to existing UserGroup object.

      :param guid: The GUID of the UserGroup to modify
      :type guid: str
      :param user_guids: An array of user guids to add to the user group
      :type user_guids: list of str

      :returns: The modified results
      :rtype: dict


   .. py:method:: remove_users(guid, user_guids)

      A method to remove users from an existing UserGroup object.

      :param guid: The GUID of the UserGroup object to modify.
      :type guid: str
      :param user_guids: An array of user guids to remove from the user group
      :type user_guids: list of str

      :returns: The modified results
      :rtype: dict