saml_attributes#

The following methods allow for interaction with the ZPA SAML Attributes API endpoints.

Methods are accessible via zpa.saml_attributes

class SAMLAttributesAPI#

Bases: object

get_attribute(attribute_id)#

Returns information on the specified SAML attributes.

Parameters:

attribute_id (str) – The unique identifier for the SAML attributes.

Returns:

The resource record for the SAML attributes.

Return type:

dict

Examples

>>> pprint(zpa.saml_attributes.get_attribute('99999'))
list_attributes(**kwargs)#

Returns a list of all configured SAML attributes.

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.

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

Returns:

A list of all configured SAML attributes.

Return type:

BoxList

Examples

>>> for saml_attribute in zpa.saml_attributes.list_attributes():
...    pprint(saml_attribute)
list_attributes_by_idp(idp_id, **kwargs)#

Returns a list of all configured SAML attributes for the specified IdP.

Parameters:

idp_id (str) – The unique id of the IdP to retrieve SAML attributes from.

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.

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

Returns:

A list of all configured SAML attributes for the specified IdP.

Return type:

BoxList

Examples

>>> for saml_attribute in zpa.saml_attributes.list_attributes_by_idp('99999'):
...    pprint(saml_attribute)