Reason¶

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

class ReasonAPI(api: restfly.session.APISession)[source]¶

details(reason_id: str) → Dict[source]¶

Retrieves the details of the reason based on reason_id

Parameters: reason_id (str) – The reason instance identifier.
Returns: Details of the reason object .
Return type: dict

Examples

>>> tad.reason.details(reason_id='1')

list() → List[Dict][source]¶

Retrieves the list of reason instances.

Returns: The list of reason instances.
Return type: list

Examples

>>> tad.reason.list()

list_by_checker(profile_id: str, checker_id: str) → List[Dict][source]¶

Retrieves the details of the reason based on profile_id and checker_id.

Parameters

profile_id (str) – The profile instance identifier
checker_id (str) – The checker instance identifier

Returns

Details of the reason object.

Return type

list

Examples

>>> tad.reason.list_by_checker(
...     profile_id='1',
...     checker_id='1'
...     )

list_by_directory_and_event(profile_id: str, infrastructure_id: str, directory_id: str, event_id: str) → List[Dict][source]¶

Retrieves the details of the reason object based on profile_id, directory_id and event_id.

Parameters

profile_id (str) – The profile instance identifier.
infrastructure_id (str) – The infrastructure instance identifier.
directory_id (str) – The directory instance identifier.
event_id (str) – The event instance identifier.

Returns

Details of the reason object.

Return type

list

Examples

>>> tad.reason.list_by_directory_and_event(
...     profile_id='1',
...     infrastructure_id='1',
...     directory_id='1',
...     event_id='1'
...     )