LukeParke/developer.sailpoint.com
1
0
Fork 0
mirror of https://github.com/LukeHagar/developer.sailpoint.com.git synced 2025-12-09 12:27:47 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update python SDK docs: 15641142622

Browse Source
This commit is contained in:
developer-relations-sp
2025-06-13 18:11:15 +00:00
parent dc7cf10d28
commit c123aba4cb
8 changed files with 132 additions and 660 deletions
Download Patch File Download Diff File Expand all files Collapse all files

108
docs/tools/sdk/python/Reference/V2024/Methods/IdentityAttributesApi.md
View File

@@ -24,17 +24,6 @@ Method | HTTP request | Description
## 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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Create identity attribute
Use this API to create a new identity attribute.
@@ -44,7 +33,6 @@ Use this API to create a new identity attribute.
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**](../models/identity-attribute) | True |
### Return type
@@ -74,10 +62,8 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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,
@@ -104,9 +90,9 @@ with ApiClient(configuration) as api_client:
try:
# Create identity attribute
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute)
results = IdentityAttributesApi(api_client).create_identity_attribute(identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).create_identity_attribute(x_sail_point_experimental, new_identity_attribute)
# results = IdentityAttributesApi(api_client).create_identity_attribute(new_identity_attribute)
print("The response of IdentityAttributesApi->create_identity_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -118,17 +104,6 @@ with ApiClient(configuration) as api_client:
[[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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -139,7 +114,6 @@ This deletes an identity attribute with the given name. The `system` and `stand
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)
@@ -167,18 +141,16 @@ from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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
IdentityAttributesApi(api_client).delete_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental)
IdentityAttributesApi(api_client).delete_identity_attribute(name=name)
# Below is a request that includes all optional parameters
# IdentityAttributesApi(api_client).delete_identity_attribute(name, x_sail_point_experimental)
# IdentityAttributesApi(api_client).delete_identity_attribute(name)
except Exception as e:
print("Exception when calling IdentityAttributesApi->delete_identity_attribute: %s\n" % e)
```
@@ -188,17 +160,6 @@ with ApiClient(configuration) as api_client:
[[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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -208,7 +169,6 @@ Use this API to bulk delete identity attributes for a given set of names. Attrib
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**](../models/identity-attribute-names) | True |
### Return type
@@ -238,10 +198,8 @@ from sailpoint.v2024.models.identity_attribute_names import IdentityAttributeNam
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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 |
@@ -249,9 +207,9 @@ with ApiClient(configuration) as api_client:
try:
# Bulk delete identity attributes
new_identity_attribute_names = IdentityAttributeNames.from_json(identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental=x_sail_point_experimental, identity_attribute_names=new_identity_attribute_names)
IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(identity_attribute_names=new_identity_attribute_names)
# Below is a request that includes all optional parameters
# IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(x_sail_point_experimental, new_identity_attribute_names)
# IdentityAttributesApi(api_client).delete_identity_attributes_in_bulk(new_identity_attribute_names)
except Exception as e:
print("Exception when calling IdentityAttributesApi->delete_identity_attributes_in_bulk: %s\n" % e)
```
@@ -261,17 +219,6 @@ with ApiClient(configuration) as api_client:
[[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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
Get identity attribute
This gets an identity attribute for a given technical name.
@@ -282,7 +229,6 @@ This gets an identity attribute for a given technical name.
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**](../models/identity-attribute)
@@ -311,18 +257,16 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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
results = IdentityAttributesApi(api_client).get_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental)
results = IdentityAttributesApi(api_client).get_identity_attribute(name=name)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).get_identity_attribute(name, x_sail_point_experimental)
# results = IdentityAttributesApi(api_client).get_identity_attribute(name)
print("The response of IdentityAttributesApi->get_identity_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -334,17 +278,6 @@ with ApiClient(configuration) as api_client:
[[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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
List identity attributes
Use this API to get a collection of identity attributes.
@@ -354,7 +287,6 @@ Use this API to get a collection of identity attributes.
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.
@@ -386,10 +318,8 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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)
@@ -398,9 +328,9 @@ with ApiClient(configuration) as api_client:
try:
# List identity attributes
results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental=x_sail_point_experimental)
results = IdentityAttributesApi(api_client).list_identity_attributes()
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).list_identity_attributes(x_sail_point_experimental, include_system, include_silent, searchable_only, count)
# results = IdentityAttributesApi(api_client).list_identity_attributes(include_system, include_silent, searchable_only, count)
print("The response of IdentityAttributesApi->list_identity_attributes:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -413,17 +343,6 @@ with ApiClient(configuration) as api_client:
[[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.
:::
:::tip setting x-sailpoint-experimental header
on the configuration object you can set the `x-sailpoint-experimental` header to `true' to enable all experimantl endpoints within the SDK.
Example:
```python
configuration = Configuration()
configuration.experimental = True
```
:::
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.
@@ -434,7 +353,6 @@ This updates an existing identity attribute. Making an attribute searchable req
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**](../models/identity-attribute) | True |
### Return type
@@ -464,11 +382,9 @@ from sailpoint.v2024.models.identity_attribute import IdentityAttribute
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
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,
@@ -495,9 +411,9 @@ with ApiClient(configuration) as api_client:
try:
# Update identity attribute
new_identity_attribute = IdentityAttribute.from_json(identity_attribute)
results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, x_sail_point_experimental=x_sail_point_experimental, identity_attribute=new_identity_attribute)
results = IdentityAttributesApi(api_client).put_identity_attribute(name=name, identity_attribute=new_identity_attribute)
# Below is a request that includes all optional parameters
# results = IdentityAttributesApi(api_client).put_identity_attribute(name, x_sail_point_experimental, new_identity_attribute)
# results = IdentityAttributesApi(api_client).put_identity_attribute(name, new_identity_attribute)
print("The response of IdentityAttributesApi->put_identity_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: