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

Update python SDK docs: 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

22
docs/tools/sdk/python/Reference/Beta/Methods/AccessModelMetadataApi.md
View File

@@ -159,7 +159,11 @@ Get a list of Access Model Metadata Attributes
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
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 ### Return type
[**List[AttributeDTO]**](../models/attribute-dto) [**List[AttributeDTO]**](../models/attribute-dto)
@@ -189,14 +193,18 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
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: try:
# List access model metadata attributes # List access model metadata attributes
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute() results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -219,6 +227,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. Path | key | **str** | True | Technical name of the Attribute.
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 ### Return type
[**List[AttributeValueDTO]**](../models/attribute-value-dto) [**List[AttributeValueDTO]**](../models/attribute-value-dto)
@@ -249,13 +260,16 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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: try:
# List access model metadata values # List access model metadata values
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key) results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))

12
docs/tools/sdk/python/Reference/Beta/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**](#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/{accessType}` | Gets a list of differences of specific accesstype for the given identity between 2 snapshots [**compare-identity-snapshots-access-type**](#compare-identity-snapshots-access-type) | **GET** `/historical-identities/{id}/compare/{accessType}` | 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**](#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**](#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-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 [**get-identity-start-date**](#get-identity-start-date) | **GET** `/historical-identities/{id}/start-date` | Gets the start date of the identity
@@ -231,7 +231,7 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-historical-identity-events ## get-historical-identity-events
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' 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/beta/get-historical-identity-events) [API Spec](https://developer.sailpoint.com/docs/api/beta/get-historical-identity-events)
@@ -286,7 +286,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) 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: try:
# Lists all events for the given identity # List identity event history
results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id) results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id)
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
@@ -646,12 +646,12 @@ Path | var_date | **str** | True | Specified date.
Query | type | **str** | (optional) | Access item type. Query | type | **str** | (optional) | Access item type.
### Return type ### Return type
[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) [**List[ListIdentitySnapshotAccessItems200ResponseInner]**](../models/list-identity-snapshot-access-items200-response-inner)
### Responses ### Responses
Code | Description | Data Type | Response headers | Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------| ------------- | ------------- | ------------- |------------------|
200 | Identity object. | List[ListIdentityAccessItems200ResponseInner] | - | 200 | Identity object. | List[ListIdentitySnapshotAccessItems200ResponseInner] | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - | 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. | ListAccessModelMetadataAttribute401Response | - | 401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessModelMetadataAttribute401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - | 403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
@@ -668,7 +668,7 @@ Code | Description | Data Type | Response headers |
```python ```python
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.beta.models.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

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

@@ -16,18 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'Be
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**id** | **str** | the access item id | [optional] **id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional] **access_type** | **str** | the access item type. accessProfile in this case | [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]
**display_name** | **str** | the display name of the identity | [optional] **display_name** | **str** | the display name of the identity | [optional]
**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional] **source_name** | **str** | the name of the source | [optional]
**app_display_name** | **str** | the name of | [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] **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] **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 ## Example
@@ -36,15 +35,14 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_access_profile_response import AccessItemAccessProfileResponse from sailpoint.beta.models.access_item_access_profile_response import AccessItemAccessProfileResponse
access_item_access_profile_response = AccessItemAccessProfileResponse( access_item_access_profile_response = AccessItemAccessProfileResponse(
access_type='accessProfile',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='accessProfile',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='AccessProfile - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD', display_name='Dr. Arden Rogahn MD',
entitlement_count='12', source_name='DataScienceDataset',
app_display_name='AppName', 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', remove_date='2024-07-01T06:00:00.00Z',
standalone=False, standalone=False,
revocable=True revocable=True

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

@@ -0,0 +1,35 @@
---
id: beta-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', 'BetaAccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/python/beta/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'BetaAccessItemAccessProfileResponseAppRefsInner']
---
# 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.beta.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/Beta/Models/AccessItemAccountResponse.md
View File

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

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

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

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

@@ -16,11 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'BetaAccessIte
Name | Type | Description | Notes 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] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-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 ## Example
@@ -29,20 +30,21 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_associated import AccessItemAssociated from sailpoint.beta.models.access_item_associated import AccessItemAssociated
access_item_associated = 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', 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.beta.models.correlated_governance_event.CorrelatedGovernanceEvent( governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.beta.models.certifier_response.CertifierResponse( decision_maker = sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ) display_name = 'John Snow', ), ),
access_item_type='account'
) )
``` ```

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

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'Bet
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_associated_access_item import AccessItemAssociatedAccessItem from sailpoint.beta.models.access_item_associated_access_item import AccessItemAssociatedAccessItem
access_item_associated_access_item = AccessItemAssociatedAccessItem( access_item_associated_access_item = AccessItemAssociatedAccessItem(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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/Beta/Models/AccessItemEntitlementResponse.md
View File

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

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

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'BetaAccessItemRe
Name | Type | Description | Notes 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] **identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [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] **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}, access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb', identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemRemoved', 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.beta.models.correlated_governance_event.CorrelatedGovernanceEvent( governance_event=sailpoint.beta.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

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

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'BetaAccessI
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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] **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] **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] **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] **revocable** | **bool** | indicates whether the role is revocable | [required]
} }
@@ -31,11 +31,11 @@ Name | Type | Description | Notes
from sailpoint.beta.models.access_item_role_response import AccessItemRoleResponse from sailpoint.beta.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse( access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample', display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name', source_name='Source Name',
description='Role - Workday/Citizenship access',
remove_date='2024-07-01T06:00:00.00Z', remove_date='2024-07-01T06:00:00.00Z',
revocable=True revocable=True
) )

6
docs/tools/sdk/python/Reference/Beta/Models/AccessRequested.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'BetaAccessRequeste
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional] **access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**identity_id** | **str** | the identity id | [optional] **identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
} }
## Example ## Example
@@ -34,7 +34,7 @@ access_request=sailpoint.beta.models.access_request_response_1.AccessRequestResp
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}]}], ), 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}]}], ),
identity_id='8a80828f643d484f01643e14202e206f', identity_id='8a80828f643d484f01643e14202e206f',
event_type='AccessRequested', event_type='AccessRequested',
dt='2019-03-08T22:37:33.901Z' date_time='2019-03-08T22:37:33.901Z'
) )
``` ```

28
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChanged.md
View File

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

14
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedAccount.md
View File

@@ -31,13 +31,13 @@ Name | Type | Description | Notes
from sailpoint.beta.models.account_status_changed_account import AccountStatusChangedAccount from sailpoint.beta.models.account_status_changed_account import AccountStatusChangedAccount
account_status_changed_account = AccountStatusChangedAccount( account_status_changed_account = AccountStatusChangedAccount(
id='', id='2c91808a77ff216301782327a50f09bf',
native_identity='', native_identity='dr.arden.ogahn.d',
display_name='', display_name='Adam Archer',
source_id='', source_id='8a80828f643d484f01643e14202e206f',
source_name='', source_name='JDBC Entitlements Source',
entitlement_count=56, entitlement_count=2,
access_type='' access_type='account'
) )
``` ```

2
docs/tools/sdk/python/Reference/Beta/Models/AccountStatusChangedStatusChange.md
View File

@@ -27,7 +27,7 @@ from sailpoint.beta.models.account_status_changed_status_change import AccountSt
account_status_changed_status_change = AccountStatusChangedStatusChange( account_status_changed_status_change = AccountStatusChangedStatusChange(
previous_status='enabled', previous_status='enabled',
new_status='enabled' new_status='disabled'
) )
``` ```

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

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

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

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

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

