scim_groups#

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

Methods are accessible via zpa.scim_groups

class SCIMGroupsAPI#

Bases: object

get_group(group_id, **kwargs)#

Returns information on the specified SCIM group.

Parameters:

  • group_id (str) – The unique identifier for the SCIM group.

  • **kwargs – Optional keyword args.

Returns:

The resource record for the SCIM group.

Return type:

dict

Examples

>>> pprint(zpa.scim_groups.get_group('99999'))
list_groups(idp_id, **kwargs)#

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

Parameters:

  • idp_id (str) – The unique id of the IdP.

  • sort_by (str) – The field name to sort by, supported values: id, name, creationTime or modifiedTime (default to name)

  • sort_order (str) – The sort order, values: ASC or DSC (default DSC)

Keyword Arguments:

  • **end_time (str) – The end of a time range for requesting last updated data (modified_time) for the SCIM group. This requires setting the start_time parameter as well.

  • **idp_group_id (str) – The unique id of the IdP group.

  • **max_items (int) – The maximum number of items to request before stopping iteration.

  • **max_pages (int) – The maximum number of pages to request before stopping iteration.

  • **pagesize (int) – Specifies the page size. The default size is 20, but the maximum size is 500.

  • **scim_user_id (str) – The unique id for the SCIM user.

  • **search (str, optional) – The search string used to match against features and fields.

  • **sort_order (str) – Sort the last updated time (modified_time) by ascending ASC or descending DSC order. Defaults to DSC.

  • **start_time (str) – The start of a time range for requesting last updated data (modified_time) for the SCIM group. This requires setting the end_time parameter as well.

Returns:

A list of all configured SCIM groups.

Return type:

list

Examples

>>> for scim_group in zpa.scim_groups.list_groups("999999"):
...    pprint(scim_group)
search_group(idp_id, group_name, **kwargs)#

Searches and returns the SCIM group with the specified name for the given IdP.