CspAccount

class cloudpassage.CspAccount(session, **kwargs)

Initializing the CspAccount class:

Parameters:session (cloudpassage.HaloSession) – This will define how you interact with the Halo API, including proxy settings and API keys used for authentication.
Keyword Arguments:
 endpoint_version (int) – Endpoint version override.

Supported keyword args for filtering CspAccount.list_all():

activate(halo_csp_account_id)

This method activates a CSP Account

Parameters:halo_csp_account_id (str) – Internal Halo ID of CSP Account
Returns:True if successful, throws exception on failure
create(object_body)

Create from JSON document.

Returns the ID of the new object

deactivate(halo_csp_account_id)

This method deactivates a CSP Account

Parameters:halo_csp_account_id (str) – Internal Halo ID of CSP Account
Returns:True if successful, throws exception on failure
delete(object_id)

Delete by ID. Success returns None

describe(object_id)

Get the detailed configuration by ID

Parameters:object_id (str) – ID to retrieve detailed configuration information for
Returns:dictionary object representing the entire object.
Return type:dict
list_all(**kwargs)

Lists all objects of this type.

Returns:List of objects (represented as dictionary-type objects)
Return type:list

Note

This method supports query parameters via keyword arguments.

scan(halo_csp_account_id)
This method initiates a scan of a CSP account
manually outside of its existing schedule.
Parameters:halo_csp_account_id (str) – Internal Halo ID of CSP Account
Returns:True if successful, throws exception on failure
update(object_body)

Update. Success returns None