organization_information¶

The following methods allow for interaction with the ZIA Organization Information API endpoints.

Methods are accessible via zia.organization_information

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED “AS IS” AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

class OrganizationInformationAPI¶

Bases: APIClient

A Client object for the organization information resource.

get_org_info_lite()¶

Retrieves the current organization information configured in the ZIA Admin Portal.

This method makes a GET request to the ZIA Admin API and returns detailed organization information, including various bypass rules, DNS optimization configurations, and traffic control settings.

Returns:

A tuple containing:

OrganizationInformation: The current organization information object.
Response: The raw HTTP response returned by the API.
error: An error message if the request failed; otherwise, None.

Return type:

tuple

Examples

Retrieve and print the current organization information:

>>> settings, response, err = client.zia.organization_information.get_advanced_settings()
>>> if err:
...     print(f"Error fetching settings: {err}")
... else:
...     print(f"Enable Office365: {settings.enable_office365}")

get_organization_information()¶

Retrieves the current organization information configured in the ZIA Admin Portal.

This method makes a GET request to the ZIA Admin API and returns detailed organization information, including various bypass rules, DNS optimization configurations, and traffic control settings.

Returns:

A tuple containing:

OrganizationInformation: The current organization information object.
Response: The raw HTTP response returned by the API.
error: An error message if the request failed; otherwise, None.

Return type:

tuple

Examples

Retrieve and print the current organization information:

>>> settings, response, err = client.zia.organization_information.get_advanced_settings()
>>> if err:
...     print(f"Error fetching settings: {err}")
... else:
...     print(f"Enable Office365: {settings.enable_office365}")

get_subscriptions()¶

Retrieves the current organization information configured in the ZIA Admin Portal.

This method makes a GET request to the ZIA Admin API and returns detailed organization information, including various bypass rules, DNS optimization configurations, and traffic control settings.

Returns:

A tuple containing:

OrganizationInformation: The current organization information object.
Response: The raw HTTP response returned by the API.
error: An error message if the request failed; otherwise, None.

Return type:

tuple

Examples

Retrieve and print the current organization information:

>>> settings, response, err = client.zia.organization_information.get_advanced_settings()
>>> if err:
...     print(f"Error fetching settings: {err}")
... else:
...     print(f"Enable Office365: {settings.enable_office365}")