scim_attributes#

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

Methods are accessible via zpa.scim_attributes

class ScimAttributeHeaderAPI#

Bases: object

get_attribute(idp_id, attribute_id)#

Returns information on the specified SCIM attribute.

Parameters:

  • idp_id (str) – The unique id of the Idp corresponding to the SCIM attribute.

  • attribute_id (str) – The unique id of the SCIM attribute.

Returns:

The resource record for the SCIM attribute.

Return type:

Box

Examples

>>> pprint(zpa.scim_attributes.get_attribute('99999',
...    scim_attribute_id="88888"))
get_values(idp_id, attribute_id, **kwargs)#

Returns information on the specified SCIM attributes.

Parameters:

  • idp_id (str) – The unique identifier for the IDP.

  • attribute_id (str) – The unique identifier for the attribute.

  • **kwargs – Optional keyword args.

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. Default is 20, maximum is 500.

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

Returns:

The resource record for the SCIM attribute values.

Return type:

BoxList

Examples

>>> pprint(zpa.scim_attributes.get_values('99999', '88888'))
list_attributes_by_idp(idp_id, **kwargs)#

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

Parameters:

  • idp_id (str) – The unique id of the IdP to retrieve SCIM attributes for.

  • **kwargs – Optional keyword args.

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 SCIM attributes for the specified IdP.

Return type:

BoxList

Examples

>>> for scim_attribute in zpa.scim_attributes.list_attributes_by_idp('99999'):
...    pprint(scim_attribute)