company

The following methods allow for interaction with the ZCC Company API endpoints.

Methods are accessible via zcc.company

Copyright (c) 2023, Zscaler Inc.

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 CompanyInfoAPI

Bases: APIClient

get_company_info()

Gets information about your organization such as the name of the business, domains, etc. Note: This API endpoint is allowed if called via OneAPI or if the token has admin or read-only admin privileges.

Parameters:

N/A

Returns:

Returns company information in the Client Connector Portal.

Return type:

list

Examples

Prints all devices in the Client Connector Portal to the console:

>>> company_info, _, err = client.zcc.company.get_company_info()
>>> if err:
...     print(f"Error listing company information: {err}")
...     return
... for company in company_info:
...     print(company.as_dict())