Skip to content

Commit

Permalink
Replaced TenableAD w/ TenableIE in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SteveMcGrath committed Jun 18, 2024
1 parent f6d192b commit 121ce0c
Show file tree
Hide file tree
Showing 30 changed files with 155 additions and 155 deletions.
4 changes: 2 additions & 2 deletions tenable/ie/about.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=====
Methods described in this section relate to the About API.
These methods can be accessed at ``TenableAD.about``.
These methods can be accessed at ``TenableIE.about``.
.. rst-class:: hide-signature
.. autoclass:: AboutAPI
Expand All @@ -21,6 +21,6 @@ def version(self) -> str:
Examples:
>>> tad.about.version()
>>> tie.about.version()
'''
return self._get(box=True).version
12 changes: 6 additions & 6 deletions tenable/ie/ad_object/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=============
Methods described in this section relate to the ad object API.
These methods can be accessed at ``TenableAD.ad_object``.
These methods can be accessed at ``TenableIE.ad_object``.
.. rst-class:: hide-signature
.. autoclass:: ADObjectAPI
Expand Down Expand Up @@ -52,7 +52,7 @@ def details(self,
The AD object.
Examples:
>>> tad.ad_object.details(
>>> tie.ad_object.details(
... directory_id='1',
... infrastructure_id='1',
... ad_object_id='1'
Expand Down Expand Up @@ -85,7 +85,7 @@ def details_by_profile_and_checker(self,
The AD object.
Examples:
>>> tad.ad_object.details_by_profile_and_checker(
>>> tie.ad_object.details_by_profile_and_checker(
... profile_id='1',
... checker_id='1',
... ad_object_id='1'
Expand Down Expand Up @@ -120,7 +120,7 @@ def details_by_event(self,
The AD object.
Examples:
>>> tad.ad_object.details_by_event(
>>> tie.ad_object.details_by_event(
... directory_id='1',
... infrastructure_id='1',
... ad_object_id='1',
Expand Down Expand Up @@ -164,7 +164,7 @@ def get_changes(self,
The list of AD objects.
Examples:
>>> tad.ad_object.get_changes(
>>> tie.ad_object.get_changes(
... directory_id='1',
... infrastructure_id='1',
... ad_object_id='1',
Expand Down Expand Up @@ -230,7 +230,7 @@ def search_all(self,
records.
Examples:
>>> for ado in tad.ad_object.search_all(
>>> for ado in tie.ad_object.search_all(
... profile_id='1',
... checker_id='1',
... show_ignored=False,
Expand Down
10 changes: 5 additions & 5 deletions tenable/ie/alert/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=============
Methods described in this section relate to the alerts API.
These methods can be accessed at ``TenableAD.alerts``.
These methods can be accessed at ``TenableIE.alerts``.
.. rst-class:: hide-signature
.. autoclass:: AlertsAPI
Expand Down Expand Up @@ -62,7 +62,7 @@ def list_by_profile(self,
records.
Examples:
>>> for alert in tad.alerts.list_by_profile(
>>> for alert in tie.alerts.list_by_profile(
... profile_id='1',
... archived=False,
... read=False,
Expand Down Expand Up @@ -102,7 +102,7 @@ def details(self,
the alert object.
Examples:
>>> tad.alerts.details(
>>> tie.alerts.details(
... alert_id='1'
... )
'''
Expand All @@ -128,7 +128,7 @@ def update(self,
The updated alert object.
Example:
>>> tad.alerts.update(
>>> tie.alerts.update(
... alert_id='1',
... archived=False,
... read=False
Expand Down Expand Up @@ -156,7 +156,7 @@ def update_on_profile(self,
None:
Example:
>>> tad.alerts.update_on_profile(
>>> tie.alerts.update_on_profile(
... profile_id='1',
... archived=False,
... read=False
Expand Down
8 changes: 4 additions & 4 deletions tenable/ie/api_keys.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=======
Methods described in this section relate to the APIKeys API.
These methods can be accessed at ``TenableAD.api_keys``.
These methods can be accessed at ``TenableIE.api_keys``.
.. rst-class:: hide-signature
.. autoclass:: APIKeyAPI
Expand All @@ -21,18 +21,18 @@ def get(self) -> str:
Examples:
>>> tad.api_keys.get()
>>> tie.api_keys.get()
'''
return self._get(box=True).key

def refresh(self) -> str:
'''
Creates or renews an API for the current user. Will also refresh the
API Key used in the current TenableAD session.
API Key used in the current TenableIE session.
Examples:
>>> tad.api_keys.refresh()
>>> tie.api_keys.refresh()
'''
key = self._post(json={}, box=True).key
self._api._key_auth(key)
Expand Down
6 changes: 3 additions & 3 deletions tenable/ie/application_settings/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
====================
Methods described in this section relate to the application settings API.
These methods can be accessed at ``TenableAD.application_settings``.
These methods can be accessed at ``TenableIE.application_settings``.
.. rst-class:: hide-signature
.. autoclass:: ApplicationSettingsAPI
Expand All @@ -27,7 +27,7 @@ def details(self) -> Dict:
The application settings objects
Examples:
>>> tad.application_settings.get_settings()
>>> tie.application_settings.get_settings()
'''
return self._schema.load(self._get())

Expand Down Expand Up @@ -66,7 +66,7 @@ def update(self,
The application settings objects
Example:
>>> tad.application_settings.update_settings(
>>> tie.application_settings.update_settings(
... smtp_use_start_tls=True,
... tls=False,
... default_profile_id=1,
Expand Down
6 changes: 3 additions & 3 deletions tenable/ie/attack_type_options/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
===================
Methods described in this section relate to the attack type options API.
These methods can be accessed at ``TenableAD.attack_type_options``.
These methods can be accessed at ``TenableIE.attack_type_options``.
.. rst-class:: hide-signature
.. autoclass:: AttackTypeOptionsAPI
Expand Down Expand Up @@ -39,7 +39,7 @@ def list(self,
The list of attack type options objects
Examples:
>>> tad.attack_type_options.list(
>>> tie.attack_type_options.list(
... profile_id='1',
... attack_type_id='1',
... staged=False
Expand Down Expand Up @@ -84,7 +84,7 @@ def create(self,
The newly created attack type options.
Example:
>>> tad.attack_type_options.create(
>>> tie.attack_type_options.create(
... profile_id='1',
... attack_type_id='1',
... codename='codename',
Expand Down
4 changes: 2 additions & 2 deletions tenable/ie/attack_types/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=============
Methods described in this section relate to the the attack type API.
These methods can be accessed at ``TenableAD.attack_types``.
These methods can be accessed at ``TenableIE.attack_types``.
.. rst-class:: hide-signature
.. autoclass:: AttackTypesAPI
Expand All @@ -27,6 +27,6 @@ def list(self) -> List[Dict]:
The list of attack types objects
Examples:
>>> tad.attack_types.list()
>>> tie.attack_types.list()
'''
return self._schema.load(self._get('attack-types'), many=True)
4 changes: 2 additions & 2 deletions tenable/ie/attacks/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=============
Methods described in this section relate to the attacks API.
These methods can be accessed at ``TenableAD.attacks``.
These methods can be accessed at ``TenableIE.attacks``.
.. rst-class:: hide-signature
.. autoclass:: AttacksAPI
Expand Down Expand Up @@ -56,7 +56,7 @@ def list(self,
The list of attacks objects
Examples:
>>> tad.attacks.list(
>>> tie.attacks.list(
... profile_id='1',
... resource_type='infrastructure',
... resource_value='1',
Expand Down
6 changes: 3 additions & 3 deletions tenable/ie/category/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
========
Methods described in this section relate to the category API.
These methods can be accessed at ``TenableAD.category``.
These methods can be accessed at ``TenableIE.category``.
.. rst-class:: hide-signature
.. autoclass:: CategoryAPI
Expand All @@ -28,7 +28,7 @@ def list(self) -> List[Dict]:
Examples:
>>> tad.category.list()
>>> tie.category.list()
'''
return self._schema.load(self._get(), many=True)

Expand All @@ -46,6 +46,6 @@ def details(self, category_id: str) -> Dict:
Examples:
>>> tad.category.details(category_id='5')
>>> tie.category.details(category_id='5')
'''
return self._schema.load(self._get(f'{category_id}'))
6 changes: 3 additions & 3 deletions tenable/ie/checker/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=======
Methods described in this section relate to the checker API.
These methods can be accessed at ``TenableAD.checker``.
These methods can be accessed at ``TenableIE.checker``.
.. rst-class:: hide-signature
.. autoclass:: CheckerAPI
Expand All @@ -28,7 +28,7 @@ def list(self) -> List[Dict]:
Examples:
>>> tad.checker.list()
>>> tie.checker.list()
'''
return self._schema.load(self._get(), many=True)

Expand All @@ -46,6 +46,6 @@ def details(self, checker_id: str) -> Dict:
Examples:
>>> tad.checker.details(checker_id='1')
>>> tie.checker.details(checker_id='1')
'''
return self._schema.load(self._get(f'{checker_id}'))
6 changes: 3 additions & 3 deletions tenable/ie/checker_option/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
==============
Methods described in this section relate to the checker option API.
These methods can be accessed at ``TenableAD.checker_option``.
These methods can be accessed at ``TenableIE.checker_option``.
.. rst-class:: hide-signature
.. autoclass:: CheckerOptionAPI
Expand Down Expand Up @@ -42,7 +42,7 @@ def list(self,
List of checker options.
Examples:
>>> tad.checker_option.list(
>>> tie.checker_option.list(
... profile_id='9',
... checker_id='1',
... staged=True
Expand Down Expand Up @@ -85,7 +85,7 @@ def create(self,
Created checker option instance.
Examples:
>>> tad.checker_option.create(
>>> tie.checker_option.create(
... profile_id='9',
... checker_id='2',
... codename='codename',
Expand Down
12 changes: 6 additions & 6 deletions tenable/ie/dashboard/api.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
=========
Methods described in this section relate to the dashboard API.
These methods can be accessed at ``TenableAD.dashboard``.
These methods can be accessed at ``TenableIE.dashboard``.
.. rst-class:: hide-signature
.. autoclass:: DashboardAPI
Expand All @@ -28,7 +28,7 @@ def list(self) -> List[Dict]:
Examples:
>>> tad.dashboard.list()
>>> tie.dashboard.list()
'''
return self._schema.load(self._get(), many=True)

Expand All @@ -48,7 +48,7 @@ def create(self, name: str, order: int) -> Dict:
Examples:
>>> tad.dashboard.create(
>>> tie.dashboard.create(
... name='new_dashboard',
... order=10)
'''
Expand All @@ -72,7 +72,7 @@ def details(self, dashboard_id: str) -> Dict:
Examples:
>>> tad.dashboard.details(dashboard_id='1')
>>> tie.dashboard.details(dashboard_id='1')
'''
return self._schema.load(self._get(f'{dashboard_id}'))

Expand All @@ -90,7 +90,7 @@ def update(self, dashboard_id: str, **kwargs):
Examples:
>>> tad.dashboard.update(
>>> tie.dashboard.update(
... dashboard_id='23',
... name='updated_dashboard_name',
... order=1)
Expand All @@ -109,6 +109,6 @@ def delete(self, dashboard_id: str) -> None:
The dashboard instance identifier.
Examples:
>>> tad.dashboard.delete(dashboard_id='22')
>>> tie.dashboard.delete(dashboard_id='22')
'''
self._delete(f'{dashboard_id}')
Loading

0 comments on commit 121ce0c

Please sign in to comment.