laceworksdk.api.v2.agent_access_tokens

Lacework AgentAccessTokens API wrapper.

Module Contents

Classes

AgentAccessTokensAPI

A class used to represent the Agent Access Tokens API endpoint
class laceworksdk.api.v2.agent_access_tokens.AgentAccessTokensAPI(session)[source]

Bases: laceworksdk.api.crud_endpoint.CrudEndpoint

A class used to represent the Agent Access Tokens API endpoint

To connect to the Lacework instance, Lacework agents require an agent access token.

property session

Get the HttpSession instance the object is using.

create(alias, enabled, props=None, **request_params)[source]

A method to create a new agent access token.

Parameters:

  • alias (str) – A string representing the name you wish to give to the created token.

  • enabled (bool|int) – A boolean/integer representing whether the token is enabled.

  • props (dict, optional) – A dict containing optional values for the following fields: - description(str, optional): a description of the token - os(str, optional): the operating system - subscription(str, optional): The subscription level of the token. Valid values are: “standard”, “professional”, “enterprise”

  • request_params (dict) – Use to pass any additional parameters the API

Returns:

The new access token

Return type:

dict

get_by_id(id)[source]

A method to get an agent access token by its ID.

Parameters:

id (str) – A string representing the object ID.

Returns:

a JSON object containing info regarding the requested access token

Return type:

dict

update(id, token_enabled=None, props=None, **request_params)[source]

A method to update an agent access token.

Parameters:

  • id (str) – A string representing the object ID.

  • token_enabled (bool|int, optional) – A boolean/integer representing whether the object is enabled.

  • props (dict, optional) –

    A dict containing optional values for the following fields:

    • description (str, optional): a description of the token

    • os (str, optional): the operating system

    • subscription (str, optional): The subscription level of the token. Valid values are:

    ”standard”, “professional”, “enterprise”

  • request_params (dict) – Use to pass any additional parameters the API

Returns:

The updated access token.

Return type:

dict

delete()[source]

Lacework does not currently allow for agent access tokens to be deleted.

get(id=None, resource=None, **request_params)

A method to get objects.

Parameters:

  • id (str) – A string representing the object ID.

  • resource (str) – The Lacework API resource type to get.

  • request_params (any) – A dictionary of parameters to add to the request.

Returns:

JSON containing the retrieved object(s)

Return type:

dict

search(json=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.

Parameters:

json (dict) –

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

Returns:

returns a dict containing the search results

Return type:

dict