mirror of
https://github.com/LukeHagar/developer.sailpoint.com.git
synced 2025-12-08 20:37:46 +00:00
Update python SDK docs: 15116515953
This commit is contained in:
developer-relations-sp
@@ -72,60 +72,60 @@ All URIs are relative to *https://sailpoint.api.identitynow.com/v2024*
|
||||
|
||||
Method | HTTP request | Description
|
||||
------------- | ------------- | -------------
|
||||
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create Provisioning Policy
|
||||
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in IdentityNow.
|
||||
[**create-source-schedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create Schedule on Source
|
||||
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create Schema on Source
|
||||
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove All Accounts in a Source
|
||||
[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete Native Change Detection Configuration
|
||||
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete Provisioning Policy by UsageType
|
||||
[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete Source by ID
|
||||
[**delete-source-schedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete Source Schedule by type.
|
||||
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete Source Schema by ID
|
||||
[**create-provisioning-policy**](#create-provisioning-policy) | **POST** `/sources/{sourceId}/provisioning-policies` | Create provisioning policy
|
||||
[**create-source**](#create-source) | **POST** `/sources` | Creates a source in identitynow.
|
||||
[**create-source-schedule**](#create-source-schedule) | **POST** `/sources/{sourceId}/schedules` | Create schedule on source
|
||||
[**create-source-schema**](#create-source-schema) | **POST** `/sources/{sourceId}/schemas` | Create schema on source
|
||||
[**delete-accounts-async**](#delete-accounts-async) | **POST** `/sources/{id}/remove-accounts` | Remove all accounts in a source
|
||||
[**delete-native-change-detection-config**](#delete-native-change-detection-config) | **DELETE** `/sources/{sourceId}/native-change-detection-config` | Delete native change detection configuration
|
||||
[**delete-provisioning-policy**](#delete-provisioning-policy) | **DELETE** `/sources/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
|
||||
[**delete-source**](#delete-source) | **DELETE** `/sources/{id}` | Delete source by id
|
||||
[**delete-source-schedule**](#delete-source-schedule) | **DELETE** `/sources/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type.
|
||||
[**delete-source-schema**](#delete-source-schema) | **DELETE** `/sources/{sourceId}/schemas/{schemaId}` | Delete source schema by id
|
||||
[**get-accounts-schema**](#get-accounts-schema) | **GET** `/sources/{id}/schemas/accounts` | Downloads source accounts schema template
|
||||
[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get Source Correlation Configuration
|
||||
[**get-correlation-config**](#get-correlation-config) | **GET** `/sources/{id}/correlation-config` | Get source correlation configuration
|
||||
[**get-entitlements-schema**](#get-entitlements-schema) | **GET** `/sources/{id}/schemas/entitlements` | Downloads source entitlements schema template
|
||||
[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native Change Detection Configuration
|
||||
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get Provisioning Policy by UsageType
|
||||
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get Source by ID
|
||||
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute Sync Config
|
||||
[**get-native-change-detection-config**](#get-native-change-detection-config) | **GET** `/sources/{sourceId}/native-change-detection-config` | Native change detection configuration
|
||||
[**get-provisioning-policy**](#get-provisioning-policy) | **GET** `/sources/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
|
||||
[**get-source**](#get-source) | **GET** `/sources/{id}` | Get source by id
|
||||
[**get-source-attr-sync-config**](#get-source-attr-sync-config) | **GET** `/sources/{id}/attribute-sync-config` | Attribute sync config
|
||||
[**get-source-config**](#get-source-config) | **GET** `/sources/{id}/connectors/source-config` | Gets source config with language-translations
|
||||
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get Source Connections by ID
|
||||
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get Source Entitlement Request Configuration
|
||||
[**get-source-connections**](#get-source-connections) | **GET** `/sources/{sourceId}/connections` | Get source connections by id
|
||||
[**get-source-entitlement-request-config**](#get-source-entitlement-request-config) | **GET** `/sources/{id}/entitlement-request-config` | Get source entitlement request configuration
|
||||
[**get-source-health**](#get-source-health) | **GET** `/sources/{sourceId}/source-health` | Fetches source health by id
|
||||
[**get-source-schedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get Source Schedule by Type
|
||||
[**get-source-schedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List Schedules on Source
|
||||
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get Source Schema by ID
|
||||
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List Schemas on Source
|
||||
[**import-accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account Aggregation
|
||||
[**get-source-schedule**](#get-source-schedule) | **GET** `/sources/{sourceId}/schedules/{scheduleType}` | Get source schedule by type
|
||||
[**get-source-schedules**](#get-source-schedules) | **GET** `/sources/{sourceId}/schedules` | List schedules on source
|
||||
[**get-source-schema**](#get-source-schema) | **GET** `/sources/{sourceId}/schemas/{schemaId}` | Get source schema by id
|
||||
[**get-source-schemas**](#get-source-schemas) | **GET** `/sources/{sourceId}/schemas` | List schemas on source
|
||||
[**import-accounts**](#import-accounts) | **POST** `/sources/{id}/load-accounts` | Account aggregation
|
||||
[**import-accounts-schema**](#import-accounts-schema) | **POST** `/sources/{id}/schemas/accounts` | Uploads source accounts schema template
|
||||
[**import-connector-file**](#import-connector-file) | **POST** `/sources/{sourceId}/upload-connector-file` | Upload connector file to source
|
||||
[**import-entitlements-schema**](#import-entitlements-schema) | **POST** `/sources/{id}/schemas/entitlements` | Uploads source entitlements schema template
|
||||
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process Uncorrelated Accounts
|
||||
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists ProvisioningPolicies
|
||||
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in IdentityNow.
|
||||
[**import-uncorrelated-accounts**](#import-uncorrelated-accounts) | **POST** `/sources/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
|
||||
[**list-provisioning-policies**](#list-provisioning-policies) | **GET** `/sources/{sourceId}/provisioning-policies` | Lists provisioningpolicies
|
||||
[**list-sources**](#list-sources) | **GET** `/sources` | Lists all sources in identitynow.
|
||||
[**ping-cluster**](#ping-cluster) | **POST** `/sources/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
|
||||
[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update Source Correlation Configuration
|
||||
[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update Native Change Detection Configuration
|
||||
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update Provisioning Policy by UsageType
|
||||
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update Source (Full)
|
||||
[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update Attribute Sync Config
|
||||
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Full)
|
||||
[**put-correlation-config**](#put-correlation-config) | **PUT** `/sources/{id}/correlation-config` | Update source correlation configuration
|
||||
[**put-native-change-detection-config**](#put-native-change-detection-config) | **PUT** `/sources/{sourceId}/native-change-detection-config` | Update native change detection configuration
|
||||
[**put-provisioning-policy**](#put-provisioning-policy) | **PUT** `/sources/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
|
||||
[**put-source**](#put-source) | **PUT** `/sources/{id}` | Update source (full)
|
||||
[**put-source-attr-sync-config**](#put-source-attr-sync-config) | **PUT** `/sources/{id}/attribute-sync-config` | Update attribute sync config
|
||||
[**put-source-schema**](#put-source-schema) | **PUT** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (full)
|
||||
[**search-resource-objects**](#search-resource-objects) | **POST** `/sources/{sourceId}/connector/peek-resource-objects` | Peek source connector's resource objects
|
||||
[**sync-attributes-for-source**](#sync-attributes-for-source) | **POST** `/sources/{id}/synchronize-attributes` | Synchronize single source attributes.
|
||||
[**test-source-configuration**](#test-source-configuration) | **POST** `/sources/{sourceId}/connector/test-configuration` | Test configuration for source connector
|
||||
[**test-source-connection**](#test-source-connection) | **POST** `/sources/{sourceId}/connector/check-connection` | Check connection for source connector.
|
||||
[**update-password-policy-holders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update Password Policy
|
||||
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk Update Provisioning Policies
|
||||
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of Provisioning Policy
|
||||
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update Source (Partial)
|
||||
[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update Source Entitlement Request Configuration
|
||||
[**update-source-schedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update Source Schedule (Partial)
|
||||
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update Source Schema (Partial)
|
||||
[**update-password-policy-holders**](#update-password-policy-holders) | **PATCH** `/sources/{sourceId}/password-policies` | Update password policy
|
||||
[**update-provisioning-policies-in-bulk**](#update-provisioning-policies-in-bulk) | **POST** `/sources/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
|
||||
[**update-provisioning-policy**](#update-provisioning-policy) | **PATCH** `/sources/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
|
||||
[**update-source**](#update-source) | **PATCH** `/sources/{id}` | Update source (partial)
|
||||
[**update-source-entitlement-request-config**](#update-source-entitlement-request-config) | **PUT** `/sources/{id}/entitlement-request-config` | Update source entitlement request configuration
|
||||
[**update-source-schedule**](#update-source-schedule) | **PATCH** `/sources/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial)
|
||||
[**update-source-schema**](#update-source-schema) | **PATCH** `/sources/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
|
||||
|
||||
|
||||
## create-provisioning-policy
|
||||
Create Provisioning Policy
|
||||
Create provisioning policy
|
||||
This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types.
|
||||
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
||||
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
||||
@@ -211,7 +211,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # ProvisioningPolicyDto |
|
||||
|
||||
try:
|
||||
# Create Provisioning Policy
|
||||
# Create provisioning policy
|
||||
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
|
||||
results = SourcesApi(api_client).create_provisioning_policy(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -227,7 +227,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-source
|
||||
Creates a source in IdentityNow.
|
||||
Creates a source in identitynow.
|
||||
This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/create-source)
|
||||
@@ -353,7 +353,7 @@ with ApiClient(configuration) as api_client:
|
||||
provision_as_csv = false # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional) # bool | If this parameter is `true`, it configures the source as a Delimited File (CSV) source. Setting this to `true` will automatically set the `type` of the source to `DelimitedFile`. You must use this query parameter to create a Delimited File source as you would in the UI. If you don't set this query parameter and you attempt to set the `type` attribute directly, the request won't correctly generate the source. (optional)
|
||||
|
||||
try:
|
||||
# Creates a source in IdentityNow.
|
||||
# Creates a source in identitynow.
|
||||
new_source = Source.from_json(source)
|
||||
results = SourcesApi(api_client).create_source(source=new_source)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -369,7 +369,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-source-schedule
|
||||
Create Schedule on Source
|
||||
Create schedule on source
|
||||
Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
||||
|
||||
|
||||
@@ -414,7 +414,7 @@ with ApiClient(configuration) as api_client:
|
||||
schedule1 = '''sailpoint.v2024.Schedule1()''' # Schedule1 |
|
||||
|
||||
try:
|
||||
# Create Schedule on Source
|
||||
# Create schedule on source
|
||||
new_schedule1 = Schedule1.from_json(schedule1)
|
||||
results = SourcesApi(api_client).create_source_schedule(source_id=source_id, schedule1=new_schedule1)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -430,7 +430,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## create-source-schema
|
||||
Create Schema on Source
|
||||
Create schema on source
|
||||
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
|
||||
|
||||
|
||||
@@ -475,7 +475,7 @@ with ApiClient(configuration) as api_client:
|
||||
model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema |
|
||||
|
||||
try:
|
||||
# Create Schema on Source
|
||||
# Create schema on source
|
||||
new_model_schema = ModelSchema.from_json(model_schema)
|
||||
results = SourcesApi(api_client).create_source_schema(source_id=source_id, model_schema=new_model_schema)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -502,7 +502,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Remove All Accounts in a Source
|
||||
Remove all accounts in a source
|
||||
Use this endpoint to remove all accounts from the system without provisioning changes to the source. Accounts that are removed could be re-created during the next aggregation.
|
||||
|
||||
This endpoint is good for:
|
||||
@@ -553,7 +553,7 @@ 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')
|
||||
|
||||
try:
|
||||
# Remove All Accounts in a Source
|
||||
# Remove all accounts in a source
|
||||
|
||||
results = SourcesApi(api_client).delete_accounts_async(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -580,7 +580,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Delete Native Change Detection Configuration
|
||||
Delete native change detection configuration
|
||||
Deletes the native change detection configuration for the source specified by the given ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-native-change-detection-config)
|
||||
@@ -625,7 +625,7 @@ 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')
|
||||
|
||||
try:
|
||||
# Delete Native Change Detection Configuration
|
||||
# Delete native change detection configuration
|
||||
|
||||
SourcesApi(api_client).delete_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -639,7 +639,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-provisioning-policy
|
||||
Delete Provisioning Policy by UsageType
|
||||
Delete provisioning policy by usagetype
|
||||
Deletes the provisioning policy with the specified usage on an application.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-provisioning-policy)
|
||||
@@ -684,7 +684,7 @@ with ApiClient(configuration) as api_client:
|
||||
usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
||||
|
||||
try:
|
||||
# Delete Provisioning Policy by UsageType
|
||||
# Delete provisioning policy by usagetype
|
||||
|
||||
SourcesApi(api_client).delete_provisioning_policy(source_id=source_id, usage_type=usage_type)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -698,7 +698,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-source
|
||||
Delete Source by ID
|
||||
Delete source by id
|
||||
Use this API to delete a specific source in Identity Security Cloud (ISC).
|
||||
The API removes all the accounts on the source first, and then it deletes the source. You can retrieve the actual task execution status with this method: GET `/task-status/{id}`
|
||||
|
||||
@@ -742,7 +742,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# Delete Source by ID
|
||||
# Delete source by id
|
||||
|
||||
results = SourcesApi(api_client).delete_source(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -758,7 +758,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-source-schedule
|
||||
Delete Source Schedule by type.
|
||||
Delete source schedule by type.
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schedule)
|
||||
@@ -802,7 +802,7 @@ with ApiClient(configuration) as api_client:
|
||||
schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type.
|
||||
|
||||
try:
|
||||
# Delete Source Schedule by type.
|
||||
# Delete source schedule by type.
|
||||
|
||||
SourcesApi(api_client).delete_source_schedule(source_id=source_id, schedule_type=schedule_type)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -816,7 +816,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## delete-source-schema
|
||||
Delete Source Schema by ID
|
||||
Delete source schema by id
|
||||
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/delete-source-schema)
|
||||
@@ -860,7 +860,7 @@ with ApiClient(configuration) as api_client:
|
||||
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
|
||||
|
||||
try:
|
||||
# Delete Source Schema by ID
|
||||
# Delete source schema by id
|
||||
|
||||
SourcesApi(api_client).delete_source_schema(source_id=source_id, schema_id=schema_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -931,7 +931,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-correlation-config
|
||||
Get Source Correlation Configuration
|
||||
Get source correlation configuration
|
||||
This API returns the existing correlation configuration for a source specified by the given ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-correlation-config)
|
||||
@@ -974,7 +974,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c9180835d191a86015d28455b4a2329' # str | The source id # str | The source id
|
||||
|
||||
try:
|
||||
# Get Source Correlation Configuration
|
||||
# Get source correlation configuration
|
||||
|
||||
results = SourcesApi(api_client).get_correlation_config(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1061,7 +1061,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Native Change Detection Configuration
|
||||
Native change detection configuration
|
||||
This API returns the existing native change detection configuration for a source specified by the given ID.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-native-change-detection-config)
|
||||
@@ -1107,7 +1107,7 @@ 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')
|
||||
|
||||
try:
|
||||
# Native Change Detection Configuration
|
||||
# Native change detection configuration
|
||||
|
||||
results = SourcesApi(api_client).get_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1123,7 +1123,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-provisioning-policy
|
||||
Get Provisioning Policy by UsageType
|
||||
Get provisioning policy by usagetype
|
||||
This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-provisioning-policy)
|
||||
@@ -1169,7 +1169,7 @@ with ApiClient(configuration) as api_client:
|
||||
usage_type = sailpoint.v2024.UsageType() # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs. # UsageType | The type of provisioning policy usage. In IdentityNow, a source can support various provisioning operations. For example, when a joiner is added to a source, this may trigger both CREATE and UPDATE provisioning operations. Each usage type is considered a provisioning policy. A source can have any number of these provisioning policies defined. These are the common usage types: CREATE - This usage type relates to 'Create Account Profile', the provisioning template for the account to be created. For example, this would be used for a joiner on a source. UPDATE - This usage type relates to 'Update Account Profile', the provisioning template for the 'Update' connector operations. For example, this would be used for an attribute sync on a source. ENABLE - This usage type relates to 'Enable Account Profile', the provisioning template for the account to be enabled. For example, this could be used for a joiner on a source once the joiner's account is created. DISABLE - This usage type relates to 'Disable Account Profile', the provisioning template for the account to be disabled. For example, this could be used when a leaver is removed temporarily from a source. You can use these four usage types for all your provisioning policy needs.
|
||||
|
||||
try:
|
||||
# Get Provisioning Policy by UsageType
|
||||
# Get provisioning policy by usagetype
|
||||
|
||||
results = SourcesApi(api_client).get_provisioning_policy(source_id=source_id, usage_type=usage_type)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1185,7 +1185,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source
|
||||
Get Source by ID
|
||||
Get source by id
|
||||
Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source)
|
||||
@@ -1228,7 +1228,7 @@ with ApiClient(configuration) as api_client:
|
||||
id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# Get Source by ID
|
||||
# Get source by id
|
||||
|
||||
results = SourcesApi(api_client).get_source(id=id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1255,7 +1255,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Attribute Sync Config
|
||||
Attribute sync config
|
||||
This API returns the existing attribute synchronization configuration for a source specified by the given ID. The response contains all attributes, regardless of whether they enabled or not.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-attr-sync-config)
|
||||
@@ -1301,7 +1301,7 @@ 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')
|
||||
|
||||
try:
|
||||
# Attribute Sync Config
|
||||
# Attribute sync config
|
||||
|
||||
results = SourcesApi(api_client).get_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1378,7 +1378,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-connections
|
||||
Get Source Connections by ID
|
||||
Get source connections by id
|
||||
Use this API to get all dependent Profiles, Attributes, Applications and Custom Transforms for a source by a specified ID in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-connections)
|
||||
@@ -1421,7 +1421,7 @@ with ApiClient(configuration) as api_client:
|
||||
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# Get Source Connections by ID
|
||||
# Get source connections by id
|
||||
|
||||
results = SourcesApi(api_client).get_source_connections(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1448,7 +1448,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Get Source Entitlement Request Configuration
|
||||
Get source entitlement request configuration
|
||||
This API gets the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.
|
||||
|
||||
Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.
|
||||
@@ -1495,7 +1495,7 @@ 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')
|
||||
|
||||
try:
|
||||
# Get Source Entitlement Request Configuration
|
||||
# Get source entitlement request configuration
|
||||
|
||||
results = SourcesApi(api_client).get_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1570,7 +1570,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-schedule
|
||||
Get Source Schedule by Type
|
||||
Get source schedule by type
|
||||
Get the source schedule by type in Identity Security Cloud (ISC).
|
||||
|
||||
|
||||
@@ -1616,7 +1616,7 @@ with ApiClient(configuration) as api_client:
|
||||
schedule_type = 'ACCOUNT_AGGREGATION' # str | The Schedule type. # str | The Schedule type.
|
||||
|
||||
try:
|
||||
# Get Source Schedule by Type
|
||||
# Get source schedule by type
|
||||
|
||||
results = SourcesApi(api_client).get_source_schedule(source_id=source_id, schedule_type=schedule_type)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1632,7 +1632,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-schedules
|
||||
List Schedules on Source
|
||||
List schedules on source
|
||||
Use this API to list the schedules that exist on the specified source in Identity Security Cloud (ISC).
|
||||
:::info
|
||||
This endpoint uses a **cron expression** to schedule a task, following standard **cron job syntax**.
|
||||
@@ -1683,7 +1683,7 @@ with ApiClient(configuration) as api_client:
|
||||
source_id = '2c9180835d191a86015d28455b4a2329' # str | Source ID. # str | Source ID.
|
||||
|
||||
try:
|
||||
# List Schedules on Source
|
||||
# List schedules on source
|
||||
|
||||
results = SourcesApi(api_client).get_source_schedules(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1700,7 +1700,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-schema
|
||||
Get Source Schema by ID
|
||||
Get source schema by id
|
||||
Get the Source Schema by ID in IdentityNow.
|
||||
|
||||
|
||||
@@ -1746,7 +1746,7 @@ with ApiClient(configuration) as api_client:
|
||||
schema_id = '2c9180835d191a86015d28455b4a2329' # str | The Schema id. # str | The Schema id.
|
||||
|
||||
try:
|
||||
# Get Source Schema by ID
|
||||
# Get source schema by id
|
||||
|
||||
results = SourcesApi(api_client).get_source_schema(source_id=source_id, schema_id=schema_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1762,7 +1762,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## get-source-schemas
|
||||
List Schemas on Source
|
||||
List schemas on source
|
||||
Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC).
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/get-source-schemas)
|
||||
@@ -1809,7 +1809,7 @@ with ApiClient(configuration) as api_client:
|
||||
include_names = 'account' # str | A comma-separated list of schema names to filter result. (optional) # str | A comma-separated list of schema names to filter result. (optional)
|
||||
|
||||
try:
|
||||
# List Schemas on Source
|
||||
# List schemas on source
|
||||
|
||||
results = SourcesApi(api_client).get_source_schemas(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -1837,7 +1837,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Account Aggregation
|
||||
Account aggregation
|
||||
Starts an account 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.
|
||||
You will also need to set the Content-Type header to `multipart/form-data`.
|
||||
@@ -1888,7 +1888,7 @@ with ApiClient(configuration) as api_client:
|
||||
disable_optimization = 'disable_optimization_example' # str | Use this flag to reprocess every account whether or not the data has changed. (optional) # str | Use this flag to reprocess every account whether or not the data has changed. (optional)
|
||||
|
||||
try:
|
||||
# Account Aggregation
|
||||
# Account aggregation
|
||||
|
||||
results = SourcesApi(api_client).import_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2109,7 +2109,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Process Uncorrelated Accounts
|
||||
Process uncorrelated accounts
|
||||
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/import-uncorrelated-accounts)
|
||||
@@ -2156,7 +2156,7 @@ with ApiClient(configuration) as api_client:
|
||||
file = None # bytearray | (optional) # bytearray | (optional)
|
||||
|
||||
try:
|
||||
# Process Uncorrelated Accounts
|
||||
# Process uncorrelated accounts
|
||||
|
||||
results = SourcesApi(api_client).import_uncorrelated_accounts(id=id, x_sail_point_experimental=x_sail_point_experimental)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2172,7 +2172,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-provisioning-policies
|
||||
Lists ProvisioningPolicies
|
||||
Lists provisioningpolicies
|
||||
This end-point lists all the ProvisioningPolicies in IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-provisioning-policies)
|
||||
@@ -2215,7 +2215,7 @@ with ApiClient(configuration) as api_client:
|
||||
source_id = '2c9180835d191a86015d28455b4a2329' # str | The Source id # str | The Source id
|
||||
|
||||
try:
|
||||
# Lists ProvisioningPolicies
|
||||
# Lists provisioningpolicies
|
||||
|
||||
results = SourcesApi(api_client).list_provisioning_policies(source_id=source_id)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2232,7 +2232,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## list-sources
|
||||
Lists all sources in IdentityNow.
|
||||
Lists all sources in identitynow.
|
||||
This end-point lists all the sources in IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/list-sources)
|
||||
@@ -2287,7 +2287,7 @@ with ApiClient(configuration) as api_client:
|
||||
include_idn_source = False # bool | Include the IdentityNow source in the response. (optional) (default to False) # bool | Include the IdentityNow source in the response. (optional) (default to False)
|
||||
|
||||
try:
|
||||
# Lists all sources in IdentityNow.
|
||||
# Lists all sources in identitynow.
|
||||
|
||||
results = SourcesApi(api_client).list_sources()
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2363,7 +2363,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-correlation-config
|
||||
Update Source Correlation Configuration
|
||||
Update source correlation configuration
|
||||
Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-correlation-config)
|
||||
@@ -2428,7 +2428,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # CorrelationConfig |
|
||||
|
||||
try:
|
||||
# Update Source Correlation Configuration
|
||||
# Update source correlation configuration
|
||||
new_correlation_config = CorrelationConfig.from_json(correlation_config)
|
||||
results = SourcesApi(api_client).put_correlation_config(id=id, correlation_config=new_correlation_config)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2455,7 +2455,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Update Native Change Detection Configuration
|
||||
Update native change detection configuration
|
||||
Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/put-native-change-detection-config)
|
||||
@@ -2510,7 +2510,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # NativeChangeDetectionConfig |
|
||||
|
||||
try:
|
||||
# Update Native Change Detection Configuration
|
||||
# Update native change detection configuration
|
||||
new_native_change_detection_config = NativeChangeDetectionConfig.from_json(native_change_detection_config)
|
||||
results = SourcesApi(api_client).put_native_change_detection_config(id=id, x_sail_point_experimental=x_sail_point_experimental, native_change_detection_config=new_native_change_detection_config)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2526,7 +2526,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-provisioning-policy
|
||||
Update Provisioning Policy by UsageType
|
||||
Update provisioning policy by usagetype
|
||||
This end-point updates the provisioning policy with the specified usage on the specified source in IdentityNow.
|
||||
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
||||
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
||||
@@ -2615,7 +2615,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # ProvisioningPolicyDto |
|
||||
|
||||
try:
|
||||
# Update Provisioning Policy by UsageType
|
||||
# Update provisioning policy by usagetype
|
||||
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
|
||||
results = SourcesApi(api_client).put_provisioning_policy(source_id=source_id, usage_type=usage_type, provisioning_policy_dto=new_provisioning_policy_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2631,7 +2631,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-source
|
||||
Update Source (Full)
|
||||
Update source (full)
|
||||
Use this API to update a source in Identity Security Cloud (ISC), using a full object representation. This means that when you use this API, it completely replaces the existing source configuration.
|
||||
|
||||
These fields are immutable, so they cannot be changed:
|
||||
@@ -2770,7 +2770,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # Source |
|
||||
|
||||
try:
|
||||
# Update Source (Full)
|
||||
# Update source (full)
|
||||
new_source = Source.from_json(source)
|
||||
results = SourcesApi(api_client).put_source(id=id, source=new_source)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2797,7 +2797,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Update Attribute Sync Config
|
||||
Update attribute sync config
|
||||
Replaces the attribute synchronization configuration for the source specified by the given ID with the configuration provided in the request body. Only the "enabled" field of the values in the "attributes" array is mutable. Attempting to change other attributes or add new values to the "attributes" array will result in an error.
|
||||
|
||||
|
||||
@@ -2863,7 +2863,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # AttrSyncSourceConfig |
|
||||
|
||||
try:
|
||||
# Update Attribute Sync Config
|
||||
# Update attribute sync config
|
||||
new_attr_sync_source_config = AttrSyncSourceConfig.from_json(attr_sync_source_config)
|
||||
results = SourcesApi(api_client).put_source_attr_sync_config(id=id, x_sail_point_experimental=x_sail_point_experimental, attr_sync_source_config=new_attr_sync_source_config)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -2879,7 +2879,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## put-source-schema
|
||||
Update Source Schema (Full)
|
||||
Update source schema (full)
|
||||
This API will completely replace an existing Schema with the submitted payload. Some fields of the Schema cannot be updated. These fields are listed below.
|
||||
|
||||
* id
|
||||
@@ -2936,7 +2936,7 @@ with ApiClient(configuration) as api_client:
|
||||
model_schema = '''sailpoint.v2024.ModelSchema()''' # ModelSchema |
|
||||
|
||||
try:
|
||||
# Update Source Schema (Full)
|
||||
# Update source schema (full)
|
||||
new_model_schema = ModelSchema.from_json(model_schema)
|
||||
results = SourcesApi(api_client).put_source_schema(source_id=source_id, schema_id=schema_id, model_schema=new_model_schema)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3208,7 +3208,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-password-policy-holders
|
||||
Update Password Policy
|
||||
Update password policy
|
||||
This API can be used to set up or update Password Policy in IdentityNow for the specified Source.
|
||||
Source must support PASSWORD feature.
|
||||
|
||||
@@ -3255,7 +3255,7 @@ with ApiClient(configuration) as api_client:
|
||||
password_policy_holders_dto_inner = '''[sailpoint.v2024.PasswordPolicyHoldersDtoInner()]''' # List[PasswordPolicyHoldersDtoInner] |
|
||||
|
||||
try:
|
||||
# Update Password Policy
|
||||
# Update password policy
|
||||
new_password_policy_holders_dto_inner = PasswordPolicyHoldersDtoInner.from_json(password_policy_holders_dto_inner)
|
||||
results = SourcesApi(api_client).update_password_policy_holders(source_id=source_id, password_policy_holders_dto_inner=new_password_policy_holders_dto_inner)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3272,7 +3272,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-provisioning-policies-in-bulk
|
||||
Bulk Update Provisioning Policies
|
||||
Bulk update provisioning policies
|
||||
This end-point updates a list of provisioning policies on the specified source in IdentityNow.
|
||||
|
||||
[API Spec](https://developer.sailpoint.com/docs/api/v2024/update-provisioning-policies-in-bulk)
|
||||
@@ -3317,7 +3317,7 @@ with ApiClient(configuration) as api_client:
|
||||
provisioning_policy_dto = '''[sailpoint.v2024.ProvisioningPolicyDto()]''' # List[ProvisioningPolicyDto] |
|
||||
|
||||
try:
|
||||
# Bulk Update Provisioning Policies
|
||||
# Bulk update provisioning policies
|
||||
new_provisioning_policy_dto = ProvisioningPolicyDto.from_json(provisioning_policy_dto)
|
||||
results = SourcesApi(api_client).update_provisioning_policies_in_bulk(source_id=source_id, provisioning_policy_dto=new_provisioning_policy_dto)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3334,7 +3334,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-provisioning-policy
|
||||
Partial update of Provisioning Policy
|
||||
Partial update of provisioning policy
|
||||
This API selectively updates an existing Provisioning Policy using a JSONPatch payload.
|
||||
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
||||
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/idn/docs/transforms/guides/transforms-in-provisioning-policies) for more information.
|
||||
@@ -3385,7 +3385,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=add, path=/fields/0, value={name=email, transform={type=identityAttribute, attributes={name=email}}, attributes={}, isRequired=false, type=string, isMultiValued=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
|
||||
|
||||
try:
|
||||
# Partial update of Provisioning Policy
|
||||
# Partial update of provisioning policy
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = SourcesApi(api_client).update_provisioning_policy(source_id=source_id, usage_type=usage_type, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3401,7 +3401,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-source
|
||||
Update Source (Partial)
|
||||
Update source (partial)
|
||||
Use this API to partially update a source in Identity Security Cloud (ISC), using a list of patch operations according to the
|
||||
[JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
||||
|
||||
@@ -3462,7 +3462,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=replace, path=/description, value=new description}]''' # List[JsonPatchOperation] | A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Any password changes are submitted as plain-text and encrypted upon receipt in Identity Security Cloud (ISC).
|
||||
|
||||
try:
|
||||
# Update Source (Partial)
|
||||
# Update source (partial)
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = SourcesApi(api_client).update_source(id=id, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3489,7 +3489,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
||||
configuration.experimental = True
|
||||
```
|
||||
:::
|
||||
Update Source Entitlement Request Configuration
|
||||
Update source entitlement request configuration
|
||||
This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source.
|
||||
|
||||
Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined.
|
||||
@@ -3560,7 +3560,7 @@ with ApiClient(configuration) as api_client:
|
||||
}''' # SourceEntitlementRequestConfig |
|
||||
|
||||
try:
|
||||
# Update Source Entitlement Request Configuration
|
||||
# Update source entitlement request configuration
|
||||
new_source_entitlement_request_config = SourceEntitlementRequestConfig.from_json(source_entitlement_request_config)
|
||||
results = SourcesApi(api_client).update_source_entitlement_request_config(x_sail_point_experimental=x_sail_point_experimental, source_entitlement_request_config=new_source_entitlement_request_config)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3576,7 +3576,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-source-schedule
|
||||
Update Source Schedule (Partial)
|
||||
Update source schedule (partial)
|
||||
Use this API to selectively update an existing Schedule using a JSONPatch payload.
|
||||
|
||||
The following schedule fields are immutable and cannot be updated:
|
||||
@@ -3629,7 +3629,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=replace, path=/cronExpression, value=0 0 6 * * ?}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schedule.
|
||||
|
||||
try:
|
||||
# Update Source Schedule (Partial)
|
||||
# Update source schedule (partial)
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = SourcesApi(api_client).update_source_schedule(source_id=source_id, schedule_type=schedule_type, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
@@ -3645,7 +3645,7 @@ with ApiClient(configuration) as api_client:
|
||||
[[Back to top]](#)
|
||||
|
||||
## update-source-schema
|
||||
Update Source Schema (Partial)
|
||||
Update source schema (partial)
|
||||
Use this API to selectively update an existing Schema using a JSONPatch payload.
|
||||
|
||||
The following schema fields are immutable and cannot be updated:
|
||||
@@ -3722,7 +3722,7 @@ with ApiClient(configuration) as api_client:
|
||||
json_patch_operation = '''[{op=add, path=/attributes/-, value={name=location, type=STRING, schema=null, description=Employee location, isMulti=false, isEntitlement=false, isGroup=false}}]''' # List[JsonPatchOperation] | The JSONPatch payload used to update the schema.
|
||||
|
||||
try:
|
||||
# Update Source Schema (Partial)
|
||||
# Update source schema (partial)
|
||||
new_json_patch_operation = JsonPatchOperation.from_json(json_patch_operation)
|
||||
results = SourcesApi(api_client).update_source_schema(source_id=source_id, schema_id=schema_id, json_patch_operation=new_json_patch_operation)
|
||||
# Below is a request that includes all optional parameters
|
||||
|
||||
Reference in New Issue
Block a user