IDP Controller API#

The following methods allow for interaction with the ZPA IDP Controller API endpoints.

Methods are accessible via zpa.idp

class IDPControllerAPI#

Bases: object

get_idp(idp_id)#

Returns information on the specified IdP.

Parameters:

idp_id (str) – The unique identifier for the IdP.

Returns:

The resource record for the IdP.

Return type:

Box

Examples

>>> pprint(zpa.idp.get_idp('99999'))
get_idp_by_name(name)#
list_idps(**kwargs)#

Returns a list of all configured IdPs.

Keyword Arguments:

  • **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_enabled (bool) – Returns all SCIM IdPs if True. Returns all non-SCIM IdPs if False.

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

Returns:

A list of all configured IdPs.

Return type:

BoxList

Examples

>>> for idp in zpa.idp.list_idps():
...    pprint(idp)