Checker Option

Methods described in this section relate to the the checker option API. These methods can be accessed at TenableAD.checker_option.

class CheckerOptionAPI(api: restfly.session.APISession)

create(profile_id: str, checker_id: str, **kwargs) → List[Dict]

Creates the new checker-option.

Parameters

• profile_id (str) – The profile instance identifier.

• checker_id (str) – The checker instance identifier.

• codename (str) – The codename of the checker option.

• value (str) – The value of the checker option.

• value_type (str) – The type of the checker option. Accepted 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 instance identifier.

Returns

Created checker option instance.

Return type

list

Examples

>>> tad.checker_option.create(
...     profile_id='9',
...     checker_id='2',
...     codename='codename',
...     value='false',
...     value_type='boolean'
...     directory_id=3
...     )

list(profile_id: str, checker_id: str, **kwargs) → List[Dict]

Retrieves the list of checker-options.

Parameters

• profile_id (str) – The profile instance identifier.

• checker_id (str) – The checker instance identifier.

• staged (optional, bool) – Get only the checker-options that are staged. Accepted values are True and False. Added checker options are first staged until the profile is commited. The staged profile options are not activated and don’t affect yet the IOE and the exposure detection.

Returns

List of checker options.

Return type

list

Examples

>>> tad.checker_option.list(
...     profile_id='9',
...     checker_id='1',
...     staged=True
...     )