npn_client_controller¶

The following methods allow for interaction with the ZPA NPN Client Controller (VPN Users) API endpoints.

Methods are accessible via zpa.npn_client_controller

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

Bases: APIClient

A Client object for the NPN Client Controller resource.

list_vpn_connected_users(query_params=None)¶

Returns a list of all configured applications configured.

Keyword Arguments:

{dict} (query_params) –

Map of query parameters for the request.

[query_params.page] {str}: Specifies the page number.

[query_params.page_size] {int}: Page size for pagination.

[query_params.search] {str}: Search string for filtering results.

Returns:

A list of NPNClientController instances.

Return type:

list

Examples

Retrieve all applications configured with pagination parameters:

>>> vpn_list, _, err = client.zpa.npn_client_controller.list_vpn_connected_users()
... if err:
...     print(f"Error listing vpn connected users: {err}")
...     return
... print(f"Total vpn connected users found: {len(vpn_list)}")
... for vpn in vpn_list:
...     print(vpn.as_dict())