developer.sailpoint.com/docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md

id, title, pagination_label, sidebar_label, sidebar_class_name, keywords, slug, tags

id	title	pagination_label	sidebar_label	sidebar_class_name	keywords	slug	tags
v2024-identity-attributes	Identity_Attributes	Identity_Attributes	Identity_Attributes	pythonsdk	python Python sdk Identity_Attributes V2024Identity_Attributes	/tools/sdk/python/v2024/methods/identity-attributes	SDK Software Development Kit Identity_Attributes V2024Identity_Attributes

sailpoint.v2024.IdentityAttributesApi

All URIs are relative to https://sailpoint.api.identitynow.com/v2024

Method	HTTP request	Description
create_identity_attribute	POST /identity-attributes	Create Identity Attribute
delete_identity_attribute	DELETE /identity-attributes/{name}	Delete Identity Attribute
delete_identity_attributes_in_bulk	DELETE /identity-attributes/bulk-delete	Bulk delete Identity Attributes
get_identity_attribute	GET /identity-attributes/{name}	Get Identity Attribute
list_identity_attributes	GET /identity-attributes	List Identity Attributes
put_identity_attribute	PUT /identity-attributes/{name}	Update Identity Attribute

create-identity-attribute

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: Create Identity Attribute Use this API to create a new identity attribute.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	identity_attribute	IdentityAttribute	True

Return type

IdentityAttribute

Responses

Code	Description	Data Type	Response headers
201	The identity attribute was created successfully.	IdentityAttribute	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    identity_attribute = {
          "standard" : false,
          "system" : false,
          "sources" : [ {
            "type" : "rule",
            "properties" : {
              "ruleType" : "IdentityAttribute",
              "ruleName" : "Cloud Promote Identity Attribute"
            }
          }, {
            "type" : "rule",
            "properties" : {
              "ruleType" : "IdentityAttribute",
              "ruleName" : "Cloud Promote Identity Attribute"
            }
          } ],
          "displayName" : "Cost Center",
          "name" : "costCenter",
          "type" : "string",
          "searchable" : false,
          "multi" : false
        } # IdentityAttribute | 

    try:
        # Create Identity Attribute
        Result = identity_attribute.from_json(identity_attribute)
        api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.create_identity_attribute(x_sail_point_experimental, Result)
        print("The response of IdentityAttributesApi->create_identity_attribute:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->create_identity_attribute: %s\n" % e)

[Back to top]

delete-identity-attribute

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: Delete Identity Attribute This deletes an identity attribute with the given name. The system and standard properties must be set to false before you can delete an identity attribute.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	name	str	True	The attribute's technical name.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
204	No content - indicates the request was successful but there is no content to be returned in the response.		-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Delete Identity Attribute
        
        api_instance.delete_identity_attribute(name, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_identity_attribute(name, x_sail_point_experimental)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e)

[Back to top]

delete-identity-attributes-in-bulk

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: Bulk delete Identity Attributes Use this API to bulk delete identity attributes for a given set of names. Attributes that are currently mapped in an identity profile cannot be deleted. The system and standard properties must be set to 'false' before you can delete an identity attribute.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	identity_attribute_names	IdentityAttributeNames	True

Return type

(empty response body)

Responses

Code	Description	Data Type	Response headers
204	No content - indicates the request was successful but there is no content to be returned in the response.		-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNames
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    identity_attribute_names = {
          "ids" : [ "name", "displayName" ]
        } # IdentityAttributeNames | 

    try:
        # Bulk delete Identity Attributes
        Result = identity_attribute_names.from_json(identity_attribute_names)
        api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_instance.delete_identity_attributes_in_bulk(x_sail_point_experimental, Result)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e)

[Back to top]

get-identity-attribute

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: Get Identity Attribute This gets an identity attribute for a given technical name.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	name	str	True	The attribute's technical name.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.

Return type

IdentityAttribute

Responses

Code	Description	Data Type	Response headers
200	The identity attribute with the given name	IdentityAttribute	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')

    try:
        # Get Identity Attribute
        
        api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.get_identity_attribute(name, x_sail_point_experimental)
        print("The response of IdentityAttributesApi->get_identity_attribute:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->get_identity_attribute: %s\n" % e)

[Back to top]