@@ -17,7 +17,7 @@ tags: ['SDK', 'Software Development Kit', 'CorrelatedGovernanceEvent', 'BetaCorr
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the governance event, such as the certification name or access request ID. | [optional] **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] **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] **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] **owners** | [**[]CertifierResponse**](certifier-response) | The owners of the governance event (the certifiers or approvers) | [optional]
@@ -32,7 +32,7 @@ from sailpoint.beta.models.correlated_governance_event import CorrelatedGovernan
correlated_governance_event = CorrelatedGovernanceEvent( correlated_governance_event = CorrelatedGovernanceEvent(
name='Manager Certification for Jon Snow', name='Manager Certification for Jon Snow',
dt='2019-03-08T22:37:33.901Z', date_time='2019-03-08T22:37:33.901Z',
type='certification', type='certification',
governance_id='2c91808a77ff216301782327a50f09bf', governance_id='2c91808a77ff216301782327a50f09bf',
owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

85
docs/tools/sdk/python/Reference/Beta/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,21 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] **certification_id** | **str** | the id of the certification item | [required]
**identity_id** | **str** | the identity id | [optional] **certification_name** | **str** | the certification item name | [required]
**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]
**signed_date** | **str** | the date ceritification was signed | [optional] **signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [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] **reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional] **signer** | [**CertifierResponse**](certifier-response) | | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] **event_type** | **str** | the event type | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [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]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
} }
## Example ## Example
@@ -39,27 +40,6 @@ Name | Type | Description | Notes
from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner from sailpoint.beta.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
get_historical_identity_events200_response_inner = 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.beta.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.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
],
access_request=sailpoint.beta.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_id='2c91808a77ff216301782327a50f09bf',
certification_name='Cert name', certification_name='Cert name',
signed_date='2019-03-08T22:37:33.901Z', signed_date='2019-03-08T22:37:33.901Z',
@@ -68,17 +48,42 @@ reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
signer=sailpoint.beta.models.certifier_response.CertifierResponse( signer=sailpoint.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), display_name = 'John Snow', ),
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.beta.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.beta.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
access_item_type='account',
attribute_changes=[
sailpoint.beta.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
access_request=sailpoint.beta.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}]}], ),
account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account( account=sailpoint.beta.models.account_status_changed_account.AccountStatusChanged_account(
id = '', id = '2c91808a77ff216301782327a50f09bf',
native_identity = '', native_identity = 'dr.arden.ogahn.d',
display_name = '', display_name = 'Adam Archer',
source_id = '', source_id = '8a80828f643d484f01643e14202e206f',
source_name = '', source_name = 'JDBC Entitlements Source',
entitlement_count = 56, entitlement_count = 2,
access_type = '', ), access_type = 'account', ),
status_change=sailpoint.beta.models.account_status_changed_status_change.AccountStatusChanged_statusChange( status_change=sailpoint.beta.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
previous_status = 'enabled', previous_status = 'enabled',
new_status = 'enabled', ) new_status = 'disabled', )
) )
``` ```

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

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

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

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner( list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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/Beta/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: beta-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/python/beta/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'BetaListIdentitySnapshotAccessItems200ResponseInner']
---
# 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.beta.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]](#)

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 ## 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 access model metadata attribute
Get single 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. 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 ### Return type
[**AttributeDTO**](../models/attribute-dto) [**AttributeDTO**](../models/attribute-dto)
@@ -81,18 +69,16 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# Get access model metadata attribute # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -104,17 +90,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-access-model-metadata-attribute-value ## 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 access model metadata value
Get single Access Model Metadata Attribute 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 | key | **str** | True | Technical name of the Attribute.
Path | value | **str** | True | Technical name of the Attribute value. 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 ### Return type
[**AttributeValueDTO**](../models/attribute-value-dto) [**AttributeValueDTO**](../models/attribute-value-dto)
@@ -154,19 +128,17 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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. 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: try:
# Get access model metadata value # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -178,17 +150,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute ## 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 List access model metadata attributes
Get a list of 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 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: **key**: *eq* **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: **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 ### Return type
[**List[AttributeDTO]**](../models/attribute-dto) [**List[AttributeDTO]**](../models/attribute-dto)
@@ -227,18 +191,20 @@ from sailpoint.v2024.models.attribute_dto import AttributeDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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: **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)
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) 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: try:
# List access model metadata attributes # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -251,17 +217,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute-value ## 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 List access model metadata values
Get a list of Access Model Metadata Attribute 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. 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 ### Return type
[**List[AttributeValueDTO]**](../models/attribute-value-dto) [**List[AttributeValueDTO]**](../models/attribute-value-dto)
@@ -300,18 +257,19 @@ from sailpoint.v2024.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# List access model metadata values # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) 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 ## 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 metadata to an entitlement.
Add single Access Model 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 | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute. Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value. 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 ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -130,20 +118,18 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Add metadata to an entitlement. # 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 # 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("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -155,17 +141,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## delete-access-model-metadata-from-entitlement ## 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 metadata from an entitlement.
Remove single Access Model 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 | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute. Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value. 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 ### Return type
(empty response body) (empty response body)
@@ -205,20 +179,18 @@ from sailpoint.v2024.api_client import ApiClient
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Remove metadata from an entitlement. # 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % 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]](#) [[Back to top]](#)
## get-entitlement ## 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 Get an entitlement
This API returns an entitlement by its ID. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The entitlement ID 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 ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -278,18 +238,16 @@ from sailpoint.v2024.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID 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: try:
# Get an entitlement # 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 # 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("The response of EntitlementsApi->get_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -301,17 +259,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-entitlement-request-config ## 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 Get entitlement request config
This API returns the entitlement request config for a specified entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 ### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config) [**EntitlementRequestConfig**](../models/entitlement-request-config)
@@ -351,18 +297,16 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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: try:
# Get entitlement request config # 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 # 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("The response of EntitlementsApi->get_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -377,17 +321,6 @@ with ApiClient(configuration) as api_client:
:::caution deprecated :::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API. 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 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). 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source Id 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. | csv_file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -431,19 +363,17 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Aggregate entitlements # 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 # 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("The response of EntitlementsApi->import_entitlements_by_source:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -455,17 +385,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-children ## 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 List of entitlements children
This API returns a list of all child entitlements of a given entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 | 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 | 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. 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 from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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: try:
# List of entitlements children # 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 # 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") print("The response of EntitlementsApi->list_entitlement_children:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -539,17 +455,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-parents ## 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 List of entitlements parents
This API returns a list of all parent entitlements of a given entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 | 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 | 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. 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 from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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: try:
# List of entitlements parents # 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 # 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") print("The response of EntitlementsApi->list_entitlement_parents:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -623,17 +525,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlements ## 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. Gets a list of entitlements.
This API returns 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 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 | 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 | 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). 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 from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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) 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) 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) 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: try:
# Gets a list of entitlements. # 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 # 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") print("The response of EntitlementsApi->list_entitlements:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -716,17 +604,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## patch-entitlement ## 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 Patch an entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of the entitlement to patch 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) | Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type ### Return type
@@ -772,19 +648,17 @@ from sailpoint.v2024.models.json_patch_operation import JsonPatchOperation
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch 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) json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try: try:
# Patch an entitlement # 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 # 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("The response of EntitlementsApi->patch_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -796,17 +670,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## put-entitlement-request-config ## 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 Replace entitlement request config
This API replaces the entitlement request config for a specified entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement ID 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 | Body | entitlement_request_config | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type ### Return type
@@ -847,11 +709,9 @@ from sailpoint.v2024.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID 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 = '''{ entitlement_request_config = '''{
"accessRequestConfig" : { "accessRequestConfig" : {
"denialCommentRequired" : false, "denialCommentRequired" : false,
@@ -879,9 +739,9 @@ with ApiClient(configuration) as api_client:
try: try:
# Replace entitlement request config # Replace entitlement request config
new_entitlement_request_config = EntitlementRequestConfig.from_json(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 # 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("The response of EntitlementsApi->put_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -893,17 +753,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## reset-source-entitlements ## 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 Reset source entitlements
Remove all entitlements from a specific source. 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`. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of source for the entitlement reset 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 ### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) [**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 from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset 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: try:
# Reset source entitlements # 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 # 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("The response of EntitlementsApi->reset_source_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -966,17 +812,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## update-entitlements-in-bulk ## 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 Bulk update an entitlement list
This API applies an update to every entitlement of the 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 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 | Body | entitlement_bulk_update_request | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type ### Return type
@@ -1028,10 +862,8 @@ from sailpoint.v2024.models.entitlement_bulk_update_request import EntitlementBu
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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 = '''{ entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ { "jsonPatch" : [ {
@@ -1052,9 +884,9 @@ with ApiClient(configuration) as api_client:
try: try:
# Bulk update an entitlement list # Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % 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**](#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 [**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**](#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**](#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-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 [**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 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' 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) [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) 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: 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) 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 # 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 Query | type | **str** | (optional) | The access item type
### Return type ### Return type
[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) [**List[ListIdentitySnapshotAccessItems200ResponseInner]**](../models/list-identity-snapshot-access-items200-response-inner)
### Responses ### Responses
Code | Description | Data Type | Response headers | 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 | - | 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 | - | 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 | - | 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 ```python
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient 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 from sailpoint.configuration import Configuration
configuration = 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: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID. id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{ 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", "created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z", "modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE", "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]](#) [[Back to top]](#)
## import-entitlements ## 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 Entitlement aggregation
Starts an entitlement aggregation on the specified source. 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. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | Source Id 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. | file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -2028,19 +2016,17 @@ from sailpoint.v2024.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Entitlement aggregation # 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 # 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("The response of SourcesApi->import_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**id** | **str** | the access item id | [optional] **id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional] **access_type** | **str** | the access item type. accessProfile in this case | [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]
**display_name** | **str** | the display name of the identity | [optional] **display_name** | **str** | the display name of the identity | [optional]
**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional] **source_name** | **str** | the name of the source | [optional]
**app_display_name** | **str** | the name of | [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] **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] **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 ## Example
@@ -36,15 +35,14 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_access_profile_response import AccessItemAccessProfileResponse from sailpoint.v2024.models.access_item_access_profile_response import AccessItemAccessProfileResponse
access_item_access_profile_response = AccessItemAccessProfileResponse( access_item_access_profile_response = AccessItemAccessProfileResponse(
access_type='accessProfile',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='accessProfile',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='AccessProfile - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD', display_name='Dr. Arden Rogahn MD',
entitlement_count='12', source_name='DataScienceDataset',
app_display_name='AppName', 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', remove_date='2024-07-01T06:00:00.00Z',
standalone=False, standalone=False,
revocable=True 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. account in this case | [optional]
**id** | **str** | the access item id | [optional] **id** | **str** | the access item id | [optional]
**native_identity** | **str** | the native identifier used to uniquely identify an acccount | [optional] **access_type** | **str** | the access item type. account in this case | [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]
**display_name** | **str** | the display name of the identity | [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 ## Example
@@ -31,13 +31,13 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_account_response import AccessItemAccountResponse from sailpoint.v2024.models.access_item_account_response import AccessItemAccountResponse
access_item_account_response = AccessItemAccountResponse( access_item_account_response = AccessItemAccountResponse(
access_type='account',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
native_identity='dr.arden.ogahn.d', access_type='account',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset', source_name='DataScienceDataset',
native_identity='dr.arden.ogahn.d',
source_id='2793o32dwd', source_id='2793o32dwd',
entitlement_count='12', entitlement_count=12
display_name='Dr. Arden Rogahn MD'
) )
``` ```

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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [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] **display_name** | **str** | the access item display name | [optional]
**source_name** | **str** | the associated source name if it exists | [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 ## Example
@@ -29,8 +29,8 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_app_response import AccessItemAppResponse from sailpoint.v2024.models.access_item_app_response import AccessItemAppResponse
access_item_app_response = AccessItemAppResponse( access_item_app_response = AccessItemAppResponse(
access_type='app',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
access_type='app',
display_name='Display Name', display_name='Display Name',
source_name='appName', source_name='appName',
app_role_id='2c918087763e69d901763e72e97f006f' 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 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] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-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 ## Example
@@ -29,20 +30,21 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_associated import AccessItemAssociated from sailpoint.v2024.models.access_item_associated import AccessItemAssociated
access_item_associated = 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', 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( governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse( decision_maker = sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_item_associated_access_item import AccessItemAssociatedAccessItem from sailpoint.v2024.models.access_item_associated_access_item import AccessItemAssociatedAccessItem
access_item_associated_access_item = AccessItemAssociatedAccessItem( access_item_associated_access_item = AccessItemAssociatedAccessItem(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. entitlement in this case | [optional]
**id** | **str** | the access item id | [optional] **id** | **str** | the access item id | [optional]
**attribute** | **str** | the entitlement attribute | [optional] **access_type** | **str** | the access item type. entitlement in this case | [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]
**display_name** | **str** | the display name of the identity | [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] **standalone** | **bool** | indicates whether the entitlement is standalone | [required]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 from sailpoint.v2024.models.access_item_entitlement_response import AccessItemEntitlementResponse
access_item_entitlement_response = AccessItemEntitlementResponse( access_item_entitlement_response = AccessItemEntitlementResponse(
access_type='entitlement',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
access_type='entitlement',
display_name='Dr. Arden Rogahn MD',
source_name='DataScienceDataset',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='Entitlement - Workday/Citizenship access', description='Entitlement - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD', source_id='2793o32dwd',
standalone=True, standalone=True,
privileged=False, privileged=False,
cloud_governed=True 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 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] **identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [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] **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}, access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb', identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemRemoved', 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( governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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] **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] **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] **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] **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 from sailpoint.v2024.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse( access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample', display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name', source_name='Source Name',
description='Role - Workday/Citizenship access',
remove_date='2024-07-01T06:00:00.00Z', remove_date='2024-07-01T06:00:00.00Z',
revocable=True 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 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] **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 ## Example
@@ -28,13 +29,20 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.access_requested import AccessRequested from sailpoint.v2024.models.access_requested import AccessRequested
access_requested = AccessRequested( access_requested = AccessRequested(
access_request=sailpoint.v2024.models.access_request_response_1.AccessRequestResponse_1( event_type='AccountStatusChanged',
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}]}], ),
identity_id='8a80828f643d484f01643e14202e206f', identity_id='8a80828f643d484f01643e14202e206f',
event_type='AccessRequested', date_time='2019-03-08T22:37:33.901Z',
dt='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] **event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional] **identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] **account** | [**AccessRequestedAccount**](access-requested-account) | | [required]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [optional] **status_change** | [**AccessRequestedStatusChange**](access-requested-status-change) | | [required]
} }
## Example ## Example
@@ -29,20 +29,20 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.account_status_changed import AccountStatusChanged from sailpoint.v2024.models.account_status_changed import AccountStatusChanged
account_status_changed = AccountStatusChanged( account_status_changed = AccountStatusChanged(
event_type='', event_type='AccountStatusChanged',
identity_id='', identity_id='8a80828f643d484f01643e14202e206f',
dt='', date_time='2019-03-08T22:37:33.901Z',
account=sailpoint.v2024.models.account_status_changed_account.AccountStatusChanged_account( account=sailpoint.v2024.models.access_requested_account.AccessRequested_account(
id = '', id = '2c91808a77ff216301782327a50f09bf',
native_identity = '', native_identity = 'dr.arden.ogahn.d',
display_name = '', display_name = 'Adam Archer',
source_id = '', source_id = '8a80828f643d484f01643e14202e206f',
source_name = '', source_name = 'JDBC Entitlements Source',
entitlement_count = 56, entitlement_count = 2,
access_type = '', ), access_type = 'account', ),
status_change=sailpoint.v2024.models.account_status_changed_status_change.AccountStatusChanged_statusChange( status_change=sailpoint.v2024.models.access_requested_status_change.AccessRequested_statusChange(
previous_status = 'enabled', 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 from sailpoint.v2024.models.attribute_change import AttributeChange
attribute_change = AttributeChange( attribute_change = AttributeChange(
name='', name='firstname',
previous_value='', previous_value='adam',
new_value='' 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**changes** | [**[]AttributeChange**](attribute-change) | | [optional] **attribute_changes** | [**[]AttributeChange**](attribute-change) | | [required]
**event_type** | **str** | the event type | [optional] **event_type** | **str** | the event type | [optional]
**identity_id** | **str** | the identity id | [optional] **identity_id** | **str** | the identity id | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
} }
## Example ## Example
@@ -28,12 +28,15 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.attributes_changed import AttributesChanged from sailpoint.v2024.models.attributes_changed import AttributesChanged
attributes_changed = AttributesChanged( attributes_changed = AttributesChanged(
changes=[ attribute_changes=[
{name=firstname, previousValue=adam, newValue=zampa} sailpoint.v2024.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
], ],
event_type='', event_type='AttributesChanged',
identity_id='', identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
dt='' 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 | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**name** | **str** | The name of the governance event, such as the certification name or access request ID. | [optional] **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] **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] **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] **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( correlated_governance_event = CorrelatedGovernanceEvent(
name='Manager Certification for Jon Snow', name='Manager Certification for Jon Snow',
dt='2019-03-08T22:37:33.901Z', date_time='2019-03-08T22:37:33.901Z',
type='certification', type='certification',
governance_id='2c91808a77ff216301782327a50f09bf', governance_id='2c91808a77ff216301782327a50f09bf',
owners=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] **certification_id** | **str** | the id of the certification item | [required]
**identity_id** | **str** | the identity id | [optional] **certification_name** | **str** | the certification item name | [required]
**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]
**signed_date** | **str** | the date ceritification was signed | [optional] **signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [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] **reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional] **signer** | [**CertifierResponse**](certifier-response) | | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] **event_type** | **str** | the event type | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [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 ## Example
@@ -39,27 +39,6 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner from sailpoint.v2024.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
get_historical_identity_events200_response_inner = 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_id='2c91808a77ff216301782327a50f09bf',
certification_name='Cert name', certification_name='Cert name',
signed_date='2019-03-08T22:37:33.901Z', 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( signer=sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), display_name = 'John Snow', ),
account=sailpoint.v2024.models.account_status_changed_account.AccountStatusChanged_account( event_type='AccountStatusChanged',
id = '', date_time='2019-03-08T22:37:33.901Z',
native_identity = '', identity_id='8a80828f643d484f01643e14202e206f',
display_name = '', access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
source_id = '', governance_event=sailpoint.v2024.models.correlated_governance_event.CorrelatedGovernanceEvent(
source_name = '', name = 'Manager Certification for Jon Snow',
entitlement_count = 56, date_time = '2019-03-08T22:37:33.901Z',
access_type = '', ), type = 'certification',
status_change=sailpoint.v2024.models.account_status_changed_status_change.AccountStatusChanged_statusChange( 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', 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**certification_id** | **str** | the id of the certification item | [optional] **certification_id** | **str** | the id of the certification item | [required]
**certification_name** | **str** | the certification item name | [optional] **certification_name** | **str** | the certification item name | [required]
**signed_date** | **str** | the date ceritification was signed | [optional] **signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [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] **reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional] **signer** | [**CertifierResponse**](certifier-response) | | [optional]
**event_type** | **str** | the event type | [optional] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
} }
## Example ## Example
@@ -41,7 +41,7 @@ signer=sailpoint.v2024.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), display_name = 'John Snow', ),
event_type='IdentityCertified', 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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.v2024.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner( list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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 Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**enabled** | **bool** | Indicates if the Classification is enabled for a Source | [optional] [default to False] **enabled** | **bool** | Indicates whether Classification is enabled for a Source | [optional] [default to False]
**classification_method** | **Enum** [ 'SOURCE' ] | Classification Method | [optional] **classification_method** | **Enum** [ 'SOURCE', 'CRITERIA' ] | Classification Method | [optional]
**criteria** | **str** | A classification criteria object | [optional] **criteria** | [**MachineClassificationCriteriaLevel1**](machine-classification-criteria-level1) | | [optional]
**created** | **datetime** | Time when the config was created | [optional] **created** | **datetime** | Date the config was created | [optional]
**modified** | **datetime** | Time when the config was last updated | [optional] **modified** | **datetime** | Date the config was last updated | [optional]
} }
## Example ## Example
@@ -31,7 +31,19 @@ from sailpoint.v2024.models.machine_classification_config import MachineClassifi
machine_classification_config = MachineClassificationConfig( machine_classification_config = MachineClassificationConfig(
enabled=True, enabled=True,
classification_method='SOURCE', 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', created='2017-07-11T18:45:37.098Z',
modified='2018-06-25T20:22:28.104Z' 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 # 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 ## 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', id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'SOURCE', type = 'SOURCE',
name = 'ODS-AD-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}], ), password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ),
owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY', 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', id='2c9180827ca885d7017ca8ce28a000eb',
type='SOURCE', type='SOURCE',
name='ODS-AD-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}] 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', id = '2c9180827ca885d7017ca8ce28a000eb',
type = 'SOURCE', type = 'SOURCE',
name = 'ODS-AD-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}], ), password_policies = [{type=PASSWORD_POLICY, id=006a072ecc6647f68bba9f4a4ad34649, name=Password Policy 1}], ),
owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto( owner=sailpoint.v2024.models.base_reference_dto.BaseReferenceDto(
type = 'IDENTITY', 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'`) * `FORM` (value: `'Form'`)
* `POLICYVIOLOATION` (value: `'PolicyVioloation'`) * `POLICYVIOLATION` (value: `'PolicyViolation'`)
* `CHALLENGE` (value: `'Challenge'`) * `CHALLENGE` (value: `'Challenge'`)

410
docs/tools/sdk/python/Reference/V2025/Methods/AccessModelMetadataApi.md
View File

@@ -29,20 +29,12 @@ Method | HTTP request | Description
[**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value [**get-access-model-metadata-attribute-value**](#get-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values/{value}` | Get access model metadata value
[**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes [**list-access-model-metadata-attribute**](#list-access-model-metadata-attribute) | **GET** `/access-model-metadata/attributes` | List access model metadata attributes
[**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values [**list-access-model-metadata-attribute-value**](#list-access-model-metadata-attribute-value) | **GET** `/access-model-metadata/attributes/{key}/values` | List access model metadata values
[**update-access-model-metadata-by-filter**](#update-access-model-metadata-by-filter) | **POST** `/access-model-metadata/bulk-update/filter` | Metadata Attribute update by filter
[**update-access-model-metadata-by-ids**](#update-access-model-metadata-by-ids) | **POST** `/access-model-metadata/bulk-update/ids` | Metadata Attribute update by ids
[**update-access-model-metadata-by-query**](#update-access-model-metadata-by-query) | **POST** `/access-model-metadata/bulk-update/query` | Metadata Attribute update by query
## get-access-model-metadata-attribute ## 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 access model metadata attribute
Get single Access Model Metadata Attribute Get single Access Model Metadata Attribute
@@ -53,7 +45,6 @@ Get single Access Model Metadata Attribute
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. 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 ### Return type
[**AttributeDTO**](../models/attribute-dto) [**AttributeDTO**](../models/attribute-dto)
@@ -81,18 +72,16 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# Get access model metadata attribute # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -104,17 +93,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-access-model-metadata-attribute-value ## 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 access model metadata value
Get single Access Model Metadata Attribute Value Get single Access Model Metadata Attribute Value
@@ -126,7 +104,6 @@ Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. Path | key | **str** | True | Technical name of the Attribute.
Path | value | **str** | True | Technical name of the Attribute value. 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 ### Return type
[**AttributeValueDTO**](../models/attribute-value-dto) [**AttributeValueDTO**](../models/attribute-value-dto)
@@ -154,19 +131,17 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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. 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: try:
# Get access model metadata value # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -178,17 +153,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute ## 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 List access model metadata attributes
Get a list of Access Model Metadata Attributes Get a list of Access Model Metadata Attributes
@@ -198,8 +162,11 @@ Get a list of Access Model Metadata Attributes
Param Type | Name | Data Type | Required | Description 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: **key**: *eq* **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: **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 ### Return type
[**List[AttributeDTO]**](../models/attribute-dto) [**List[AttributeDTO]**](../models/attribute-dto)
@@ -227,18 +194,20 @@ from sailpoint.v2025.models.attribute_dto import AttributeDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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: **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)
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) 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: try:
# List access model metadata attributes # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -251,17 +220,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-access-model-metadata-attribute-value ## 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 List access model metadata values
Get a list of Access Model Metadata Attribute Values Get a list of Access Model Metadata Attribute Values
@@ -272,7 +230,9 @@ Get a list of Access Model Metadata Attribute Values
Param Type | Name | Data Type | Required | Description Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | key | **str** | True | Technical name of the Attribute. 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 ### Return type
[**List[AttributeValueDTO]**](../models/attribute-value-dto) [**List[AttributeValueDTO]**](../models/attribute-value-dto)
@@ -300,18 +260,19 @@ from sailpoint.v2025.models.attribute_value_dto import AttributeValueDTO
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# List access model metadata values # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -321,6 +282,323 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## update-access-model-metadata-by-filter
Metadata Attribute update by filter
Bulk update Access Model Metadata Attribute Values using a filter
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-filter)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | entitlement_attribute_bulk_update_filter_request | [**EntitlementAttributeBulkUpdateFilterRequest**](../models/entitlement-attribute-bulk-update-filter-request) | True | Attribute metadata bulk update request body.
### Return type
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | OK | AccessModelMetadataBulkUpdateResponse | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.access_model_metadata_bulk_update_response import AccessModelMetadataBulkUpdateResponse
from sailpoint.v2025.models.entitlement_attribute_bulk_update_filter_request import EntitlementAttributeBulkUpdateFilterRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
entitlement_attribute_bulk_update_filter_request = '''{
"values" : [ {
"attribute" : "iscFederalClassifications",
"values" : [ "topSecret" ]
} ],
"filters" : "id eq 2c9180867817ac4d017817c491119a20",
"replaceScope" : "attribute",
"operation" : "add"
}''' # EntitlementAttributeBulkUpdateFilterRequest | Attribute metadata bulk update request body.
try:
# Metadata Attribute update by filter
new_entitlement_attribute_bulk_update_filter_request = EntitlementAttributeBulkUpdateFilterRequest.from_json(entitlement_attribute_bulk_update_filter_request)
results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_filter(entitlement_attribute_bulk_update_filter_request=new_entitlement_attribute_bulk_update_filter_request)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_filter(new_entitlement_attribute_bulk_update_filter_request)
print("The response of AccessModelMetadataApi->update_access_model_metadata_by_filter:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AccessModelMetadataApi->update_access_model_metadata_by_filter: %s\n" % e)
```
[[Back to top]](#)
## update-access-model-metadata-by-ids
Metadata Attribute update by ids
Bulk update Access Model Metadata Attribute Values using ids.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-ids)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | entitlement_attribute_bulk_update_ids_request | [**EntitlementAttributeBulkUpdateIdsRequest**](../models/entitlement-attribute-bulk-update-ids-request) | True | Attribute metadata bulk update request body.
### Return type
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | OK | AccessModelMetadataBulkUpdateResponse | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.access_model_metadata_bulk_update_response import AccessModelMetadataBulkUpdateResponse
from sailpoint.v2025.models.entitlement_attribute_bulk_update_ids_request import EntitlementAttributeBulkUpdateIdsRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
entitlement_attribute_bulk_update_ids_request = '''{
"entitlements" : [ "2c9180867817ac4d017817c491119a20", "2c9180867817ac4d017817c491119a21" ],
"values" : [ {
"attribute" : "iscFederalClassifications",
"values" : [ "topSecret" ]
} ],
"replaceScope" : "attribute",
"operation" : "add"
}''' # EntitlementAttributeBulkUpdateIdsRequest | Attribute metadata bulk update request body.
try:
# Metadata Attribute update by ids
new_entitlement_attribute_bulk_update_ids_request = EntitlementAttributeBulkUpdateIdsRequest.from_json(entitlement_attribute_bulk_update_ids_request)
results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_ids(entitlement_attribute_bulk_update_ids_request=new_entitlement_attribute_bulk_update_ids_request)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_ids(new_entitlement_attribute_bulk_update_ids_request)
print("The response of AccessModelMetadataApi->update_access_model_metadata_by_ids:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AccessModelMetadataApi->update_access_model_metadata_by_ids: %s\n" % e)
```
[[Back to top]](#)
## update-access-model-metadata-by-query
Metadata Attribute update by query
Bulk update Access Model Metadata Attribute Values using a query
[API Spec](https://developer.sailpoint.com/docs/api/v2025/update-access-model-metadata-by-query)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Body | entitlement_attribute_bulk_update_query_request | [**EntitlementAttributeBulkUpdateQueryRequest**](../models/entitlement-attribute-bulk-update-query-request) | True | Attribute metadata bulk update request body.
### Return type
[**AccessModelMetadataBulkUpdateResponse**](../models/access-model-metadata-bulk-update-response)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | OK | AccessModelMetadataBulkUpdateResponse | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: application/json
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.access_model_metadata_api import AccessModelMetadataApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.access_model_metadata_bulk_update_response import AccessModelMetadataBulkUpdateResponse
from sailpoint.v2025.models.entitlement_attribute_bulk_update_query_request import EntitlementAttributeBulkUpdateQueryRequest
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
entitlement_attribute_bulk_update_query_request = '''{
"query" : {
"queryDsl" : {
"match" : {
"name" : "john.doe"
}
},
"aggregationType" : "DSL",
"aggregationsVersion" : "",
"query" : {
"query" : "name:a*",
"timeZone" : "America/Chicago",
"fields" : "[firstName,lastName,email]",
"innerHit" : {
"query" : "source.name:\\\"Active Directory\\\"",
"type" : "access"
}
},
"aggregationsDsl" : { },
"sort" : [ "displayName", "+id" ],
"filters" : { },
"queryVersion" : "",
"queryType" : "SAILPOINT",
"includeNested" : true,
"queryResultFilter" : {
"excludes" : [ "stacktrace" ],
"includes" : [ "name", "displayName" ]
},
"indices" : [ "identities" ],
"typeAheadQuery" : {
"field" : "source.name",
"size" : 100,
"query" : "Work",
"sortByValue" : true,
"nestedType" : "access",
"sort" : "asc",
"maxExpansions" : 10
},
"textQuery" : {
"contains" : true,
"terms" : [ "The quick brown fox", "3141592", "7" ],
"matchAny" : false,
"fields" : [ "displayName", "employeeNumber", "roleCount" ]
},
"searchAfter" : [ "John Doe", "2c91808375d8e80a0175e1f88a575221" ],
"aggregations" : {
"filter" : {
"field" : "access.type",
"name" : "Entitlements",
"type" : "TERM",
"value" : "ENTITLEMENT"
},
"bucket" : {
"field" : "attributes.city",
"size" : 100,
"minDocCount" : 2,
"name" : "Identity Locations",
"type" : "TERMS"
},
"metric" : {
"field" : "@access.name",
"name" : "Access Name Count",
"type" : "COUNT"
},
"subAggregation" : {
"filter" : {
"field" : "access.type",
"name" : "Entitlements",
"type" : "TERM",
"value" : "ENTITLEMENT"
},
"bucket" : {
"field" : "attributes.city",
"size" : 100,
"minDocCount" : 2,
"name" : "Identity Locations",
"type" : "TERMS"
},
"metric" : {
"field" : "@access.name",
"name" : "Access Name Count",
"type" : "COUNT"
},
"subAggregation" : {
"filter" : {
"field" : "access.type",
"name" : "Entitlements",
"type" : "TERM",
"value" : "ENTITLEMENT"
},
"bucket" : {
"field" : "attributes.city",
"size" : 100,
"minDocCount" : 2,
"name" : "Identity Locations",
"type" : "TERMS"
},
"metric" : {
"field" : "@access.name",
"name" : "Access Name Count",
"type" : "COUNT"
},
"nested" : {
"name" : "id",
"type" : "access"
}
},
"nested" : {
"name" : "id",
"type" : "access"
}
},
"nested" : {
"name" : "id",
"type" : "access"
}
}
},
"values" : [ {
"attribute" : "iscFederalClassifications",
"values" : [ "topSecret" ]
} ],
"replaceScope" : "attribute",
"operation" : "add"
}''' # EntitlementAttributeBulkUpdateQueryRequest | Attribute metadata bulk update request body.
try:
# Metadata Attribute update by query
new_entitlement_attribute_bulk_update_query_request = EntitlementAttributeBulkUpdateQueryRequest.from_json(entitlement_attribute_bulk_update_query_request)
results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_query(entitlement_attribute_bulk_update_query_request=new_entitlement_attribute_bulk_update_query_request)
# Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).update_access_model_metadata_by_query(new_entitlement_attribute_bulk_update_query_request)
print("The response of AccessModelMetadataApi->update_access_model_metadata_by_query:\n")
print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling AccessModelMetadataApi->update_access_model_metadata_by_query: %s\n" % e)
```
[[Back to top]](#) [[Back to top]](#)

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

@@ -79,17 +79,6 @@ Method | HTTP request | Description
## create-access-model-metadata-for-entitlement ## 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 metadata to an entitlement.
Add single Access Model 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 | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute. Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value. 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 ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -130,20 +118,18 @@ from sailpoint.v2025.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Add metadata to an entitlement. # 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 # 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("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -155,17 +141,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## delete-access-model-metadata-from-entitlement ## 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 metadata from an entitlement.
Remove single Access Model 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 | id | **str** | True | The entitlement id.
Path | attribute_key | **str** | True | Technical name of the Attribute. Path | attribute_key | **str** | True | Technical name of the Attribute.
Path | attribute_value | **str** | True | Technical name of the Attribute Value. 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 ### Return type
(empty response body) (empty response body)
@@ -205,20 +179,18 @@ from sailpoint.v2025.api_client import ApiClient
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Remove metadata from an entitlement. # 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % 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]](#) [[Back to top]](#)
## get-entitlement ## 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 Get an entitlement
This API returns an entitlement by its ID. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | The entitlement ID 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 ### Return type
[**Entitlement**](../models/entitlement) [**Entitlement**](../models/entitlement)
@@ -278,18 +238,16 @@ from sailpoint.v2025.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID 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: try:
# Get an entitlement # 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 # 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("The response of EntitlementsApi->get_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -301,17 +259,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## get-entitlement-request-config ## 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 Get entitlement request config
This API returns the entitlement request config for a specified entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 ### Return type
[**EntitlementRequestConfig**](../models/entitlement-request-config) [**EntitlementRequestConfig**](../models/entitlement-request-config)
@@ -351,18 +297,16 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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: try:
# Get entitlement request config # 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 # 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("The response of EntitlementsApi->get_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -377,17 +321,6 @@ with ApiClient(configuration) as api_client:
:::caution deprecated :::caution deprecated
This endpoint has been deprecated and may be replaced or removed in future versions of the API. 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 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). 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Source Id 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. | csv_file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -431,19 +363,17 @@ from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Aggregate entitlements # 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 # 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("The response of EntitlementsApi->import_entitlements_by_source:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -455,17 +385,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-children ## 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 List of entitlements children
This API returns a list of all child entitlements of a given entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 | 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 | 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. 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.v2025.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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: try:
# List of entitlements children # 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 # 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") print("The response of EntitlementsApi->list_entitlement_children:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -539,17 +455,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlement-parents ## 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 List of entitlements parents
This API returns a list of all parent entitlements of a given entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement Id 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 | 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 | 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. 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.v2025.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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: try:
# List of entitlements parents # 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 # 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") print("The response of EntitlementsApi->list_entitlement_parents:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -623,17 +525,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## list-entitlements ## 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. Gets a list of entitlements.
This API returns 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 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 | 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 | 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). 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.v2025.models.entitlement import Entitlement
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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) 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) 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) 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: try:
# Gets a list of entitlements. # 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 # 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") print("The response of EntitlementsApi->list_entitlements:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -716,17 +604,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## patch-entitlement ## 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 Patch an entitlement
This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of the entitlement to patch 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) | Body | json_patch_operation | [**[]JsonPatchOperation**](../models/json-patch-operation) | (optional) |
### Return type ### Return type
@@ -772,19 +648,17 @@ from sailpoint.v2025.models.json_patch_operation import JsonPatchOperation
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch 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) json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try: try:
# Patch an entitlement # 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 # 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("The response of EntitlementsApi->patch_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -796,17 +670,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## put-entitlement-request-config ## 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 Replace entitlement request config
This API replaces the entitlement request config for a specified entitlement. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Entitlement ID 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 | Body | entitlement_request_config | [**EntitlementRequestConfig**](../models/entitlement-request-config) | True |
### Return type ### Return type
@@ -847,11 +709,9 @@ from sailpoint.v2025.models.entitlement_request_config import EntitlementRequest
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID 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 = '''{ entitlement_request_config = '''{
"accessRequestConfig" : { "accessRequestConfig" : {
"denialCommentRequired" : false, "denialCommentRequired" : false,
@@ -879,9 +739,9 @@ with ApiClient(configuration) as api_client:
try: try:
# Replace entitlement request config # Replace entitlement request config
new_entitlement_request_config = EntitlementRequestConfig.from_json(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 # 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("The response of EntitlementsApi->put_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -893,17 +753,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## reset-source-entitlements ## 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 Reset source entitlements
Remove all entitlements from a specific source. 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`. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | ID of source for the entitlement reset 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 ### Return type
[**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto) [**EntitlementSourceResetBaseReferenceDto**](../models/entitlement-source-reset-base-reference-dto)
@@ -943,18 +791,16 @@ from sailpoint.v2025.models.entitlement_source_reset_base_reference_dto import E
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset 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: try:
# Reset source entitlements # 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 # 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("The response of EntitlementsApi->reset_source_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -966,17 +812,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## update-entitlements-in-bulk ## 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 Bulk update an entitlement list
This API applies an update to every entitlement of the 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 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 | Body | entitlement_bulk_update_request | [**EntitlementBulkUpdateRequest**](../models/entitlement-bulk-update-request) | True |
### Return type ### Return type
@@ -1028,10 +862,8 @@ from sailpoint.v2025.models.entitlement_bulk_update_request import EntitlementBu
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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 = '''{ entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ { "jsonPatch" : [ {
@@ -1052,9 +884,9 @@ with ApiClient(configuration) as api_client:
try: try:
# Bulk update an entitlement list # Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e)
``` ```

67
docs/tools/sdk/python/Reference/V2025/Methods/IdentitiesApi.md
View File

@@ -35,6 +35,7 @@ Method | HTTP request | Description
[**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details [**get-identity-ownership-details**](#get-identity-ownership-details) | **GET** `/identities/{identityId}/ownership` | Get ownership details
[**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details [**get-role-assignment**](#get-role-assignment) | **GET** `/identities/{identityId}/role-assignments/{assignmentId}` | Role assignment details
[**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments [**get-role-assignments**](#get-role-assignments) | **GET** `/identities/{identityId}/role-assignments` | List role assignments
[**list-entitlements-by-identity**](#list-entitlements-by-identity) | **GET** `/entitlements/identities/{id}/entitlements` | List of entitlements by identity.
[**list-identities**](#list-identities) | **GET** `/identities` | List identities [**list-identities**](#list-identities) | **GET** `/identities` | List identities
[**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity [**reset-identity**](#reset-identity) | **POST** `/identities/{id}/reset` | Reset an identity
[**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email [**send-identity-verification-account-token**](#send-identity-verification-account-token) | **POST** `/identities/{id}/verification/account/send` | Send password reset email
@@ -356,6 +357,72 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#)
## list-entitlements-by-identity
List of entitlements by identity.
The API returns a list of all entitlements assigned to an identity, either directly or through the role or access profile. A token with ORG_ADMIN or API authority is required to call this API.
[API Spec](https://developer.sailpoint.com/docs/api/v2025/list-entitlements-by-identity)
### Parameters
Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | -------------
Path | id | **str** | True | Identity Id
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.
### Return type
[**List[IdentityEntitlements]**](../models/identity-entitlements)
### Responses
Code | Description | Data Type | Response headers |
------------- | ------------- | ------------- |------------------|
200 | List of all Entitlements for given Identity | List[IdentityEntitlements] | - |
400 | Client Error - Returned if the request body is invalid. | ErrorResponseDto | - |
401 | Unauthorized - Returned if there is no authorization header, or if the JWT token is expired. | ListAccessProfiles401Response | - |
403 | Forbidden - Returned if the user you are running as, doesn't have access to this end-point. | ErrorResponseDto | - |
404 | Not Found - returned if the request URL refers to a resource or object that does not exist | ErrorResponseDto | - |
429 | Too Many Requests - Returned in response to too many requests in a given period of time - rate limited. The Retry-After header in the response includes how long to wait before trying again. | ListAccessProfiles429Response | - |
500 | Internal Server Error - Returned if there is an unexpected error. | ErrorResponseDto | - |
### HTTP request headers
- **Content-Type**: Not defined
- **Accept**: application/json
### Example
```python
from sailpoint.v2025.api.identities_api import IdentitiesApi
from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.identity_entitlements import IdentityEntitlements
from sailpoint.configuration import Configuration
configuration = Configuration()
with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Identity Id # str | Identity Id
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)
try:
# List of entitlements by identity.
results = IdentitiesApi(api_client).list_entitlements_by_identity(id=id)
# Below is a request that includes all optional parameters
# results = IdentitiesApi(api_client).list_entitlements_by_identity(id, limit, offset, count)
print("The response of IdentitiesApi->list_entitlements_by_identity:\n")
for item in results:
print(item.model_dump_json(by_alias=True, indent=4))
except Exception as e:
print("Exception when calling IdentitiesApi->list_entitlements_by_identity: %s\n" % e)
```
[[Back to top]](#) [[Back to top]](#)
## list-identities ## list-identities

12
docs/tools/sdk/python/Reference/V2025/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**](#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 [**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**](#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**](#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-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 [**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 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' 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/v2025/get-historical-identity-events) [API Spec](https://developer.sailpoint.com/docs/api/v2025/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) 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: 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) 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 # 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 Query | type | **str** | (optional) | The access item type
### Return type ### Return type
[**List[ListIdentityAccessItems200ResponseInner]**](../models/list-identity-access-items200-response-inner) [**List[ListIdentitySnapshotAccessItems200ResponseInner]**](../models/list-identity-snapshot-access-items200-response-inner)
### Responses ### Responses
Code | Description | Data Type | Response headers | 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 | - | 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 | - | 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 | - | 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 ```python
from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi from sailpoint.v2025.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2025.api_client import ApiClient from sailpoint.v2025.api_client import ApiClient
from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.v2025.models.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

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

@@ -180,7 +180,56 @@ configuration = Configuration()
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID. id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{ 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", "created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z", "modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE", "classificationMethod" : "SOURCE",

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

@@ -1975,17 +1975,6 @@ with ApiClient(configuration) as api_client:
[[Back to top]](#) [[Back to top]](#)
## import-entitlements ## 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 Entitlement aggregation
Starts an entitlement aggregation on the specified source. 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. 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 Param Type | Name | Data Type | Required | Description
------------- | ------------- | ------------- | ------------- | ------------- ------------- | ------------- | ------------- | ------------- | -------------
Path | source_id | **str** | True | Source Id 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. | file | **bytearray** | (optional) | The CSV file containing the source entitlements to aggregate.
### Return type ### Return type
@@ -2028,19 +2016,17 @@ from sailpoint.v2025.models.load_entitlement_task import LoadEntitlementTask
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Entitlement aggregation # 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 # 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("The response of SourcesApi->import_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:

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

@@ -16,18 +16,17 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponse', 'V2
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. accessProfile in this case | [optional]
**id** | **str** | the access item id | [optional] **id** | **str** | the access item id | [optional]
**name** | **str** | the access profile name | [optional] **access_type** | **str** | the access item type. accessProfile in this case | [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]
**display_name** | **str** | the display name of the identity | [optional] **display_name** | **str** | the display name of the identity | [optional]
**entitlement_count** | **str** | the number of entitlements the access profile will create | [optional] **source_name** | **str** | the name of the source | [optional]
**app_display_name** | **str** | the name of | [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] **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] **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 ## Example
@@ -36,15 +35,14 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.access_item_access_profile_response import AccessItemAccessProfileResponse from sailpoint.v2025.models.access_item_access_profile_response import AccessItemAccessProfileResponse
access_item_access_profile_response = AccessItemAccessProfileResponse( access_item_access_profile_response = AccessItemAccessProfileResponse(
access_type='accessProfile',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='accessProfile',
source_name='DataScienceDataset',
source_id='2793o32dwd',
description='AccessProfile - Workday/Citizenship access',
display_name='Dr. Arden Rogahn MD', display_name='Dr. Arden Rogahn MD',
entitlement_count='12', source_name='DataScienceDataset',
app_display_name='AppName', 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', remove_date='2024-07-01T06:00:00.00Z',
standalone=False, standalone=False,
revocable=True revocable=True

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

@@ -0,0 +1,35 @@
---
id: v2025-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', 'V2025AccessItemAccessProfileResponseAppRefsInner']
slug: /tools/sdk/python/v2025/models/access-item-access-profile-response-app-refs-inner
tags: ['SDK', 'Software Development Kit', 'AccessItemAccessProfileResponseAppRefsInner', 'V2025AccessItemAccessProfileResponseAppRefsInner']
---
# 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.v2025.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/V2025/Models/AccessItemAccountResponse.md
View File

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

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

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

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

@@ -16,11 +16,12 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociated', 'V2025AccessIt
Name | Type | Description | Notes 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] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
**governance_event** | [**CorrelatedGovernanceEvent**](correlated-governance-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 ## Example
@@ -29,20 +30,21 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.access_item_associated import AccessItemAssociated from sailpoint.v2025.models.access_item_associated import AccessItemAssociated
access_item_associated = 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', 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.v2025.models.correlated_governance_event.CorrelatedGovernanceEvent( governance_event=sailpoint.v2025.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], reviewers = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
decision_maker = sailpoint.v2025.models.certifier_response.CertifierResponse( decision_maker = sailpoint.v2025.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ) display_name = 'John Snow', ), ),
access_item_type='account'
) )
``` ```

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

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemAssociatedAccessItem', 'V20
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.access_item_associated_access_item import AccessItemAssociatedAccessItem from sailpoint.v2025.models.access_item_associated_access_item import AccessItemAssociatedAccessItem
access_item_associated_access_item = AccessItemAssociatedAccessItem( access_item_associated_access_item = AccessItemAssociatedAccessItem(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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/V2025/Models/AccessItemEntitlementResponse.md
View File

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

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

@@ -16,10 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRemoved', 'V2025AccessItemR
Name | Type | Description | Notes 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] **identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [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] **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}, access_item={id=8c190e6787aa4ed9a90bd9d5344523fb, accessType=account, nativeIdentity=127999, sourceName=JDBC Entitlements Source, entitlementCount=0, displayName=Sample Name},
identity_id='8c190e6787aa4ed9a90bd9d5344523fb', identity_id='8c190e6787aa4ed9a90bd9d5344523fb',
event_type='AccessItemRemoved', 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.v2025.models.correlated_governance_event.CorrelatedGovernanceEvent( governance_event=sailpoint.v2025.models.correlated_governance_event.CorrelatedGovernanceEvent(
name = 'Manager Certification for Jon Snow', name = 'Manager Certification for Jon Snow',
dt = '2019-03-08T22:37:33.901Z', date_time = '2019-03-08T22:37:33.901Z',
type = 'certification', type = 'certification',
governance_id = '2c91808a77ff216301782327a50f09bf', governance_id = '2c91808a77ff216301782327a50f09bf',
owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}], owners = [{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],

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

@@ -16,11 +16,11 @@ tags: ['SDK', 'Software Development Kit', 'AccessItemRoleResponse', 'V2025Access
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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] **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] **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] **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] **revocable** | **bool** | indicates whether the role is revocable | [required]
} }
@@ -31,11 +31,11 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.access_item_role_response import AccessItemRoleResponse from sailpoint.v2025.models.access_item_role_response import AccessItemRoleResponse
access_item_role_response = AccessItemRoleResponse( access_item_role_response = AccessItemRoleResponse(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
access_type='role',
display_name='sample', display_name='sample',
description='Role - Workday/Citizenship access',
source_name='Source Name', source_name='Source Name',
description='Role - Workday/Citizenship access',
remove_date='2024-07-01T06:00:00.00Z', remove_date='2024-07-01T06:00:00.00Z',
revocable=True revocable=True
) )

39
docs/tools/sdk/python/Reference/V2025/Models/AccessModelMetadataBulkUpdateResponse.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-access-model-metadata-bulk-update-response
title: AccessModelMetadataBulkUpdateResponse
pagination_label: AccessModelMetadataBulkUpdateResponse
sidebar_label: AccessModelMetadataBulkUpdateResponse
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'AccessModelMetadataBulkUpdateResponse', 'V2025AccessModelMetadataBulkUpdateResponse']
slug: /tools/sdk/python/v2025/models/access-model-metadata-bulk-update-response
tags: ['SDK', 'Software Development Kit', 'AccessModelMetadataBulkUpdateResponse', 'V2025AccessModelMetadataBulkUpdateResponse']
---
# AccessModelMetadataBulkUpdateResponse
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **str** | ID of the task which is executing the bulk update. | [optional]
**type** | **str** | Type of the bulk update object. | [optional]
**status** | **Enum** [ 'CREATED', 'PRE_PROCESS', 'PRE_PROCESS_COMPLETED', 'POST_PROCESS', 'COMPLETED', 'CHUNK_PENDING', 'CHUNK_PROCESSING', 'RE_PROCESSING', 'PRE_PROCESS_FAILED', 'FAILED' ] | The status of the bulk update request, only list unfinished request's status. | [optional]
**created** | **datetime** | Time when the bulk update request was created | [optional]
}
## Example
```python
from sailpoint.v2025.models.access_model_metadata_bulk_update_response import AccessModelMetadataBulkUpdateResponse
access_model_metadata_bulk_update_response = AccessModelMetadataBulkUpdateResponse(
id='2c9180867817ac4d017817c491119a20',
type='Role',
status='CREATED',
created='2020-10-08T18:33:52.029Z'
)
```
[[Back to top]](#)

6
docs/tools/sdk/python/Reference/V2025/Models/AccessRequested.md
View File

@@ -16,10 +16,10 @@ tags: ['SDK', 'Software Development Kit', 'AccessRequested', 'V2025AccessRequest
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [optional] **access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**identity_id** | **str** | the identity id | [optional] **identity_id** | **str** | the identity id | [optional]
**event_type** | **str** | the event type | [optional] **event_type** | **str** | the event type | [optional]
**dt** | **str** | the date of event | [optional] **date_time** | **str** | the date of event | [optional]
} }
## Example ## Example
@@ -34,7 +34,7 @@ access_request=sailpoint.v2025.models.access_request_response_1.AccessRequestRes
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}]}], ), 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}]}], ),
identity_id='8a80828f643d484f01643e14202e206f', identity_id='8a80828f643d484f01643e14202e206f',
event_type='AccessRequested', event_type='AccessRequested',
dt='2019-03-08T22:37:33.901Z' date_time='2019-03-08T22:37:33.901Z'
) )
``` ```

28
docs/tools/sdk/python/Reference/V2025/Models/AccountStatusChanged.md
View File

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

14
docs/tools/sdk/python/Reference/V2025/Models/AccountStatusChangedAccount.md
View File

@@ -31,13 +31,13 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.account_status_changed_account import AccountStatusChangedAccount from sailpoint.v2025.models.account_status_changed_account import AccountStatusChangedAccount
account_status_changed_account = AccountStatusChangedAccount( account_status_changed_account = AccountStatusChangedAccount(
id='', id='2c91808a77ff216301782327a50f09bf',
native_identity='', native_identity='dr.arden.ogahn.d',
display_name='', display_name='Adam Archer',
source_id='', source_id='8a80828f643d484f01643e14202e206f',
source_name='', source_name='JDBC Entitlements Source',
entitlement_count=56, entitlement_count=2,
access_type='' access_type='account'
) )
``` ```

2
docs/tools/sdk/python/Reference/V2025/Models/AccountStatusChangedStatusChange.md
View File

@@ -27,7 +27,7 @@ from sailpoint.v2025.models.account_status_changed_status_change import AccountS
account_status_changed_status_change = AccountStatusChangedStatusChange( account_status_changed_status_change = AccountStatusChangedStatusChange(
previous_status='enabled', previous_status='enabled',
new_status='enabled' new_status='disabled'
) )
``` ```

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

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

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

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

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

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

39
docs/tools/sdk/python/Reference/V2025/Models/EntitlementAttributeBulkUpdateFilterRequest.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-entitlement-attribute-bulk-update-filter-request
title: EntitlementAttributeBulkUpdateFilterRequest
pagination_label: EntitlementAttributeBulkUpdateFilterRequest
sidebar_label: EntitlementAttributeBulkUpdateFilterRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementAttributeBulkUpdateFilterRequest', 'V2025EntitlementAttributeBulkUpdateFilterRequest']
slug: /tools/sdk/python/v2025/models/entitlement-attribute-bulk-update-filter-request
tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateFilterRequest', 'V2025EntitlementAttributeBulkUpdateFilterRequest']
---
# EntitlementAttributeBulkUpdateFilterRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**filters** | **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: **id**: *eq* | [optional]
**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | Operation to perform on the attributes in the bulk update request. | [optional]
**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional]
**values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional]
}
## Example
```python
from sailpoint.v2025.models.entitlement_attribute_bulk_update_filter_request import EntitlementAttributeBulkUpdateFilterRequest
entitlement_attribute_bulk_update_filter_request = EntitlementAttributeBulkUpdateFilterRequest(
filters='id eq 2c9180867817ac4d017817c491119a20',
operation='add',
replace_scope='attribute',
values=[{attribute=iscFederalClassifications, values=[topSecret]}]
)
```
[[Back to top]](#)

39
docs/tools/sdk/python/Reference/V2025/Models/EntitlementAttributeBulkUpdateIdsRequest.md Normal file
View File

@@ -0,0 +1,39 @@
---
id: v2025-entitlement-attribute-bulk-update-ids-request
title: EntitlementAttributeBulkUpdateIdsRequest
pagination_label: EntitlementAttributeBulkUpdateIdsRequest
sidebar_label: EntitlementAttributeBulkUpdateIdsRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementAttributeBulkUpdateIdsRequest', 'V2025EntitlementAttributeBulkUpdateIdsRequest']
slug: /tools/sdk/python/v2025/models/entitlement-attribute-bulk-update-ids-request
tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateIdsRequest', 'V2025EntitlementAttributeBulkUpdateIdsRequest']
---
# EntitlementAttributeBulkUpdateIdsRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**entitlements** | **[]str** | List of entitlement IDs to update. | [optional]
**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | Operation to perform on the attributes in the bulk update request. | [optional]
**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional]
**values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional]
}
## Example
```python
from sailpoint.v2025.models.entitlement_attribute_bulk_update_ids_request import EntitlementAttributeBulkUpdateIdsRequest
entitlement_attribute_bulk_update_ids_request = EntitlementAttributeBulkUpdateIdsRequest(
entitlements=[2c9180867817ac4d017817c491119a20, 2c9180867817ac4d017817c491119a21],
operation='add',
replace_scope='attribute',
values=[{attribute=iscFederalClassifications, values=[topSecret]}]
)
```
[[Back to top]](#)

73
docs/tools/sdk/python/Reference/V2025/Models/EntitlementAttributeBulkUpdateQueryRequest.md Normal file
View File

@@ -0,0 +1,73 @@
---
id: v2025-entitlement-attribute-bulk-update-query-request
title: EntitlementAttributeBulkUpdateQueryRequest
pagination_label: EntitlementAttributeBulkUpdateQueryRequest
sidebar_label: EntitlementAttributeBulkUpdateQueryRequest
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'EntitlementAttributeBulkUpdateQueryRequest', 'V2025EntitlementAttributeBulkUpdateQueryRequest']
slug: /tools/sdk/python/v2025/models/entitlement-attribute-bulk-update-query-request
tags: ['SDK', 'Software Development Kit', 'EntitlementAttributeBulkUpdateQueryRequest', 'V2025EntitlementAttributeBulkUpdateQueryRequest']
---
# EntitlementAttributeBulkUpdateQueryRequest
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**query** | [**Search**](search) | | [optional]
**operation** | **Enum** [ 'ADD', 'REMOVE', 'REPLACE' ] | Operation to perform on the attributes in the bulk update request. | [optional]
**replace_scope** | **Enum** [ 'ALL', 'ATTRIBUTE' ] | The choice of update scope. | [optional]
**values** | [**[]RoleMetadataBulkUpdateByIdRequestValuesInner**](role-metadata-bulk-update-by-id-request-values-inner) | The metadata to be updated, including attribute and values. | [optional]
}
## Example
```python
from sailpoint.v2025.models.entitlement_attribute_bulk_update_query_request import EntitlementAttributeBulkUpdateQueryRequest
entitlement_attribute_bulk_update_query_request = EntitlementAttributeBulkUpdateQueryRequest(
query=sailpoint.v2025.models.search.Search(
indices = [identities],
query_type = 'SAILPOINT',
query_version = null,
query = sailpoint.v2025.models.query.Query(
fields = '[firstName,lastName,email]',
time_zone = 'America/Chicago',
inner_hit = sailpoint.v2025.models.inner_hit.InnerHit(
query = 'source.name:\"Active Directory\"',
type = 'access', ), ),
query_dsl = {match={name=john.doe}},
text_query = sailpoint.v2025.models.text_query.TextQuery(
terms = [The quick brown fox, 3141592, 7],
fields = [displayName, employeeNumber, roleCount],
match_any = False,
contains = True, ),
type_ahead_query = sailpoint.v2025.models.type_ahead_query.TypeAheadQuery(
query = 'Work',
field = 'source.name',
nested_type = 'access',
max_expansions = 10,
size = 100,
sort = 'desc',
sort_by_value = True, ),
include_nested = True,
query_result_filter = sailpoint.v2025.models.query_result_filter.QueryResultFilter(
includes = [name, displayName],
excludes = [stacktrace], ),
aggregation_type = 'DSL',
aggregations_version = null,
aggregations_dsl = {},
aggregations = null,
sort = [displayName, +id],
search_after = [John Doe, 2c91808375d8e80a0175e1f88a575221],
filters = {}, ),
operation='add',
replace_scope='attribute',
values=[{attribute=iscFederalClassifications, values=[topSecret]}]
)
```
[[Back to top]](#)

85
docs/tools/sdk/python/Reference/V2025/Models/GetHistoricalIdentityEvents200ResponseInner.md
View File

@@ -16,21 +16,22 @@ tags: ['SDK', 'Software Development Kit', 'GetHistoricalIdentityEvents200Respons
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_item** | [**AccessItemAssociatedAccessItem**](access-item-associated-access-item) | | [optional] **certification_id** | **str** | the id of the certification item | [required]
**identity_id** | **str** | the identity id | [optional] **certification_name** | **str** | the certification item name | [required]
**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]
**signed_date** | **str** | the date ceritification was signed | [optional] **signed_date** | **str** | the date ceritification was signed | [optional]
**certifiers** | [**[]CertifierResponse**](certifier-response) | this field is deprecated and may go away | [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] **reviewers** | [**[]CertifierResponse**](certifier-response) | The list of identities who review this certification | [optional]
**signer** | [**CertifierResponse**](certifier-response) | | [optional] **signer** | [**CertifierResponse**](certifier-response) | | [optional]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [optional] **event_type** | **str** | the event type | [optional]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [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]
**access_request** | [**AccessRequestResponse1**](access-request-response1) | | [required]
**account** | [**AccountStatusChangedAccount**](account-status-changed-account) | | [required]
**status_change** | [**AccountStatusChangedStatusChange**](account-status-changed-status-change) | | [required]
} }
## Example ## Example
@@ -39,27 +40,6 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner from sailpoint.v2025.models.get_historical_identity_events200_response_inner import GetHistoricalIdentityEvents200ResponseInner
get_historical_identity_events200_response_inner = 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.v2025.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.v2025.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
changes=[
{name=firstname, previousValue=adam, newValue=zampa}
],
access_request=sailpoint.v2025.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_id='2c91808a77ff216301782327a50f09bf',
certification_name='Cert name', certification_name='Cert name',
signed_date='2019-03-08T22:37:33.901Z', signed_date='2019-03-08T22:37:33.901Z',
@@ -68,17 +48,42 @@ reviewers=[{id=8a80828f643d484f01643e14202e206f, displayName=John Snow}],
signer=sailpoint.v2025.models.certifier_response.CertifierResponse( signer=sailpoint.v2025.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f', id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), display_name = 'John Snow', ),
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.v2025.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.v2025.models.certifier_response.CertifierResponse(
id = '8a80828f643d484f01643e14202e206f',
display_name = 'John Snow', ), ),
access_item_type='account',
attribute_changes=[
sailpoint.v2025.models.attribute_change.AttributeChange(
name = 'firstname',
previous_value = 'adam',
new_value = 'zampa', )
],
access_request=sailpoint.v2025.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}]}], ),
account=sailpoint.v2025.models.account_status_changed_account.AccountStatusChanged_account( account=sailpoint.v2025.models.account_status_changed_account.AccountStatusChanged_account(
id = '', id = '2c91808a77ff216301782327a50f09bf',
native_identity = '', native_identity = 'dr.arden.ogahn.d',
display_name = '', display_name = 'Adam Archer',
source_id = '', source_id = '8a80828f643d484f01643e14202e206f',
source_name = '', source_name = 'JDBC Entitlements Source',
entitlement_count = 56, entitlement_count = 2,
access_type = '', ), access_type = 'account', ),
status_change=sailpoint.v2025.models.account_status_changed_status_change.AccountStatusChanged_statusChange( status_change=sailpoint.v2025.models.account_status_changed_status_change.AccountStatusChanged_statusChange(
previous_status = 'enabled', previous_status = 'enabled',
new_status = 'enabled', ) new_status = 'disabled', )
) )
``` ```

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

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

38
docs/tools/sdk/python/Reference/V2025/Models/IdentityEntitlements.md Normal file
View File

@@ -0,0 +1,38 @@
---
id: v2025-identity-entitlements
title: IdentityEntitlements
pagination_label: IdentityEntitlements
sidebar_label: IdentityEntitlements
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'IdentityEntitlements', 'V2025IdentityEntitlements']
slug: /tools/sdk/python/v2025/models/identity-entitlements
tags: ['SDK', 'Software Development Kit', 'IdentityEntitlements', 'V2025IdentityEntitlements']
---
# IdentityEntitlements
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**object_ref** | [**TaggedObjectDto**](tagged-object-dto) | | [optional]
**tags** | **[]str** | Labels to be applied to object. | [optional]
}
## Example
```python
from sailpoint.v2025.models.identity_entitlements import IdentityEntitlements
identity_entitlements = IdentityEntitlements(
object_ref=sailpoint.v2025.models.tagged_object_dto.TaggedObjectDto(
type = 'IDENTITY',
id = '2c91808568c529c60168cca6f90c1313',
name = 'William Wilson', ),
tags=[BU_FINANCE, PCI]
)
```
[[Back to top]](#)

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

@@ -16,25 +16,24 @@ tags: ['SDK', 'Software Development Kit', 'ListIdentityAccessItems200ResponseInn
Name | Type | Description | Notes Name | Type | Description | Notes
------------ | ------------- | ------------- | ------------- ------------ | ------------- | ------------- | -------------
**access_type** | **str** | the access item type. role in this case | [optional]
**id** | **str** | the access item id | [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_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] **description** | **str** | the description for the role | [optional]
**display_name** | **str** | the role display name | [optional] **source_id** | **str** | the id of the source | [optional]
**entitlement_count** | **str** | the number of entitlements the account will create | [optional] **standalone** | **bool** | indicates whether the access profile is standalone | [required]
**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]
**privileged** | **bool** | indicates whether the entitlement is privileged | [required] **privileged** | **bool** | indicates whether the entitlement is privileged | [required]
**cloud_governed** | **bool** | indicates whether the entitlement is cloud governed | [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 ## Example
@@ -43,25 +42,24 @@ Name | Type | Description | Notes
from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.v2025.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner
list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner( list_identity_access_items200_response_inner = ListIdentityAccessItems200ResponseInner(
access_type='role',
id='2c918087763e69d901763e72e97f006f', id='2c918087763e69d901763e72e97f006f',
name='sample', access_type='app',
source_name='Source Name', display_name='Display Name',
source_id='2793o32dwd', source_name='appName',
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',
attribute='groups', attribute='groups',
value='Upward mobility access', value='Upward mobility access',
entitlement_type='entitlement', type='ENTITLEMENT',
description='Role - Workday/Citizenship access',
source_id='2793o32dwd',
standalone=False,
privileged=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/V2025/Models/ListIdentitySnapshotAccessItems200ResponseInner.md Normal file
View File

@@ -0,0 +1,67 @@
---
id: v2025-list-identity-snapshot-access-items200-response-inner
title: ListIdentitySnapshotAccessItems200ResponseInner
pagination_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_label: ListIdentitySnapshotAccessItems200ResponseInner
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2025ListIdentitySnapshotAccessItems200ResponseInner']
slug: /tools/sdk/python/v2025/models/list-identity-snapshot-access-items200-response-inner
tags: ['SDK', 'Software Development Kit', 'ListIdentitySnapshotAccessItems200ResponseInner', 'V2025ListIdentitySnapshotAccessItems200ResponseInner']
---
# 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.v2025.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/V2025/Models/MachineClassificationConfig.md
View File

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

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

@@ -0,0 +1,50 @@
---
id: v2025-machine-classification-criteria-level1
title: MachineClassificationCriteriaLevel1
pagination_label: MachineClassificationCriteriaLevel1
sidebar_label: MachineClassificationCriteriaLevel1
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel1', 'V2025MachineClassificationCriteriaLevel1']
slug: /tools/sdk/python/v2025/models/machine-classification-criteria-level1
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel1', 'V2025MachineClassificationCriteriaLevel1']
---
# 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.v2025.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.v2025.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/V2025/Models/MachineClassificationCriteriaLevel2.md Normal file
View File

@@ -0,0 +1,50 @@
---
id: v2025-machine-classification-criteria-level2
title: MachineClassificationCriteriaLevel2
pagination_label: MachineClassificationCriteriaLevel2
sidebar_label: MachineClassificationCriteriaLevel2
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel2', 'V2025MachineClassificationCriteriaLevel2']
slug: /tools/sdk/python/v2025/models/machine-classification-criteria-level2
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel2', 'V2025MachineClassificationCriteriaLevel2']
---
# 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.v2025.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.v2025.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/V2025/Models/MachineClassificationCriteriaLevel3.md Normal file
View File

@@ -0,0 +1,45 @@
---
id: v2025-machine-classification-criteria-level3
title: MachineClassificationCriteriaLevel3
pagination_label: MachineClassificationCriteriaLevel3
sidebar_label: MachineClassificationCriteriaLevel3
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaLevel3', 'V2025MachineClassificationCriteriaLevel3']
slug: /tools/sdk/python/v2025/models/machine-classification-criteria-level3
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaLevel3', 'V2025MachineClassificationCriteriaLevel3']
---
# 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.v2025.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/V2025/Models/MachineClassificationCriteriaOperation.md Normal file
View File

@@ -0,0 +1,33 @@
---
id: v2025-machine-classification-criteria-operation
title: MachineClassificationCriteriaOperation
pagination_label: MachineClassificationCriteriaOperation
sidebar_label: MachineClassificationCriteriaOperation
sidebar_class_name: pythonsdk
keywords: ['python', 'Python', 'sdk', 'MachineClassificationCriteriaOperation', 'V2025MachineClassificationCriteriaOperation']
slug: /tools/sdk/python/v2025/models/machine-classification-criteria-operation
tags: ['SDK', 'Software Development Kit', 'MachineClassificationCriteriaOperation', 'V2025MachineClassificationCriteriaOperation']
---
# 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]](#)

17
static/code-examples/beta/python_code_examples_overlay.yaml
View File

@@ -63,13 +63,17 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
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: try:
# List access model metadata attributes # List access model metadata attributes
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute() results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute()
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute(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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -90,12 +94,15 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute.
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: try:
# List access model metadata values # List access model metadata values
results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key) results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key=key)
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
# results = AccessModelMetadataApi(api_client).list_access_model_metadata_attribute_value(key) # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -7034,7 +7041,7 @@
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) 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) 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: try:
# Lists all events for the given identity # List identity event history
results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id) results = IdentityHistoryApi(api_client).get_historical_identity_events(id=id)
# Below is a request that includes all optional parameters # Below is a request that includes all optional parameters
@@ -7197,7 +7204,7 @@
source: | source: |
from sailpoint.beta.api.identity_history_api import IdentityHistoryApi from sailpoint.beta.api.identity_history_api import IdentityHistoryApi
from sailpoint.beta.api_client import ApiClient from sailpoint.beta.api_client import ApiClient
from sailpoint.beta.models.list_identity_access_items200_response_inner import ListIdentityAccessItems200ResponseInner from sailpoint.beta.models.list_identity_snapshot_access_items200_response_inner import ListIdentitySnapshotAccessItems200ResponseInner
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()

166
static/code-examples/v2024/python_code_examples_overlay.yaml
View File

@@ -10,17 +10,15 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# Get access model metadata attribute # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -37,18 +35,16 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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. 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: try:
# Get access model metadata value # 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 # 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("The response of AccessModelMetadataApi->get_access_model_metadata_attribute_value:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -65,17 +61,19 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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: **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)
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) 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: try:
# List access model metadata attributes # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -93,17 +91,18 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
key = 'iscPrivacy' # str | Technical name of the Attribute. # str | Technical name of the Attribute. 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: try:
# List access model metadata values # 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 # 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") print("The response of AccessModelMetadataApi->list_access_model_metadata_attribute_value:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -6549,19 +6548,17 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Add metadata to an entitlement. # 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 # 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("The response of EntitlementsApi->create_access_model_metadata_for_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6577,19 +6574,17 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | The entitlement id. # str | The entitlement id. 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_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. 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: try:
# Remove metadata from an entitlement. # 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e) print("Exception when calling EntitlementsApi->delete_access_model_metadata_from_entitlement: %s\n" % e)
- path: /entitlements/{id} - path: /entitlements/{id}
@@ -6604,17 +6599,15 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | The entitlement ID # str | The entitlement ID 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: try:
# Get an entitlement # 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 # 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("The response of EntitlementsApi->get_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6631,17 +6624,15 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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: try:
# Get entitlement request config # 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 # 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("The response of EntitlementsApi->get_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6658,18 +6649,16 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Aggregate entitlements # 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 # 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("The response of EntitlementsApi->import_entitlements_by_source:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6686,11 +6675,9 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808874ff91550175097daaec161c' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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)
@@ -6699,9 +6686,9 @@
try: try:
# List of entitlements children # 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 # 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") print("The response of EntitlementsApi->list_entitlement_children:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -6719,11 +6706,9 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808c74ff913f0175097daa9d59cd' # str | Entitlement Id # str | Entitlement Id 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) 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) 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) 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)
@@ -6732,9 +6717,9 @@
try: try:
# List of entitlements parents # 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 # 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") print("The response of EntitlementsApi->list_entitlement_parents:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -6752,10 +6737,8 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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) 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) 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) 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)
@@ -6768,9 +6751,9 @@
try: try:
# Gets a list of entitlements. # 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 # 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") print("The response of EntitlementsApi->list_entitlements:\n")
for item in results: for item in results:
print(item.model_dump_json(by_alias=True, indent=4)) print(item.model_dump_json(by_alias=True, indent=4))
@@ -6789,18 +6772,16 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | ID of the entitlement to patch # str | ID of the entitlement to patch 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) json_patch_operation = '''[{op=replace, path=/requestable, value=true}, {op=replace, path=/privileged, value=true}]''' # List[JsonPatchOperation] | (optional)
try: try:
# Patch an entitlement # 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 # 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("The response of EntitlementsApi->patch_entitlement:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6817,11 +6798,9 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121e121518' # str | Entitlement ID # str | Entitlement ID 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 = '''{ entitlement_request_config = '''{
"accessRequestConfig" : { "accessRequestConfig" : {
"denialCommentRequired" : false, "denialCommentRequired" : false,
@@ -6848,9 +6827,9 @@
try: try:
# Replace entitlement request config # Replace entitlement request config
new_entitlement_request_config = EntitlementRequestConfig.from_json(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 # 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("The response of EntitlementsApi->put_entitlement_request_config:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6867,17 +6846,15 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = '2c91808a7813090a017814121919ecca' # str | ID of source for the entitlement reset # str | ID of source for the entitlement reset 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: try:
# Reset source entitlements # 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 # 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("The response of EntitlementsApi->reset_source_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:
@@ -6894,10 +6871,8 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: 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 = '''{ entitlement_bulk_update_request = '''{
"entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ], "entitlementIds" : [ "2c91808a7624751a01762f19d665220d", "2c91808a7624751a01762f19d67c220e", "2c91808a7624751a01762f19d692220f" ],
"jsonPatch" : [ { "jsonPatch" : [ {
@@ -6917,9 +6892,9 @@
try: try:
# Bulk update an entitlement list # Bulk update an entitlement list
new_entitlement_bulk_update_request = EntitlementBulkUpdateRequest.from_json(entitlement_bulk_update_request) 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 # 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: except Exception as e:
print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e) print("Exception when calling EntitlementsApi->update_entitlements_in_bulk: %s\n" % e)
- path: /auth-org/network-config - path: /auth-org/network-config
@@ -9736,7 +9711,7 @@
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) 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) 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: 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) 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 # Below is a request that includes all optional parameters
@@ -9906,7 +9881,7 @@
source: | source: |
from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi from sailpoint.v2024.api.identity_history_api import IdentityHistoryApi
from sailpoint.v2024.api_client import ApiClient 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 from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
@@ -11024,7 +10999,56 @@
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID. id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source ID. # str | Source ID.
machine_classification_config = '''{ 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", "created" : "2017-07-11T18:45:37.098Z",
"modified" : "2018-06-25T20:22:28.104Z", "modified" : "2018-06-25T20:22:28.104Z",
"classificationMethod" : "SOURCE", "classificationMethod" : "SOURCE",
@@ -18985,18 +19009,16 @@
from sailpoint.configuration import Configuration from sailpoint.configuration import Configuration
configuration = Configuration() configuration = Configuration()
configuration.experimental = True
with ApiClient(configuration) as api_client: with ApiClient(configuration) as api_client:
source_id = 'ef38f94347e94562b5bb8424a56397d8' # str | Source Id # str | Source Id 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) 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: try:
# Entitlement aggregation # 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 # 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("The response of SourcesApi->import_entitlements:\n")
print(results.model_dump_json(by_alias=True, indent=4)) print(results.model_dump_json(by_alias=True, indent=4))
except Exception as e: except Exception as e:

Some files were not shown because too many files have changed in this diff Show More