entitlements¶

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

Methods are accessible via zcc.entitlements

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

Bases: APIClient

get_zdx_group_entitlements(query_params=None)¶

Returns the list ZDX group entitlements 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. [query_params.search] {str}: The search string used to partially match.
Returns:: A list containing ZDX group entitlements in the Client Connector Portal.
Return type:: list

Examples

Prints all ZDX group entitlements in the Client Connector Portal to the console:

>>> for group in zcc.entitlements.get_zdx_group_entitlements():
...    print(group)

get_zpa_group_entitlements(query_params=None)¶

Returns the list ZPA group entitlements 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. [query_params.search] {str}: The search string used to partially match.
Returns:: A list containing ZPA group entitlements in the Client Connector Portal.
Return type:: list

Examples

Prints all ZPA group entitlements in the Client Connector Portal to the console:

>>> for group in zcc.entitlements.get_zpa_group_entitlements():
...    print(group)

update_zdx_group_entitlement()¶

Updates ZDX Group Entitlement.

Parameters:: N/A
Returns:: A tuple containing the ZDX Group Entitlement.
Return type:: tuple

update_zpa_group_entitlement()¶

Updates ZPA Group Entitlement.

Parameters:: N/A
Returns:: A tuple containing the ZPA Group Entitlement.
Return type:: tuple