list-identity-attributes

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: List Identity Attributes Use this API to get a collection of identity attributes.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Query	include_system	bool	(optional) (default to False)	Include 'system' attributes in the response.
Query	include_silent	bool	(optional) (default to False)	Include 'silent' attributes in the response.
Query	searchable_only	bool	(optional) (default to False)	Include only 'searchable' attributes in the response.
Query	count	bool	(optional) (default to False)	If true it will populate the X-Total-Count response header with the number of results that would be returned if limit and offset were ignored. Since requesting a total count can have a performance impact, it is recommended not to send count=true if that value will not be used. See V3 API Standard Collection Parameters for more information.

Return type

List[IdentityAttribute]

Responses

Code	Description	Data Type	Response headers
200	List of identity attributes.	List[IdentityAttribute]	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: Not defined
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    include_system = False # bool | Include 'system' attributes in the response. (optional) (default to False) # bool | Include 'system' attributes in the response. (optional) (default to False)
    include_silent = False # bool | Include 'silent' attributes in the response. (optional) (default to False) # bool | Include 'silent' attributes in the response. (optional) (default to False)
    searchable_only = False # bool | Include only 'searchable' attributes in the response. (optional) (default to False) # bool | Include only 'searchable' attributes in the response. (optional) (default to False)
    count = False # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False) # bool | If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored.  Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used.  See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to False)

    try:
        # List Identity Attributes
        
        api_response = api_instance.list_identity_attributes(x_sail_point_experimental, )
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count)
        print("The response of IdentityAttributesApi->list_identity_attributes:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->list_identity_attributes: %s\n" % e)

[Back to top]

put-identity-attribute

:::warning experimental This API is currently in an experimental state. The API is subject to change based on feedback and further testing. You must include the X-SailPoint-Experimental header and set it to true to use this endpoint. ::: Update Identity Attribute This updates an existing identity attribute. Making an attribute searchable requires that the system, standard, and multi properties be set to false.

API Spec

Parameters

Param Type	Name	Data Type	Required	Description
Path	name	str	True	The attribute's technical name.
x_sail_point_experimental	str	True (default to 'true')	Use this header to enable this experimental API.
Body	identity_attribute	IdentityAttribute	True

Return type

IdentityAttribute

Responses

Code	Description	Data Type	Response headers
200	The identity attribute was updated successfully	IdentityAttribute	-
400	Client Error - Returned if the request body is invalid.	ErrorResponseDto	-
401	Unauthorized - Returned if there is no authorization header, or if the JWT token is expired.	ListAccessProfiles401Response	-
403	Forbidden - Returned if the user you are running as, doesn't have access to this end-point.	ErrorResponseDto	-
404	Not Found - returned if the request URL refers to a resource or object that does not exist	ErrorResponseDto	-
429	Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again.	ListAccessProfiles429Response	-
500	Internal Server Error - Returned if there is an unexpected error.	ErrorResponseDto	-

HTTP request headers

• Content-Type: application/json
• Accept: application/json

Example

import sailpoint.v2024
from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.v2024.rest import ApiException
from pprint import pprint

    name = 'displayName' # str | The attribute's technical name. # str | The attribute's technical name.
    x_sail_point_experimental = 'true' # str | Use this header to enable this experimental API. (default to 'true') # str | Use this header to enable this experimental API. (default to 'true')
    identity_attribute = {
          "standard" : false,
          "system" : false,
          "sources" : [ {
            "type" : "rule",
            "properties" : {
              "ruleType" : "IdentityAttribute",
              "ruleName" : "Cloud Promote Identity Attribute"
            }
          }, {
            "type" : "rule",
            "properties" : {
              "ruleType" : "IdentityAttribute",
              "ruleName" : "Cloud Promote Identity Attribute"
            }
          } ],
          "displayName" : "Cost Center",
          "name" : "costCenter",
          "type" : "string",
          "searchable" : false,
          "multi" : false
        } # IdentityAttribute | 

    try:
        # Update Identity Attribute
        Result = identity_attribute.from_json(identity_attribute)
        api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result)
        
        # Below is a request that includes all optional parameters
        # api_response = api_instance.put_identity_attribute(name, x_sail_point_experimental, Result)
        print("The response of IdentityAttributesApi->put_identity_attribute:\n")
        pprint(api_response)
    except Exception as e:
        print("Exception when calling IdentityAttributesApi->put_identity_attribute: %s\n" % e)

[Back to top]