scim_groups¶

The following methods allow for interaction with the ZPA SCIM Groups API endpoints.

Methods are accessible via zpa.scim_groups

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

Bases: APIClient

A client object for the SCIM Groups resource.

get_scim_group(group_id, query_params=None)¶

Returns information on the specified SCIM group.

Parameters:: group_id (str) – The unique identifier for the SCIM group.
Keyword Arguments:: {dict} (query_params) – Map of query parameters for the request. [query_params.all_entries] (bool): Return all SCIM groups including the deleted ones if set to true
Returns:: The SCIMGroup resource object.
Return type:: SCIMGroup

Examples

>>> group = zpa.scim_groups.get_scim_group('99999')

list_scim_groups(idp_id, query_params=None)¶

Returns a list of all configured SCIM groups for the specified IdP.

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}: Specifies the page size.: If not provided, the default page size is 20. The max page size is 500.

[query_params.search] {str}: The search string used to support search by features and fields for the API.

[query_params.start_time] (str, optional): The start of a time range for requesting: last updated data (modified_time) for the SCIM group.
[query_params.end_time] (str, optional): The end of a time range for requesting: last updated data (modified_time) for the SCIM group.

[query_params.idp_group_id] (str, optional): The unique identifier of the IdP group. [query_params.scim_user_id] (str, optional): The unique identifier for the SCIM user. [query_params.scim_user_name] (str, optional): The name of the SCIM user.

[query_params.sort_order] (str, optional): Sort results by ascending (ASC) or descending (DSC) order.: Default: DSC.

[query_params.sort_by] (str, optional): Specifies the field name to sort the results.

[query_params.all_entries] (bool, optional): If True, returns all SCIM groups, including deleted ones.: Default: False.

Returns:

A tuple containing:

list: A list of SCIM Group instances.
Response: The raw API response object.
Error: An error message, if applicable.

Return type:

tuple

Examples

Retrieve SCIM groups for a given IdP:

>>> scim_groups, _, err = zpa.scim_groups.list_scim_groups("999999")
>>> if err:
...     print(f"Error listing SCIM groups: {err}")
... else:
...     for scim_group in scim_groups:
...         print(scim_group.as_dict())