laceworksdk.api.v2.team_members

Lacework TeamMembers API wrapper.

Module Contents

Classes

TeamMembersAPI

A class used to represent the Team Members API endpoint
class laceworksdk.api.v2.team_members.TeamMembersAPI(session)[source]

Bases: laceworksdk.api.crud_endpoint.CrudEndpoint

A class used to represent the Team Members API endpoint

DEPRECATED. Please use the TeamUsersAPI class instead.

Team members can be granted access to multiple Lacework accounts and have different roles for each account. Team members can also be granted organization-level roles.

Note: The TeamMembers API is deprecated and is unavailable if you have migrated to the new RBAC model in your Lacework Console.

property session

Get the HttpSession instance the object is using.

create(user_name, user_enabled, props, org_admin=None, org_user=None, admin_role_accounts=None, user_role_accounts=None, **request_params)[source]

A method to create a new team member.

Parameters:

  • user_name (str) – The email address of the user.

  • user_enabled (bool|int) – Whether the object is enabled.

  • props (dict) – The user configuration. Fields are: - firstName (str): The first name of the team member. - lastName (str): The last name of the team member. - company (str): The company of the team member. - accountAdmin (bool, optional): A boolean representing if the team member is an account admin.

  • org_admin (bool, optional) – Is the user an organization admin. (Organization-level Access Required)

  • org_user (bool, optional) – Is the user is an organization user. (Organization-level Access Required)

  • admin_role_accounts (list of str) – A list accounts where the user is an admin. (Organization-level Access Required)

  • user_role_accounts (list of str) – A list of where the team member is a user. (Organization-level Access Required)

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

Returns:

The newly created team member.

Return type:

dict

get(guid=None)[source]

A method to get team members. Using no args will get all team members.

Parameters:

guid (str, optional) – The GUID of the team member to get.

Returns:

The requested team member

Return type:

dict

get_by_guid(guid)[source]

A method to get a team member by GUID.

Parameters:

guid (str) – The GUID of the team member to get.

Returns:

The requested team member

Return type:

dict

update(guid, user_name=None, user_enabled=None, props=None, org_admin=None, org_user=None, admin_role_accounts=None, user_role_accounts=None, **request_params)[source]

A method to update a TeamMembers object.

Parameters:

  • guid – A string representing the object GUID.

  • user_name (str) – The email address of the user.

  • user_enabled (bool|int) – Whether the object is enabled.

  • props (dict) – The user configuration. Fields are: - firstName (str): The first name of the team member. - lastName (str): The last name of the team member. - company (str): The company of the team member. - accountAdmin (bool, optional): A boolean representing if the team member is an account admin.

  • org_admin (bool, optional) – Is the user an organization admin. (Organization-level Access Required)

  • org_user (bool, optional) – Is the user is an organization user. (Organization-level Access Required)

  • admin_role_accounts (list of str) – A list accounts where the user is an admin. (Organization-level Access Required)

  • user_role_accounts (list of str) – A list of where the team member is a user. (Organization-level Access Required)

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

Returns:

The updated team member.

Return type:

dict

delete(guid)[source]

A method to delete a team member.

Parameters:

guid (str) – The GUID of the team member to delete

Returns:

a Requests response object containing the response code

Return type:

requests.models.Response

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