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

.. py:module:: laceworksdk.api.v2.configs

.. autoapi-nested-parse::

   Lacework Configs API wrapper.



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

Classes
~~~~~~~

.. autoapisummary::

   laceworksdk.api.v2.configs.ConfigsAPI




.. py:class:: ConfigsAPI(session)


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

   Get information about compliance configurations.

   The Configs API endpoint is a parent for different types of configs that can be queried.

   .. attribute:: compliance_evaluations

      A ComplianceEvaluationsAPI instance.

      :type: ComplianceEvaluationsAPI

   .. attribute:: azure_subscriptions

      An AzureSubscriptions instance.

      :type: AzureSubscriptions

   .. attribute:: gcp_projects

      A GcpProjects instance.

      :type: GcpProjects

   .. py:class:: AzureSubscriptions(session, object_type, endpoint_root='/api/v2')


      Bases: :py:obj:`laceworksdk.api.read_endpoint.ReadEndpoint`

      A class used to represent the Azure Subscriptions API endpoint.

      Get a list of Azure subscription IDs for an entire account or for a specific Azure tenant.


      .. py:property:: session

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

      .. py:method:: get(id=None, resource=None, **request_params)

         A method to get objects.

         :param id: A string representing the object ID.
         :type id: str
         :param resource: The Lacework API resource type to get.
         :type resource: str
         :param request_params: Use to pass any additional parameters the API
         :type request_params: dict

         :returns: the requested o
         :rtype: dict



   .. py:class:: GcpProjects(session, object_type, endpoint_root='/api/v2')


      Bases: :py:obj:`laceworksdk.api.read_endpoint.ReadEndpoint`

      A class used to represent the GCP Projects API endpoint.

      .. py:property:: session

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

      .. py:method:: get(id=None, resource=None, **request_params)

         A method to get objects.

         :param id: A string representing the object ID.
         :type id: str
         :param resource: The Lacework API resource type to get.
         :type resource: str
         :param request_params: Use to pass any additional parameters the API
         :type request_params: dict

         :returns: the requested o
         :rtype: dict



   .. py:class:: ComplianceEvaluationsAPI(session, object_type, endpoint_root='/api/v2')


      Bases: :py:obj:`laceworksdk.api.search_endpoint.SearchEndpoint`

      A class used to represent the Compliance Evaluations API endpoint.

      .. py:property:: session

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

      .. py:method:: search(json=None, resource=None)

         A method to search objects.

         See the API documentation for this API endpoint for valid fields to search against.

         NOTE: While the "value" and "values" fields are marked as "optional" you must use one of them,
         depending on the operation you are using.

         :param json: The desired search parameters:

                      - timeFilter (dict, optional): A dict containing the time frame for the search:

                          - startTime (str): The start time for the search
                          - endTime (str): The end time for the search

                      - filters (list of dict, optional): Filters based on field contents:

                          - field (str): The name of the data field to which the condition applies

                          - expression (str): The comparison operator for the filter condition. Valid values are:


                          "eq", "ne", "in", "not_in", "like", "ilike", "not_like", "not_ilike", "not_rlike", "rlike", "gt", "ge",                 "lt", "le", "between"


                          - value (str, optional):  The value that the condition checks for in the specified field. Use this attribute                 when using an operator that requires a single value.
                          - values (list of str, optional): The values that the condition checks for in the specified field. Use this                 attribute when using an operator that requires multiple values.
                      - returns (list of str, optional): The fields to return
         :type json: dict
         :param resource: The Lacework API resource to search (Example: "AlertChannels")
         :type resource: str

         :Yields: *dict* -- returns a generator which yields a page of objects at a time as returned by the Lacework API.