Attack Type Options¶

Methods described in this section relate to the attack type options API. These methods can be accessed at TenableIE.attack_type_options.

class AttackTypeOptionsAPI(api: APISession)[source]¶

create(profile_id: str, attack_type_id: str, **kwargs) → List[source]¶

Create attack type options related to a profile and attack type.

Parameters:

profile_id (str) – The attack profile identifier.
attack_type_id (str) – The attack type identifier.
codename (str) – The codename of attack type option.
value (str) – The new value of the option.
value_type (str) – The type of option. possible values are string, regex, float, integer, boolean, date, object, array/string, array/regex, array/integer, array/boolean, array/select, array/object
directory_id (optional, int) – The directory identifier.

Returns:

The newly created attack type options.

Return type:

list

Example

>>> tie.attack_type_options.create(
...     profile_id='1',
...     attack_type_id='1',
...     codename='codename',
...     value='Some value',
...     value_type='string',
...     directory_id=None
...     )

list(profile_id: str, attack_type_id: str, **kwargs) → List[Dict][source]¶

Get all attack type options related to a profile and attack type.

Parameters:

profile_id (str) – The attack profile identifier.
attack_type_id (str) – The attack type identifier.
staged (optional, bool) – Get only objects that are staged. Accepted values are True, False.

Returns:

The list of attack type options objects

Return type:

list

Examples

>>> tie.attack_type_options.list(
...     profile_id='1',
...     attack_type_id='1',
...     staged=False
...     )