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

Update python SDK docs: 16525292132

Browse Source
This commit is contained in:
developer-relations-sp
2025-07-25 15:10:03 +00:00
parent be23bab385
commit 993bfb3fea
101 changed files with 2689 additions and 1526 deletions
Download Patch File Download Diff File Expand all files Collapse all files

90
docs/tools/sdk/python/Reference/V2024/Methods/AccessModelMetadataApi.md
View File

@@ -32,17 +32,6 @@ Method | HTTP request | Description
## get-access-model-metadata-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 access model metadata attribute
Get single Access Model Metadata Attribute
@@ -53,7 +42,6 @@ Get single Access Model Metadata Attribute
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**AttributeDTO**](../models/attribute-dto)
@@ -81,18 +69,16 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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 access model metadata attribute
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key, x_sail_point_experimental=x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key=key)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute(key)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -104,17 +90,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-access-model-metadata-attribute-value
:::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 access model metadata value
Get single Access Model Metadata Attribute Value
@@ -126,7 +101,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute.
Path | value | **str** | True | Technical name of the Attribute value.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**AttributeValueDTO**](../models/attribute-value-dto)
@@ -154,19 +128,17 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
value = 'public' # str | Technical name of the Attribute value. # str | Technical name of the Attribute value.
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 access model metadata value
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value, x_sail_point_experimental=x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key=key, value=value)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).get_access_model_metadata_attribute_value(key, value)
print("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -178,17 +150,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-model-metadata-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
```
:::
List access model metadata attributes
Get a list of Access Model Metadata Attributes
@@ -198,8 +159,11 @@ Get a list of Access Model Metadata 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 | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and*
Query | filters | **str** | (optional) | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and*
Query | sorters | **str** | (optional) | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key**
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**List[AttributeDTO]**](../models/attribute-dto)
@@ -227,18 +191,20 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO
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')
filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* Supported composite operators: *and* (optional)
filters = 'name eq \"Privacy\"' # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional) # str | Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **key**: *eq* **name**: *eq* **type**: *eq* **status**: *eq* **objectTypes**: *eq* **Supported composite operators**: *and* (optional)
sorters = 'name,-key' # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional) # str | Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, key** (optional)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
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 access model metadata attributes
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental=x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(x_sail_point_experimental, filters)
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(filters, sorters, offset, limit, count)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -251,17 +217,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-access-model-metadata-attribute-value
:::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 access model metadata values
Get a list of Access Model Metadata Attribute Values
@@ -272,7 +227,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
### Return type
[**List[AttributeValueDTO]**](../models/attribute-value-dto)
@@ -300,18 +257,19 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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')
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
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 access model metadata values
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key, x_sail_point_experimental=x_sail_point_experimental)
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, x_sail_point_experimental)
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key, offset, limit, count)
print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))

216
docs/tools/sdk/python/Reference/V2024/Methods/EntitlementsApi.md
View File

@@ -79,17 +79,6 @@ Method | HTTP request | Description
## create-access-model-metadata-for-entitlement
:::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
```
:::
Add metadata to an entitlement.
Add single Access Model Metadata to an entitlement.
@@ -102,7 +91,6 @@ Param Type | Name | Data Type | Required | Description
Path | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**Entitlement**](../models/entitlement)
@@ -130,20 +118,18 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
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:
# Add metadata to an entitlement.
results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
# results = EntitlementsApi(api_client).create_access_model_metadata_for_entitlement(id, attribute_key, attribute_value)
print("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -155,17 +141,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## delete-access-model-metadata-from-entitlement
:::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
```
:::
Remove metadata from an entitlement.
Remove single Access Model Metadata from an entitlement.
@@ -178,7 +153,6 @@ Param Type | Name | Data Type | Required | Description
Path | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value.
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
(empty response body)
@@ -205,20 +179,18 @@ from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id.
attribute_key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
attribute_value = 'public' # str | Technical name of the Attribute Value. # str | Technical name of the Attribute Value.
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:
# Remove metadata from an entitlement.
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value, x_sail_point_experimental=x_sail_point_experimental)
EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id=id, attribute_key=attribute_key, attribute_value=attribute_value)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value, x_sail_point_experimental)
# EntitlementsApi(api_client).delete_access_model_metadata_from_entitlement(id, attribute_key, attribute_value)
except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e)
```
@@ -228,17 +200,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement
:::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 an entitlement
This API returns an entitlement by its ID.
@@ -249,7 +210,6 @@ This API returns an entitlement by its ID.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The entitlement ID
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**Entitlement**](../models/entitlement)
@@ -278,18 +238,16 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID
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 an entitlement
results = EntitlementsApi(api_client).get_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).get_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).get_entitlement(id)
print("The response of EntitlementsApi->get_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -301,17 +259,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## get-entitlement-request-config
:::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 entitlement request config
This API returns the entitlement request config for a specified entitlement.
@@ -322,7 +269,6 @@ This API returns the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config)
@@ -351,18 +297,16 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
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 entitlement request config
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).get_entitlement_request_config(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).get_entitlement_request_config(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).get_entitlement_request_config(id)
print("The response of EntitlementsApi->get_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -377,17 +321,6 @@ with ApiClient(configuration) as api_client:
:::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API.
:::
:::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
```
:::
Aggregate entitlements
Starts an entitlement aggregation on the specified source. Though this endpoint has been deprecated, you can find its Beta equivalent [here](https://developer.sailpoint.com/docs/api/beta/import-entitlements).
@@ -402,7 +335,6 @@ If the target source is a delimited file source, then the CSV file needs to be i
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
| csv_file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type
@@ -431,19 +363,17 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id
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')
csv_file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
try:
# Aggregate entitlements
results = EntitlementsApi(api_client).import_entitlements_by_source(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).import_entitlements_by_source(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).import_entitlements_by_source(id, x_sail_point_experimental, csv_file)
# results = EntitlementsApi(api_client).import_entitlements_by_source(id, csv_file)
print("The response of EntitlementsApi->import_entitlements_by_source:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -455,17 +385,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-entitlement-children
:::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 of entitlements children
This API returns a list of all child entitlements of a given entitlement.
@@ -476,7 +395,6 @@ This API returns a list of all child entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
@@ -510,11 +428,9 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id
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')
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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)
@@ -524,9 +440,9 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements children
results = EntitlementsApi(api_client).list_entitlement_children(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).list_entitlement_children(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_children(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlement_children(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_children:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -539,17 +455,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-entitlement-parents
:::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 of entitlements parents
This API returns a list of all parent entitlements of a given entitlement.
@@ -560,7 +465,6 @@ This API returns a list of all parent entitlements of a given entitlement.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Query | limit | **int** | (optional) (default to 250) | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
Query | offset | **int** | (optional) (default to 0) | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
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](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
@@ -594,11 +498,9 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id
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')
limit = 250 # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250) # int | Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 250)
offset = 0 # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0) # int | Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information. (optional) (default to 0)
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)
@@ -608,9 +510,9 @@ with ApiClient(configuration) as api_client:
try:
# List of entitlements parents
results = EntitlementsApi(api_client).list_entitlement_parents(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).list_entitlement_parents(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlement_parents(id, x_sail_point_experimental, limit, offset, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlement_parents(id, limit, offset, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlement_parents:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -623,17 +525,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-entitlements
:::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
```
:::
Gets a list of entitlements.
This API returns a list of entitlements.
@@ -647,7 +538,6 @@ Any authenticated token can call this API.
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 | account_id | **str** | (optional) | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s).
Query | segmented_for_identity | **str** | (optional) | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity.
Query | for_segment_ids | **str** | (optional) | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
@@ -684,10 +574,8 @@ from sailpoint.v2024.models.entitlement import Entitlement
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')
account_id = 'ef38f94347e94562b5bb8424a56397d8' # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional) # str | The account ID. If specified, returns only entitlements associated with the given Account. Cannot be specified with the **filters**, **segmented-for-identity**, **for-segment-ids**, or **include-unsegmented** param(s). (optional)
segmented_for_identity = 'e554098913544630b5985e9042f5e44b' # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional) # str | If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user's Identity. (optional)
for_segment_ids = '041727d4-7d95-4779-b891-93cf41e98249,a378c9fa-bae5-494c-804e-a1e30f69f649' # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional) # str | If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s). (optional)
@@ -701,9 +589,9 @@ with ApiClient(configuration) as api_client:
try:
# Gets a list of entitlements.
results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).list_entitlements()
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).list_entitlements(x_sail_point_experimental, account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
# results = EntitlementsApi(api_client).list_entitlements(account_id, segmented_for_identity, for_segment_ids, include_unsegmented, offset, limit, count, sorters, filters)
print("The response of EntitlementsApi->list_entitlements:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
@@ -716,17 +604,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## patch-entitlement
:::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
```
:::
Patch an entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax.
@@ -741,7 +618,6 @@ When you're patching owner, only owner type and owner id must be provided. Owner
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of the entitlement to patch
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type
@@ -772,19 +648,17 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch
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')
json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try:
# Patch an entitlement
results = EntitlementsApi(api_client).patch_entitlement(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).patch_entitlement(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).patch_entitlement(id, x_sail_point_experimental, new_json_patch_operation)
# results = EntitlementsApi(api_client).patch_entitlement(id, new_json_patch_operation)
print("The response of EntitlementsApi->patch_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -796,17 +670,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## put-entitlement-request-config
:::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
```
:::
Replace entitlement request config
This API replaces the entitlement request config for a specified entitlement.
@@ -817,7 +680,6 @@ This API replaces the entitlement request config for a specified entitlement.
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement ID
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
Body | entitlement_request_config | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type
@@ -847,11 +709,9 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID
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')
entitlement_request_config = '''{
"accessRequestConfig" : {
"denialCommentRequired" : false,
@@ -879,9 +739,9 @@ with ApiClient(configuration) as api_client:
try:
# Replace entitlement request config
new_entitlement_request_config = EntitlementRequestConfig.from_json(entitlement_request_config)
results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, x_sail_point_experimental=x_sail_point_experimental, entitlement_request_config=new_entitlement_request_config)
results = EntitlementsApi(api_client).put_entitlement_request_config(id=id, entitlement_request_config=new_entitlement_request_config)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).put_entitlement_request_config(id, x_sail_point_experimental, new_entitlement_request_config)
# results = EntitlementsApi(api_client).put_entitlement_request_config(id, new_entitlement_request_config)
print("The response of EntitlementsApi->put_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -893,17 +753,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## reset-source-entitlements
:::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
```
:::
Reset source entitlements
Remove all entitlements from a specific source.
To reload the accounts along with the entitlements you removed, you must run an unoptimized aggregation. To do so, use [Account Aggregation](https://developer.sailpoint.com/docs/api/v2024/import-accounts/) with `disableOptimization` = `true`.
@@ -915,7 +764,6 @@ To reload the accounts along with the entitlements you removed, you must run an
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of source for the entitlement reset
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)
@@ -943,18 +791,16 @@ from sailpoint.v2024.models.entitlement_source_reset_base_reference_dto import E
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset
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:
# Reset source entitlements
results = EntitlementsApi(api_client).reset_source_entitlements(id=id, x_sail_point_experimental=x_sail_point_experimental)
results = EntitlementsApi(api_client).reset_source_entitlements(id=id)
# Below is a request that includes all optional parameters
# results = EntitlementsApi(api_client).reset_source_entitlements(id, x_sail_point_experimental)
# results = EntitlementsApi(api_client).reset_source_entitlements(id)
print("The response of EntitlementsApi->reset_source_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
@@ -966,17 +812,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-entitlements-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 update an entitlement list
This API applies an update to every entitlement of the list.
@@ -999,7 +834,6 @@ A token with ORG_ADMIN or API authority is required to call this API.
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 | entitlement_bulk_update_request | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type
@@ -1028,10 +862,8 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu
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')
entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ {
@@ -1052,9 +884,9 @@ with ApiClient(configuration) as api_client:
try:
# Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental=x_sail_point_experimental, entitlement_bulk_update_request=new_entitlement_bulk_update_request)
EntitlementsApi(api_client).update_entitlements_in_bulk(entitlement_bulk_update_request=new_entitlement_bulk_update_request)
# Below is a request that includes all optional parameters
# EntitlementsApi(api_client).update_entitlements_in_bulk(x_sail_point_experimental, new_entitlement_bulk_update_request)
# EntitlementsApi(api_client).update_entitlements_in_bulk(new_entitlement_bulk_update_request)
except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e)
```

12
docs/tools/sdk/python/Reference/V2024/Methods/IdentityHistoryApi.md
View File

@@ -18,7 +18,7 @@ Method | HTTP request | Description
[**compare-identity-snapshots**](#compare-identity-snapshots) | **GET** `/historical-identities/{id}/compare` | Gets a difference of count for each access item types for the given identity between 2 snapshots
[**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{access-type}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots
[**get-historical-identity**](#get-historical-identity) | **GET** `/historical-identities/{id}` | Get latest snapshot of identity
[**get-historical-identity-events**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | Lists all events for the given identity
[**get-historical-identity-events**](#get-historical-identity-events) | **GET** `/historical-identities/{id}/events` | List identity event history
[**get-identity-snapshot**](#get-identity-snapshot) | **GET** `/historical-identities/{id}/snapshots/{date}` | Gets an identity snapshot at a given date
[**get-identity-snapshot-summary**](#get-identity-snapshot-summary) | **GET** `/historical-identities/{id}/snapshot-summary` | Gets the summary for the event count for a specific identity
[**get-identity-start-date**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
@@ -284,7 +284,7 @@ This API is currently in an experimental state. The API is subject to change bas
configuration.experimental = True
```
:::
Lists all events for the given identity
List identity event history
This method retrieves all access events for the identity Requires authorization scope of 'idn:identity-history:read'
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-historical-identity-events)
@@ -342,7 +342,7 @@ with ApiClient(configuration) as api_client:
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:
# Lists all events for the given identity
# List identity event history
results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id, x_sail_point_experimental=x_sail_point_experimental)
# Below is a request that includes all optional parameters
@@ -779,12 +779,12 @@ Path | var_date | **str** | True | The specified date
Query | type | **str** | (optional) | The access item type
### Return type
[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner)
[**List[ListIdentitySnapshotAccessItems200ResponseInner]**](../models/list-identity-snapshot-access-items200-response-inner)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | The identity object. | List[ListIdentityAccessItems200ResponseInner] | - |
200 | The identity object. | List[ListIdentitySnapshotAccessItems200ResponseInner] | - |
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 | - |
@@ -800,7 +800,7 @@ Code | Description | Data Type | Response headers |
```python
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
from sailpoint.v2024.models.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
from sailpoint.configuration import Configuration
configuration = Configuration()

51
docs/tools/sdk/python/Reference/V2024/Methods/MachineClassificationConfigApi.md
View File

@@ -180,7 +180,56 @@ configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{
"criteria" : "criteria",
"criteria" : {
"children" : [ {
"children" : [ {
"children" : [ "children", "children" ],
"caseSensitive" : false,
"dataType" : "This is the first level of classification criteria",
"attribute" : "sAMAccountName",
"operation" : "EQUALS",
"value" : "SVC"
}, {
"children" : [ "children", "children" ],
"caseSensitive" : false,
"dataType" : "This is the first level of classification criteria",
"attribute" : "sAMAccountName",
"operation" : "EQUALS",
"value" : "SVC"
} ],
"caseSensitive" : false,
"dataType" : "dataType",
"attribute" : "employeeType",
"operation" : "EQUALS",
"value" : "SERVICE"
}, {
"children" : [ {
"children" : [ "children", "children" ],
"caseSensitive" : false,
"dataType" : "This is the first level of classification criteria",
"attribute" : "sAMAccountName",
"operation" : "EQUALS",
"value" : "SVC"
}, {
"children" : [ "children", "children" ],
"caseSensitive" : false,
"dataType" : "This is the first level of classification criteria",
"attribute" : "sAMAccountName",
"operation" : "EQUALS",
"value" : "SVC"
} ],
"caseSensitive" : false,
"dataType" : "dataType",
"attribute" : "employeeType",
"operation" : "EQUALS",
"value" : "SERVICE"
} ],
"caseSensitive" : false,
"dataType" : "dataType",
"attribute" : "distinguishedName",
"operation" : "EQUALS",
"value" : "OU=Service Accounts"
},
"created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE",

18
docs/tools/sdk/python/Reference/V2024/Methods/SourcesApi.md
View File

@@ -1975,17 +1975,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## import-entitlements
:::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
```
:::
Entitlement aggregation
Starts an entitlement aggregation on the specified source.
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
@@ -1999,7 +1988,6 @@ A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required t
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | Source Id
| x_sail_point_experimental | **str** | True (default to 'true') | Use this header to enable this experimental API.
| file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type
@@ -2028,19 +2016,17 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration
configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id
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')
file = None # bytearray | The CSV file containing the source entitlements to aggregate. (optional) # bytearray | The CSV file containing the source entitlements to aggregate. (optional)
try:
# Entitlement aggregation
results = SourcesApi(api_client).import_entitlements(source_id=source_id, x_sail_point_experimental=x_sail_point_experimental)
results = SourcesApi(api_client).import_entitlements(source_id=source_id)
# Below is a request that includes all optional parameters
# results = SourcesApi(api_client).import_entitlements(source_id, x_sail_point_experimental, file)
# results = SourcesApi(api_client).import_entitlements(source_id, file)
print("The response of SourcesApi->import_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:

28
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccessProfileResponse.md
View File

@@ -16,18 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**description** | **str** | the description for the access profile | [optional]
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional]
**app_display_name** | **str** | the name of | [optional]
**source_name** | **str** | the name of the source | [optional]
**entitlement_count** | **int** | the number of entitlements the access profile will create | [required]
**description** | **str** | the description for the access profile | [optional]
**source_id** | **str** | the id of the source | [optional]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**remove_date** | **str** | the date the access profile is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**revocable** | **bool** | indicates whether the access profile is | [required]
**revocable** | **bool** | indicates whether the access profile is revocable | [required]
}
## Example
@@ -36,15 +35,14 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_access_profile_response import AccessItemAccessProfileResponse
access_item_access_profile_response = AccessItemAccessProfileResponse(
access_type='accessProfile',
id='2c918087763e69d901763e72e97f006f',
name='sample',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='AccessProfile - Workday/Citizenship access',
access_type='accessProfile',
display_name='Dr. Arden Rogahn MD',
entitlement_count='12',
app_display_name='AppName',
source_name='DataScienceDataset',
entitlement_count=12,
description='AccessProfile - Workday/Citizenship access',
source_id='2793o32dwd',
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
standalone=False,
revocable=True

35
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccessProfileResponseAppRefsInner.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-access-item-access-profile-response-app-refs-inner
title: AccessItemAccessProfileResponseAppRefsInner
pagination_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_label: AccessItemAccessProfileResponseAppRefsInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessItemAccessProfileResponseAppRefsInner', 'V2024AccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/python/v2024/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'V2024AccessItemAccessProfileResponseAppRefsInner']
---
# AccessItemAccessProfileResponseAppRefsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**cloud_app_id** | **str** | the cloud app id associated with the access profile | [optional]
**cloud_app_name** | **str** | the cloud app name associated with the access profile | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_item_access_profile_response_app_refs_inner import AccessItemAccessProfileResponseAppRefsInner
access_item_access_profile_response_app_refs_inner = AccessItemAccessProfileResponseAppRefsInner(
cloud_app_id='8c190e6787aa4ed9a90bd9d5344523fb',
cloud_app_name='Sample App'
)
```
[[Back to top]](#)

18
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAccountResponse.md
View File

@@ -16,13 +16,13 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccountResponse', 'V2024Acc
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. account in this case | [optional]
**id** | **str** | the access item id | [optional]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional]
**access_type** | **str** | the access item type. account in this case | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**source_name** | **str** | the name of the source | [optional]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **int** | the number of entitlements the account will create | [optional]
}
## Example
@@ -31,13 +31,13 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_account_response import AccessItemAccountResponse
access_item_account_response = AccessItemAccountResponse(
access_type='account',
id='2c918087763e69d901763e72e97f006f',
native_identity='dr.arden.ogahn.d',
access_type='account',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset',
native_identity='dr.arden.ogahn.d',
source_id='2793o32dwd',
entitlement_count='12',
display_name='Dr. Arden Rogahn MD'
entitlement_count=12
)
```

6
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAppResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAppResponse', 'V2024AccessI
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**app_role_id** | **str** | the app role id | [optional]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -29,8 +29,8 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_app_response import AccessItemAppResponse
access_item_app_response = AccessItemAppResponse(
access_type='app',
id='2c918087763e69d901763e72e97f006f',
access_type='app',
display_name='Display Name',
source_name='appName',
app_role_id='2c918087763e69d901763e72e97f006f'

20
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociated.md
View File

@@ -16,11 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2024AccessIt
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**date_time** | **str** | the date of event | [optional]
**identity_id** | **str** | the identity id | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
}
## Example
@@ -29,20 +30,21 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_associated import AccessItemAssociated
access_item_associated = AccessItemAssociated(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemAssociated',
dt='2019-03-08T22:37:33.901Z',
date_time='2019-03-08T22:37:33.901Z',
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
date_time = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), )
display_name = 'John Snow', ), ),
access_item_type='account'
)
```

56
docs/tools/sdk/python/Reference/V2024/Models/AccessItemAssociatedAccessItem.md
View File

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V20
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**source_id** | **str** | the id of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional]
**app_display_name** | **str** | the name of | [optional]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional]
**app_role_id** | **str** | the app role id | [optional]
**attribute** | **str** | the entitlement attribute | [optional]
**value** | **str** | the associated value | [optional]
**entitlement_type** | **str** | the type of entitlement | [optional]
**source_id** | **str** | the id of the source | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_associated_access_item import AccessItemAssociatedAccessItem
access_item_associated_access_item = AccessItemAssociatedAccessItem(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
name='sample',
source_name='Source Name',
source_id='2793o32dwd',
description='Role - Workday/Citizenship access',
display_name='sample',
entitlement_count='12',
app_display_name='AppName',
remove_date='2024-07-01T06:00:00.00Z',
standalone=True,
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f',
access_type='app',
display_name='Display Name',
source_name='appName',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=False,
cloud_governed=True
cloud_governed=True,
entitlement_count=12,
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f'
)
```

24
docs/tools/sdk/python/Reference/V2024/Models/AccessItemEntitlementResponse.md
View File

@@ -16,15 +16,15 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemEntitlementResponse', 'V202
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional]
**attribute** | **str** | the entitlement attribute | [optional]
**value** | **str** | the associated value | [optional]
**entitlement_type** | **str** | the type of entitlement | [optional]
**source_name** | **str** | the name of the source | [optional]
**source_id** | **str** | the id of the source | [optional]
**description** | **str** | the description for the entitlment | [optional]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the display name of the identity | [optional]
**source_name** | **str** | the name of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**description** | **str** | the description for the entitlment | [optional]
**source_id** | **str** | the id of the source | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
@@ -36,15 +36,15 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_entitlement_response import AccessItemEntitlementResponse
access_item_entitlement_response = AccessItemEntitlementResponse(
access_type='entitlement',
id='2c918087763e69d901763e72e97f006f',
access_type='entitlement',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
source_name='DataScienceDataset',
source_id='2793o32dwd',
type='ENTITLEMENT',
description='Entitlement - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD',
source_id='2793o32dwd',
standalone=True,
privileged=False,
cloud_governed=True

10
docs/tools/sdk/python/Reference/V2024/Models/AccessItemRemoved.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2024AccessItemR
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
}
@@ -32,10 +33,11 @@ access_item_removed = AccessItemRemoved(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemRemoved',
dt='2019-03-08T22:37:33.901Z',
date_time='2019-03-08T22:37:33.901Z',
access_item_type='account',
governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
date_time = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

8
docs/tools/sdk/python/Reference/V2024/Models/AccessItemRoleResponse.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2024Access
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. role in this case | [optional]
**display_name** | **str** | the role display name | [optional]
**description** | **str** | the description for the role | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**description** | **str** | the description for the role | [optional]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**revocable** | **bool** | indicates whether the role is revocable | [required]
}
@@ -31,11 +31,11 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name',
description='Role - Workday/Citizenship access',
remove_date='2024-07-01T06:00:00.00Z',
revocable=True
)

47
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestItemResponse.md
View File

@@ -1,47 +0,0 @@
---
id: v2024-access-request-item-response
title: AccessRequestItemResponse
pagination_label: AccessRequestItemResponse
sidebar_label: AccessRequestItemResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse']
slug: /tools/sdk/python/v2024/models/access-request-item-response
tags: ['SDK', 'Software Development Kit', 'AccessRequestItemResponse', 'V2024AccessRequestItemResponse']
---
# AccessRequestItemResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | **str** | the access request item operation | [optional]
**access_item_type** | **str** | the access item type | [optional]
**name** | **str** | the name of access request item | [optional]
**decision** | **Enum** [ 'APPROVED', 'REJECTED' ] | the final decision for the access request | [optional]
**description** | **str** | the description of access request item | [optional]
**source_id** | **str** | the source id | [optional]
**source_name** | **str** | the source Name | [optional]
**approval_infos** | [**[]ApprovalInfoResponse**](approval-info-response) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_request_item_response import AccessRequestItemResponse
access_request_item_response = AccessRequestItemResponse(
operation='Add',
access_item_type='role',
name='Role-1',
decision='APPROVED',
description='The role descrition',
source_id='8a80828f643d484f01643e14202e206f',
source_name='Source1',
approval_infos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestResponse1.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-access-request-response1
title: AccessRequestResponse1
pagination_label: AccessRequestResponse1
sidebar_label: AccessRequestResponse1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestResponse1', 'V2024AccessRequestResponse1']
slug: /tools/sdk/python/v2024/models/access-request-response1
tags: ['SDK', 'Software Development Kit', 'AccessRequestResponse1', 'V2024AccessRequestResponse1']
---
# AccessRequestResponse1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**requester_id** | **str** | the requester Id | [optional]
**requester_name** | **str** | the requesterName | [optional]
**items** | [**[]AccessRequestItemResponse**](access-request-item-response) | | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_request_response1 import AccessRequestResponse1
access_request_response1 = AccessRequestResponse1(
requester_id='2c91808a77ff216301782327a50f09bf',
requester_name='Bing C',
items=[{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}]
)
```
[[Back to top]](#)

26
docs/tools/sdk/python/Reference/V2024/Models/AccessRequested.md
View File

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2024AccessRequest
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**identity_id** | **str** | the identity id | [optional]
**date_time** | **str** | the date of event | [optional]
**account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**status_change** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
}
## Example
@@ -28,13 +29,20 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_requested import AccessRequested
access_requested = AccessRequested(
access_request=sailpoint.v2024.models.access_request_response_1.AccessRequestResponse_1(
requester_id = '2c91808a77ff216301782327a50f09bf',
requester_name = 'Bing C',
items = [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}], ),
event_type='AccountStatusChanged',
identity_id='8a80828f643d484f01643e14202e206f',
event_type='AccessRequested',
dt='2019-03-08T22:37:33.901Z'
date_time='2019-03-08T22:37:33.901Z',
account=sailpoint.v2024.models.access_requested_account.AccessRequested_account(
id = '2c91808a77ff216301782327a50f09bf',
native_identity = 'dr.arden.ogahn.d',
display_name = 'Adam Archer',
source_id = '8a80828f643d484f01643e14202e206f',
source_name = 'JDBC Entitlements Source',
entitlement_count = 2,
access_type = 'account', ),
status_change=sailpoint.v2024.models.access_requested_status_change.AccessRequested_statusChange(
previous_status = 'enabled',
new_status = 'disabled', )
)
```

45
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestedAccount.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-access-requested-account
title: AccessRequestedAccount
pagination_label: AccessRequestedAccount
sidebar_label: AccessRequestedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestedAccount', 'V2024AccessRequestedAccount']
slug: /tools/sdk/python/v2024/models/access-requested-account
tags: ['SDK', 'Software Development Kit', 'AccessRequestedAccount', 'V2024AccessRequestedAccount']
---
# AccessRequestedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the ID of the account in the database | [optional]
**native_identity** | **str** | the native identifier of the account | [optional]
**display_name** | **str** | the display name of the account | [optional]
**source_id** | **str** | the ID of the source for this account | [optional]
**source_name** | **str** | the name of the source for this account | [optional]
**entitlement_count** | **int** | the number of entitlements on this account | [optional]
**access_type** | **str** | this value is always \"account\" | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_requested_account import AccessRequestedAccount
access_requested_account = AccessRequestedAccount(
id='2c91808a77ff216301782327a50f09bf',
native_identity='dr.arden.ogahn.d',
display_name='Adam Archer',
source_id='8a80828f643d484f01643e14202e206f',
source_name='JDBC Entitlements Source',
entitlement_count=2,
access_type='account'
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/AccessRequestedStatusChange.md Normal file
View File

@@ -0,0 +1,35 @@
---
id: v2024-access-requested-status-change
title: AccessRequestedStatusChange
pagination_label: AccessRequestedStatusChange
sidebar_label: AccessRequestedStatusChange
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessRequestedStatusChange', 'V2024AccessRequestedStatusChange']
slug: /tools/sdk/python/v2024/models/access-requested-status-change
tags: ['SDK', 'Software Development Kit', 'AccessRequestedStatusChange', 'V2024AccessRequestedStatusChange']
---
# AccessRequestedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**previous_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the previous status of the account | [optional]
**new_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the new status of the account | [optional]
}
## Example
```python
from sailpoint.v2024.models.access_requested_status_change import AccessRequestedStatusChange
access_requested_status_change = AccessRequestedStatusChange(
previous_status='enabled',
new_status='disabled'
)
```
[[Back to top]](#)

32
docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChanged.md
View File

@@ -18,9 +18,9 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**date_time** | **str** | the date of event | [optional]
**account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**status_change** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
}
## Example
@@ -29,20 +29,20 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.account_status_changed import AccountStatusChanged
account_status_changed = AccountStatusChanged(
event_type='',
identity_id='',
dt='',
account=sailpoint.v2024.models.account_status_changed_account.AccountStatusChanged_account(
id = '',
native_identity = '',
display_name = '',
source_id = '',
source_name = '',
entitlement_count = 56,
access_type = '', ),
status_change=sailpoint.v2024.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
event_type='AccountStatusChanged',
identity_id='8a80828f643d484f01643e14202e206f',
date_time='2019-03-08T22:37:33.901Z',
account=sailpoint.v2024.models.access_requested_account.AccessRequested_account(
id = '2c91808a77ff216301782327a50f09bf',
native_identity = 'dr.arden.ogahn.d',
display_name = 'Adam Archer',
source_id = '8a80828f643d484f01643e14202e206f',
source_name = 'JDBC Entitlements Source',
entitlement_count = 2,
access_type = 'account', ),
status_change=sailpoint.v2024.models.access_requested_status_change.AccessRequested_statusChange(
previous_status = 'enabled',
new_status = 'enabled', )
new_status = 'disabled', )
)
```

45
docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedAccount.md
View File

@@ -1,45 +0,0 @@
---
id: v2024-account-status-changed-account
title: AccountStatusChangedAccount
pagination_label: AccountStatusChangedAccount
sidebar_label: AccountStatusChangedAccount
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount']
slug: /tools/sdk/python/v2024/models/account-status-changed-account
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedAccount', 'V2024AccountStatusChangedAccount']
---
# AccountStatusChangedAccount
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the ID of the account in the database | [optional]
**native_identity** | **str** | the native identifier of the account | [optional]
**display_name** | **str** | the display name of the account | [optional]
**source_id** | **str** | the ID of the source for this account | [optional]
**source_name** | **str** | the name of the source for this account | [optional]
**entitlement_count** | **int** | the number of entitlements on this account | [optional]
**access_type** | **str** | this value is always \"account\" | [optional]
}
## Example
```python
from sailpoint.v2024.models.account_status_changed_account import AccountStatusChangedAccount
account_status_changed_account = AccountStatusChangedAccount(
id='',
native_identity='',
display_name='',
source_id='',
source_name='',
entitlement_count=56,
access_type=''
)
```
[[Back to top]](#)

35
docs/tools/sdk/python/Reference/V2024/Models/AccountStatusChangedStatusChange.md
View File

@@ -1,35 +0,0 @@
---
id: v2024-account-status-changed-status-change
title: AccountStatusChangedStatusChange
pagination_label: AccountStatusChangedStatusChange
sidebar_label: AccountStatusChangedStatusChange
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange']
slug: /tools/sdk/python/v2024/models/account-status-changed-status-change
tags: ['SDK', 'Software Development Kit', 'AccountStatusChangedStatusChange', 'V2024AccountStatusChangedStatusChange']
---
# AccountStatusChangedStatusChange
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**previous_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the previous status of the account | [optional]
**new_status** | **Enum** [ 'enabled', 'disabled', 'locked' ] | the new status of the account | [optional]
}
## Example
```python
from sailpoint.v2024.models.account_status_changed_status_change import AccountStatusChangedStatusChange
account_status_changed_status_change = AccountStatusChangedStatusChange(
previous_status='enabled',
new_status='enabled'
)
```
[[Back to top]](#)

37
docs/tools/sdk/python/Reference/V2024/Models/ApprovalInfoResponse.md
View File

@@ -1,37 +0,0 @@
---
id: v2024-approval-info-response
title: ApprovalInfoResponse
pagination_label: ApprovalInfoResponse
sidebar_label: ApprovalInfoResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse']
slug: /tools/sdk/python/v2024/models/approval-info-response
tags: ['SDK', 'Software Development Kit', 'ApprovalInfoResponse', 'V2024ApprovalInfoResponse']
---
# ApprovalInfoResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the id of approver | [optional]
**name** | **str** | the name of approver | [optional]
**status** | **str** | the status of the approval request | [optional]
}
## Example
```python
from sailpoint.v2024.models.approval_info_response import ApprovalInfoResponse
approval_info_response = ApprovalInfoResponse(
id='8a80828f643d484f01643e14202e2000',
name='John Snow',
status='Approved'
)
```
[[Back to top]](#)

6
docs/tools/sdk/python/Reference/V2024/Models/AttributeChange.md
View File

@@ -27,9 +27,9 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.attribute_change import AttributeChange
attribute_change = AttributeChange(
name='',
previous_value='',
new_value=''
name='firstname',
previous_value='adam',
new_value='zampa'
)
```

17
docs/tools/sdk/python/Reference/V2024/Models/AttributesChanged.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AttributesChanged', 'V2024AttributesC
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**attribute_changes** | [**[]AttributeChange**](attribute-change) | | [required]
**event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
}
## Example
@@ -28,12 +28,15 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.attributes_changed import AttributesChanged
attributes_changed = AttributesChanged(
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
attribute_changes=[
sailpoint.v2024.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
event_type='',
identity_id='',
dt=''
event_type='AttributesChanged',
identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
date_time='2019-03-08T22:37:33.901Z'
)
```

4
docs/tools/sdk/python/Reference/V2024/Models/CorrelatedGovernanceEvent.md
View File

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'V2024Cor
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the governance event, such as the certification name or access request ID. | [optional]
**dt** | **str** | The date that the certification or access request was completed. | [optional]
**date_time** | **str** | The date that the certification or access request was completed. | [optional]
**type** | **Enum** [ 'certification', 'accessRequest' ] | The type of governance event. | [optional]
**governance_id** | **str** | The ID of the instance that caused the event - either the certification ID or access request ID. | [optional]
**owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -32,7 +32,7 @@ from sailpoint.v2024.models.correlated_governance_event import CorrelatedGoverna
correlated_governance_event = CorrelatedGovernanceEvent(
name='Manager Certification for Jon Snow',
dt='2019-03-08T22:37:33.901Z',
date_time='2019-03-08T22:37:33.901Z',
type='certification',
governance_id='2c91808a77ff216301782327a50f09bf',
owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

84
docs/tools/sdk/python/Reference/V2024/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,21 +16,21 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional]
**identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [optional]
**changes** | [**[]AttributeChange**](attribute-change) | | [optional]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional]
**certification_id** | **str** | the id of the certification item | [optional]
**certification_name** | **str** | the certification item name | [optional]
**certification_id** | **str** | the id of the certification item | [required]
**certification_name** | **str** | the certification item name | [required]
**signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional]
**event_type** | **str** | the event type | [optional]
**date_time** | **str** | the date of event | [optional]
**identity_id** | **str** | the identity id | [optional]
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [required]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-event) | | [required]
**access_item_type** | **Enum** [ 'account', 'app', 'entitlement', 'role', 'accessProfile' ] | the access item type | [optional]
**attribute_changes** | [**[]AttributeChange**](attribute-change) | | [required]
**account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**status_change** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
}
## Example
@@ -39,27 +39,6 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
get_historical_identity_events200_response_inner = GetHistoricalIdentityEvents200ResponseInner(
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='',
event_type='',
dt='',
governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
],
access_request=sailpoint.v2024.models.access_request_response_1.AccessRequestResponse_1(
requester_id = '2c91808a77ff216301782327a50f09bf',
requester_name = 'Bing C',
items = [{operation=Add, accessItemType=role, name=Role-1, decision=APPROVED, description=The role descrition, sourceId=8a80828f643d484f01643e14202e206f, sourceName=Source1, approvalInfos=[{name=John Snow, id=8a80828f643d484f01643e14202e2000, status=Approved}]}], ),
certification_id='2c91808a77ff216301782327a50f09bf',
certification_name='Cert name',
signed_date='2019-03-08T22:37:33.901Z',
@@ -68,17 +47,38 @@ reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
signer=sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ),
account=sailpoint.v2024.models.account_status_changed_account.AccountStatusChanged_account(
id = '',
native_identity = '',
display_name = '',
source_id = '',
source_name = '',
entitlement_count = 56,
access_type = '', ),
status_change=sailpoint.v2024.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
event_type='AccountStatusChanged',
date_time='2019-03-08T22:37:33.901Z',
identity_id='8a80828f643d484f01643e14202e206f',
access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow',
date_time = '2019-03-08T22:37:33.901Z',
type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
access_item_type='account',
attribute_changes=[
sailpoint.v2024.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
account=sailpoint.v2024.models.access_requested_account.AccessRequested_account(
id = '2c91808a77ff216301782327a50f09bf',
native_identity = 'dr.arden.ogahn.d',
display_name = 'Adam Archer',
source_id = '8a80828f643d484f01643e14202e206f',
source_name = 'JDBC Entitlements Source',
entitlement_count = 2,
access_type = 'account', ),
status_change=sailpoint.v2024.models.access_requested_status_change.AccessRequested_statusChange(
previous_status = 'enabled',
new_status = 'enabled', )
new_status = 'disabled', )
)
```

8
docs/tools/sdk/python/Reference/V2024/Models/IdentityCertified.md
View File

@@ -16,14 +16,14 @@ tags: ['SDK', 'Software Development Kit', 'IdentityCertified', 'V2024IdentityCer
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**certification_id** | **str** | the id of the certification item | [optional]
**certification_name** | **str** | the certification item name | [optional]
**certification_id** | **str** | the id of the certification item | [required]
**certification_name** | **str** | the certification item name | [required]
**signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [optional]
**reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional]
**event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional]
**date_time** | **str** | the date of event | [optional]
}
## Example
@@ -41,7 +41,7 @@ signer=sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ),
event_type='IdentityCertified',
dt='2019-03-08T22:37:33.901Z'
date_time='2019-03-08T22:37:33.901Z'
)
```

56
docs/tools/sdk/python/Reference/V2024/Models/ListIdentityAccessItems200ResponseInner.md
View File

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional]
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**source_id** | **str** | the id of the source | [optional]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional]
**app_display_name** | **str** | the name of | [optional]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional]
**app_role_id** | **str** | the app role id | [optional]
**attribute** | **str** | the entitlement attribute | [optional]
**value** | **str** | the associated value | [optional]
**entitlement_type** | **str** | the type of entitlement | [optional]
**source_id** | **str** | the id of the source | [optional]
**standalone** | **bool** | indicates whether the access profile is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**app_role_id** | **str** | the app role id | [required]
}
## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner(
access_type='role',
id='2c918087763e69d901763e72e97f006f',
name='sample',
source_name='Source Name',
source_id='2793o32dwd',
description='Role - Workday/Citizenship access',
display_name='sample',
entitlement_count='12',
app_display_name='AppName',
remove_date='2024-07-01T06:00:00.00Z',
standalone=True,
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f',
access_type='app',
display_name='Display Name',
source_name='appName',
attribute='groups',
value='Upward mobility access',
entitlement_type='entitlement',
type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=False,
cloud_governed=True
cloud_governed=True,
entitlement_count=12,
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f'
)
```

67
docs/tools/sdk/python/Reference/V2024/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: v2024-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2024ListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/python/v2024/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2024ListIdentitySnapshotAccessItems200ResponseInner']
---
# ListIdentitySnapshotAccessItems200ResponseInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | the access item id | [optional]
**access_type** | **str** | the access item type. role in this case | [optional]
**display_name** | **str** | the role display name | [optional]
**source_name** | **str** | the associated source name if it exists | [optional]
**entitlement_count** | **int** | the number of entitlements the account will create | [required]
**description** | **str** | the description for the role | [optional]
**source_id** | **str** | the id of the source | [optional]
**app_refs** | [**[]AccessItemAccessProfileResponseAppRefsInner**](access-item-access-profile-response-app-refs-inner) | the list of app ids associated with the access profile | [required]
**remove_date** | **str** | the date the role is no longer assigned to the specified identity | [optional]
**standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**revocable** | **bool** | indicates whether the role is revocable | [required]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [required]
**app_role_id** | **str** | the app role id | [required]
**attribute** | **str** | the entitlement attribute | [required]
**value** | **str** | the associated value | [required]
**type** | **str** | the type of entitlement | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [required]
}
## Example
```python
from sailpoint.v2024.models.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
list_identity_snapshot_access_items200_response_inner = ListIdentitySnapshotAccessItems200ResponseInner(
id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample',
source_name='Source Name',
entitlement_count=12,
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
app_refs=[{cloudAppId=8c190e6787aa4ed9a90bd9d5344523fb, cloudAppName=Sample App}, {cloudAppId=2c91808a77ff216301782327a50f09bf, cloudAppName=Another App}],
remove_date='2024-07-01T06:00:00.00Z',
standalone=True,
revocable=True,
native_identity='dr.arden.ogahn.d',
app_role_id='2c918087763e69d901763e72e97f006f',
attribute='groups',
value='Upward mobility access',
type='ENTITLEMENT',
privileged=False,
cloud_governed=True
)
```
[[Back to top]](#)

24
docs/tools/sdk/python/Reference/V2024/Models/MachineClassificationConfig.md
View File

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'MachineClassificationConfig', 'V2024M
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if the Classification is enabled for a Source | [optional] [default to False]
**classification_method** | **Enum** [ 'SOURCE' ] | Classification Method | [optional]
**criteria** | **str** | A classification criteria object | [optional]
**created** | **datetime** | Time when the config was created | [optional]
**modified** | **datetime** | Time when the config was last updated | [optional]
**enabled** | **bool** | Indicates whether Classification is enabled for a Source | [optional] [default to False]
**classification_method** | **Enum** [ 'SOURCE', 'CRITERIA' ] | Classification Method | [optional]
**criteria** | [**MachineClassificationCriteriaLevel1**](machine-classification-criteria-level1) | | [optional]
**created** | **datetime** | Date the config was created | [optional]
**modified** | **datetime** | Date the config was last updated | [optional]
}
## Example
@@ -31,7 +31,19 @@ from sailpoint.v2024.models.machine_classification_config import MachineClassifi
machine_classification_config = MachineClassificationConfig(
enabled=True,
classification_method='SOURCE',
criteria='',
criteria=sailpoint.v2024.models.machine_classification_criteria_level1.MachineClassificationCriteriaLevel1(
operation = 'EQUALS',
case_sensitive = False,
data_type = '',
attribute = 'distinguishedName',
value = 'OU=Service Accounts',
children = [
sailpoint.v2024.models.machine_classification_criteria_level2.MachineClassificationCriteriaLevel2(
case_sensitive = False,
data_type = '',
attribute = 'employeeType',
value = 'SERVICE', )
], ),
created='2017-07-11T18:45:37.098Z',
modified='2018-06-25T20:22:28.104Z'
)

50
docs/tools/sdk/python/Reference/V2024/Models/MachineClassificationCriteriaLevel1.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: v2024-machine-classification-criteria-level1
title: MachineClassificationCriteriaLevel1
pagination_label: MachineClassificationCriteriaLevel1
sidebar_label: MachineClassificationCriteriaLevel1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel1', 'V2024MachineClassificationCriteriaLevel1']
slug: /tools/sdk/python/v2024/models/machine-classification-criteria-level1
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel1', 'V2024MachineClassificationCriteriaLevel1']
---
# MachineClassificationCriteriaLevel1
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) | | [optional]
**case_sensitive** | **bool** | Indicates whether case matters when evaluating the criteria | [optional] [default to False]
**data_type** | **str** | The data type of the attribute being evaluated | [optional]
**attribute** | **str** | The attribute to evaluate in the classification criteria | [optional]
**value** | **str** | The value to compare against the attribute in the classification criteria | [optional]
**children** | [**[]MachineClassificationCriteriaLevel2**](machine-classification-criteria-level2) | An array of child classification criteria objects | [optional]
}
## Example
```python
from sailpoint.v2024.models.machine_classification_criteria_level1 import MachineClassificationCriteriaLevel1
machine_classification_criteria_level1 = MachineClassificationCriteriaLevel1(
operation='EQUALS',
case_sensitive=False,
data_type='',
attribute='distinguishedName',
value='OU=Service Accounts',
children=[
sailpoint.v2024.models.machine_classification_criteria_level2.MachineClassificationCriteriaLevel2(
operation = 'EQUALS',
case_sensitive = False,
data_type = '',
attribute = 'employeeType',
value = 'SERVICE', )
]
)
```
[[Back to top]](#)

50
docs/tools/sdk/python/Reference/V2024/Models/MachineClassificationCriteriaLevel2.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: v2024-machine-classification-criteria-level2
title: MachineClassificationCriteriaLevel2
pagination_label: MachineClassificationCriteriaLevel2
sidebar_label: MachineClassificationCriteriaLevel2
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel2', 'V2024MachineClassificationCriteriaLevel2']
slug: /tools/sdk/python/v2024/models/machine-classification-criteria-level2
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel2', 'V2024MachineClassificationCriteriaLevel2']
---
# MachineClassificationCriteriaLevel2
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) | | [optional]
**case_sensitive** | **bool** | Indicates whether case matters when evaluating the criteria | [optional] [default to False]
**data_type** | **str** | The data type of the attribute being evaluated | [optional]
**attribute** | **str** | The attribute to evaluate in the classification criteria | [optional]
**value** | **str** | The value to compare against the attribute in the classification criteria | [optional]
**children** | [**[]MachineClassificationCriteriaLevel3**](machine-classification-criteria-level3) | An array of child classification criteria objects | [optional]
}
## Example
```python
from sailpoint.v2024.models.machine_classification_criteria_level2 import MachineClassificationCriteriaLevel2
machine_classification_criteria_level2 = MachineClassificationCriteriaLevel2(
operation='EQUALS',
case_sensitive=False,
data_type='',
attribute='employeeType',
value='SERVICE',
children=[
sailpoint.v2024.models.machine_classification_criteria_level3.MachineClassificationCriteriaLevel3(
operation = 'EQUALS',
case_sensitive = False,
data_type = 'This is the first level of classification criteria',
attribute = 'sAMAccountName',
value = 'SVC', )
]
)
```
[[Back to top]](#)

45
docs/tools/sdk/python/Reference/V2024/Models/MachineClassificationCriteriaLevel3.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2024-machine-classification-criteria-level3
title: MachineClassificationCriteriaLevel3
pagination_label: MachineClassificationCriteriaLevel3
sidebar_label: MachineClassificationCriteriaLevel3
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel3', 'V2024MachineClassificationCriteriaLevel3']
slug: /tools/sdk/python/v2024/models/machine-classification-criteria-level3
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel3', 'V2024MachineClassificationCriteriaLevel3']
---
# MachineClassificationCriteriaLevel3
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**operation** | [**MachineClassificationCriteriaOperation**](machine-classification-criteria-operation) | | [optional]
**case_sensitive** | **bool** | Indicates whether or not case matters when evaluating the criteria | [optional] [default to False]
**data_type** | **str** | The data type of the attribute being evaluated | [optional]
**attribute** | **str** | The attribute to evaluate in the classification criteria | [optional]
**value** | **str** | The value to compare against the attribute in the classification criteria | [optional]
**children** | **[]str** | An array of child classification criteria objects | [optional]
}
## Example
```python
from sailpoint.v2024.models.machine_classification_criteria_level3 import MachineClassificationCriteriaLevel3
machine_classification_criteria_level3 = MachineClassificationCriteriaLevel3(
operation='EQUALS',
case_sensitive=False,
data_type='This is the first level of classification criteria',
attribute='sAMAccountName',
value='SVC',
children=[
''
]
)
```
[[Back to top]](#)

33
docs/tools/sdk/python/Reference/V2024/Models/MachineClassificationCriteriaOperation.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2024-machine-classification-criteria-operation
title: MachineClassificationCriteriaOperation
pagination_label: MachineClassificationCriteriaOperation
sidebar_label: MachineClassificationCriteriaOperation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaOperation', 'V2024MachineClassificationCriteriaOperation']
slug: /tools/sdk/python/v2024/models/machine-classification-criteria-operation
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaOperation', 'V2024MachineClassificationCriteriaOperation']
---
# MachineClassificationCriteriaOperation
An operation to perform on the classification criteria
## Enum
* `EQUALS` (value: `'EQUALS'`)
* `NOT_EQUALS` (value: `'NOT_EQUALS'`)
* `STARTS_WITH` (value: `'STARTS_WITH'`)
* `ENDS_WITH` (value: `'ENDS_WITH'`)
* `CONTAINS` (value: `'CONTAINS'`)
* `AND` (value: `'AND'`)
* `OR` (value: `'OR'`)
[[Back to top]](#)

2
docs/tools/sdk/python/Reference/V2024/Models/RoleCriteriaKey.md
View File

@@ -11,7 +11,7 @@ tags: ['SDK', 'Software Development Kit', 'RoleCriteriaKey', 'V2024RoleCriteriaK
# RoleCriteriaKey
Refers to a specific Identity attribute, Account attibute, or Entitlement used in Role membership criteria
Refers to a specific Identity attribute, Account attribute, or Entitlement used in Role membership criteria
## Properties

2
docs/tools/sdk/python/Reference/V2024/Models/SourceApp.md
View File

@@ -50,7 +50,7 @@ account_source=sailpoint.v2024.models.source_app_account_source.SourceApp_accoun
id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'SOURCE',
name = 'ODS-AD-Source',
use_for_password_management = False,
use_for_password_management = True,
password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ),
owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',

2
docs/tools/sdk/python/Reference/V2024/Models/SourceAppAccountSource.md
View File

@@ -32,7 +32,7 @@ source_app_account_source = SourceAppAccountSource(
id='2c9180827ca885d7017ca8ce28a000eb',
type='SOURCE',
name='ODS-AD-Source',
use_for_password_management=False,
use_for_password_management=True,
password_policies=[{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}]
)

2
docs/tools/sdk/python/Reference/V2024/Models/SourceAppPatchDto.md
View File

@@ -52,7 +52,7 @@ account_source=sailpoint.v2024.models.source_app_account_source.SourceApp_accoun
id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'SOURCE',
name = 'ODS-AD-Source',
use_for_password_management = False,
use_for_password_management = True,
password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ),
owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY',

2
docs/tools/sdk/python/Reference/V2024/Models/WorkItemTypeManualWorkItems.md
View File

@@ -29,7 +29,7 @@ The type of the work item
* `FORM` (value: `'Form'`)
* `POLICYVIOLOATION` (value: `'PolicyVioloation'`)
* `POLICYVIOLATION` (value: `'PolicyViolation'`)
* `CHALLENGE` (value: `'Challenge'`)