admin_user¶

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

Methods are accessible via zcc.admin_user

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 AdminUserAPI¶

Bases: APIClient

get_admin_user_sync_info()¶

Returns admin user sync information Client Connector Portal.

Parameters:: N/A
Returns:: A list containing Admin Users in the Client Connector Portal.
Return type:: list

Examples

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

>>> sync_info, _, error = client.zcc.admin_user.get_admin_user_sync_info()
>>> if error:
...     print(f"Error: {error}")
...     return
... print(sync_info.as_dict())

list_admin_roles(query_params=None)¶

Returns the list admin roles in the Client Connector Portal.

Parameters:: {dict} (query_params) – Map of query parameters for the request. [query_params.page] {int}: Specifies the page offset. [query_params.page_size] {int}: Specifies the page size.
Returns:: A list containing admin roles in the Client Connector Portal.
Return type:: list

Examples

Prints all admin roles in the Client Connector Portal to the console:

>>> role_list, _, err = client.zcc.admin_user.list_admin_roles()
>>>     if err:
...         print(f"Error listing admin roles: {err}")
...         return
...     print(f"Total admin roles found: {len(role_list)}")
...     for role in role_list:
...         print(role.as_dict())

list_admin_users(query_params=None)¶

Returns the list of Admin Users enrolled in the Client Connector Portal.

Parameters:: {dict} (query_params) – Map of query parameters for the request. [query_params.user_type] {str}: Filter based on type of user. [query_params.page] {int}: Specifies the page offset. [query_params.page_size] {int}: Specifies the page size.
Returns:: A list containing Admin Users in the Client Connector Portal.
Return type:: list

Examples

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

>>> user_list, _, err = client.zcc.admin_user.list_admin_users()
>>> if err:
...     print(f"Error listing admin users: {err}")
...     return
... print(f"Total admin users found: {len(user_list)}")
... for user in user_list:
...     print(user.as_dict())

sync_zia_zdx_admin_users()¶

Sync Admin Users Information for ZDX and ZIA Client Connector Portal.

Parameters:: N/A
Returns:: Returns Sync Admin Users Information for ZDX and ZIA.
Return type:: list

Examples

Prints Sync Admin Users Information in the Client Connector Portal to the console:

>>> for sync in zcc.admin_user.sync_zia_zdx_admin_users():
...    print(sync)

sync_zpa_admin_users()¶

Sync Admin Users Information for ZPA Client Connector Portal.

Parameters:: N/A
Returns:: Returns Sync Admin Users Information for ZPA.
Return type:: list

Examples

Prints Sync Admin Users Information in the Client Connector Portal to the console:

>>> for sync in zcc.admin_user.sync_zpa_admin_users():
...    print(sync)