scim_attributes

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

Methods are accessible via zpa.scim_attributes

Copyright (c) 2023, Zscaler Inc.

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 ScimAttributeHeaderAPI

Bases: APIClient

A client object for the SCIM Attribute Header resource.

get_scim_attribute(idp_id, attribute_id, query_params=None)

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 SCIMAttributeHeader resource object.

Return type:

SCIMAttributeHeader

Examples

>>> attribute = zpa.scim_attributes.get_attribute('99999', scim_attribute_id="88888")
get_scim_values(idp_id, attribute_id, query_params=None)

Returns information on the specified SCIM attribute values.

Parameters:

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

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

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.

Returns:

A list of attribute values for the SCIM attribute.

Return type:

list

Examples

>>> fetched_attribute, _, err = client.zpa.scim_attributes.get_scim_values()
>>> if err:
...     print(f"Error fetching SCIM Attribute by ID: {err}")
...     return
list_scim_attributes(idp_id, query_params=None)

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.

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.

Returns:

A list of SCIMAttributeHeader instances.

Return type:

list

Examples

>>> attributes_list, _, err = client.zpa.scim_attributes.list_scim_attributes(
...     idp_id=idp_id, query_params={"page": '1', "page_size": '10'}
... )
... if err:
...     print(f"Error listing SCIM Attributes: {err}")
...     return