sailpoint-api-client 2.0.3 → 2.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/access_model_metadata/docs/Methods/AccessModelMetadataApi.md +11 -11
- package/access_profiles/docs/Methods/AccessProfilesApi.md +8 -8
- package/access_request_approvals/docs/Methods/AccessRequestApprovalsApi.md +7 -7
- package/access_request_identity_metrics/docs/Methods/AccessRequestIdentityMetricsApi.md +1 -1
- package/access_requests/docs/Methods/AccessRequestsApi.md +13 -13
- package/account_activities/docs/Methods/AccountActivitiesApi.md +2 -2
- package/account_aggregations/docs/Methods/AccountAggregationsApi.md +1 -1
- package/account_deletion_requests/docs/Methods/AccountDeletionRequestsApi.md +2 -2
- package/account_usages/docs/Methods/AccountUsagesApi.md +1 -1
- package/accounts/docs/Methods/AccountsApi.md +16 -16
- package/api_usage/docs/Methods/ApiUsageApi.md +2 -2
- package/application_discovery/docs/Methods/ApplicationDiscoveryApi.md +4 -4
- package/approvals/docs/Methods/ApprovalsApi.md +15 -15
- package/apps/docs/Methods/AppsApi.md +14 -14
- package/auth_profile/docs/Methods/AuthProfileApi.md +3 -3
- package/auth_users/docs/Methods/AuthUsersApi.md +2 -2
- package/branding/docs/Methods/BrandingApi.md +5 -5
- package/certification_campaign_filters/docs/Methods/CertificationCampaignFiltersApi.md +5 -5
- package/certification_campaigns/docs/Methods/CertificationCampaignsApi.md +22 -22
- package/certification_summaries/docs/Methods/CertificationSummariesApi.md +4 -4
- package/certifications/docs/Methods/CertificationsApi.md +11 -11
- package/classify_source/docs/Methods/ClassifySourceApi.md +3 -3
- package/configuration_hub/docs/Methods/ConfigurationHubApi.md +20 -20
- package/connector_customizers/docs/Methods/ConnectorCustomizersApi.md +6 -6
- package/connector_rule_management/docs/Methods/ConnectorRuleManagementApi.md +6 -6
- package/connectors/docs/Methods/ConnectorsApi.md +13 -13
- package/custom_forms/docs/Methods/CustomFormsApi.md +18 -18
- package/custom_password_instructions/docs/Methods/CustomPasswordInstructionsApi.md +3 -3
- package/custom_user_levels/docs/Methods/CustomUserLevelsApi.md +9 -9
- package/data_access_security/docs/Methods/DataAccessSecurityApi.md +25 -25
- package/data_segmentation/docs/Methods/DataSegmentationApi.md +8 -8
- package/declassify_source/docs/Methods/DeclassifySourceApi.md +1 -1
- package/dimensions/docs/Methods/DimensionsApi.md +8 -8
- package/dist/index.d.ts +3 -0
- package/dist/index.js +192 -189
- package/dist/index.js.map +1 -1
- package/dist/intelligence/api.d.ts +1042 -0
- package/dist/intelligence/api.js +595 -0
- package/dist/intelligence/api.js.map +1 -0
- package/dist/intelligence/base.d.ts +66 -0
- package/dist/intelligence/base.js +90 -0
- package/dist/intelligence/base.js.map +1 -0
- package/dist/intelligence/common.d.ts +65 -0
- package/dist/intelligence/common.js +292 -0
- package/dist/intelligence/common.js.map +1 -0
- package/dist/intelligence/configuration.d.ts +91 -0
- package/dist/intelligence/configuration.js +46 -0
- package/dist/intelligence/configuration.js.map +1 -0
- package/dist/intelligence/index.d.ts +13 -0
- package/dist/intelligence/index.js +32 -0
- package/dist/intelligence/index.js.map +1 -0
- package/dist/nerm/common.js +2 -2
- package/dist/nermv2025/common.js +2 -2
- package/dist/sources/api.d.ts +509 -1
- package/dist/sources/api.js +587 -4
- package/dist/sources/api.js.map +1 -1
- package/entitlement_connections/docs/Methods/EntitlementConnectionsApi.md +5 -5
- package/entitlements/docs/Methods/EntitlementsApi.md +13 -13
- package/global_tenant_security_settings/docs/Methods/GlobalTenantSecuritySettingsApi.md +9 -9
- package/governance_groups/docs/Methods/GovernanceGroupsApi.md +10 -10
- package/iai_access_request_recommendations/docs/Methods/IAIAccessRequestRecommendationsApi.md +10 -10
- package/iai_common_access/docs/Methods/IAICommonAccessApi.md +3 -3
- package/iai_outliers/docs/Methods/IAIOutliersApi.md +9 -9
- package/iai_peer_group_strategies/docs/Methods/IAIPeerGroupStrategiesApi.md +1 -1
- package/iai_recommendations/docs/Methods/IAIRecommendationsApi.md +3 -3
- package/iai_role_mining/docs/Methods/IAIRoleMiningApi.md +25 -25
- package/icons/docs/Methods/IconsApi.md +2 -2
- package/identities/docs/Methods/IdentitiesApi.md +12 -12
- package/identity_attributes/docs/Methods/IdentityAttributesApi.md +6 -6
- package/identity_history/docs/Methods/IdentityHistoryApi.md +11 -11
- package/identity_profiles/docs/Methods/IdentityProfilesApi.md +11 -11
- package/index.ts +3 -0
- package/intelligence/.openapi-generator/FILES +40 -0
- package/intelligence/.openapi-generator/VERSION +1 -0
- package/intelligence/.openapi-generator-ignore +23 -0
- package/intelligence/.sdk-partition +1 -0
- package/intelligence/api.ts +1316 -0
- package/intelligence/base.ts +86 -0
- package/intelligence/common.ts +183 -0
- package/intelligence/configuration.ts +110 -0
- package/intelligence/docs/Examples/typescript_code_examples_overlay.yaml +78 -0
- package/intelligence/docs/Methods/Index.md +30 -0
- package/intelligence/docs/Methods/IntelligenceApi.md +259 -0
- package/intelligence/docs/Models/Errorbody.md +20 -0
- package/intelligence/docs/Models/Errormessagedto.md +21 -0
- package/intelligence/docs/Models/Errorresponsedto.md +22 -0
- package/intelligence/docs/Models/GetIdentityIntelligenceV1401Response.md +19 -0
- package/intelligence/docs/Models/GetIdentityIntelligenceV1429Response.md +19 -0
- package/intelligence/docs/Models/Index.md +19 -0
- package/intelligence/docs/Models/Intelaccessaccountwire.md +30 -0
- package/intelligence/docs/Models/Intelaccesshistory.md +20 -0
- package/intelligence/docs/Models/Intelaccesshistoryaccessitemsslice.md +20 -0
- package/intelligence/docs/Models/Intelaccesshistorycertificationsslice.md +20 -0
- package/intelligence/docs/Models/Intelaccessitemhistoryevent.md +20 -0
- package/intelligence/docs/Models/Intelaccesssourcewire.md +20 -0
- package/intelligence/docs/Models/Intelaccountsslice.md +20 -0
- package/intelligence/docs/Models/Intelcertificationhistoryevent.md +23 -0
- package/intelligence/docs/Models/Intelidentityaggregate.md +35 -0
- package/intelligence/docs/Models/Intelidentityambiguousbody.md +21 -0
- package/intelligence/docs/Models/Intelidentityambiguouscandidate.md +20 -0
- package/intelligence/docs/Models/Intelidentitynotfoundbody.md +20 -0
- package/intelligence/docs/Models/Inteloutlieraccessitem.md +24 -0
- package/intelligence/docs/Models/Inteloutliersslice.md +19 -0
- package/intelligence/docs/Models/Intelprivilegedaccessitemwire.md +26 -0
- package/intelligence/docs/Models/IntelprivilegedaccessitemwireSource.md +20 -0
- package/intelligence/docs/Models/Intelprivilegedaccessslice.md +19 -0
- package/intelligence/docs/Models/Intelrareaccessslice.md +20 -0
- package/intelligence/docs/Models/Localeorigin.md +21 -0
- package/intelligence/docs/Models/README.md +46 -0
- package/intelligence/git_push.sh +57 -0
- package/intelligence/index.ts +18 -0
- package/intelligence/package.json +34 -0
- package/intelligence/tsconfig.json +21 -0
- package/jit_access/docs/Methods/JITAccessApi.md +2 -2
- package/jit_activations/docs/Methods/JITActivationsApi.md +3 -3
- package/launchers/docs/Methods/LaunchersApi.md +6 -6
- package/lifecycle_states/docs/Methods/LifecycleStatesApi.md +6 -6
- package/machine_account_classify/docs/Methods/MachineAccountClassifyApi.md +1 -1
- package/machine_account_creation_request/docs/Methods/MachineAccountCreationRequestApi.md +3 -3
- package/machine_account_mappings/docs/Methods/MachineAccountMappingsApi.md +4 -4
- package/machine_account_subtypes/docs/Methods/MachineAccountSubtypesApi.md +8 -8
- package/machine_accounts/docs/Methods/MachineAccountsApi.md +9 -9
- package/machine_classification_config/docs/Methods/MachineClassificationConfigApi.md +3 -3
- package/machine_identities/docs/Methods/MachineIdentitiesApi.md +7 -7
- package/managed_clients/docs/Methods/ManagedClientsApi.md +7 -7
- package/managed_cluster_types/docs/Methods/ManagedClusterTypesApi.md +5 -5
- package/managed_clusters/docs/Methods/ManagedClustersApi.md +8 -8
- package/mfa_configuration/docs/Methods/MFAConfigurationApi.md +7 -7
- package/multi_host_integration/docs/Methods/MultiHostIntegrationApi.md +14 -14
- package/nerm/README.md +2 -2
- package/nerm/common.ts +2 -2
- package/nerm/package.json +1 -1
- package/nermv2025/README.md +2 -2
- package/nermv2025/common.ts +2 -2
- package/nermv2025/package.json +1 -1
- package/non_employee_lifecycle_management/docs/Methods/NonEmployeeLifecycleManagementApi.md +32 -32
- package/notifications/docs/Methods/NotificationsApi.md +16 -16
- package/oauth_clients/docs/Methods/OAuthClientsApi.md +5 -5
- package/org_config/docs/Methods/OrgConfigApi.md +3 -3
- package/package.json +1 -1
- package/parameter_storage/docs/Methods/ParameterStorageApi.md +8 -8
- package/password_configuration/docs/Methods/PasswordConfigurationApi.md +3 -3
- package/password_dictionary/docs/Methods/PasswordDictionaryApi.md +2 -2
- package/password_management/docs/Methods/PasswordManagementApi.md +4 -4
- package/password_policies/docs/Methods/PasswordPoliciesApi.md +5 -5
- package/password_sync_groups/docs/Methods/PasswordSyncGroupsApi.md +5 -5
- package/personal_access_tokens/docs/Methods/PersonalAccessTokensApi.md +4 -4
- package/privilege_criteria/docs/Methods/PrivilegeCriteriaApi.md +5 -5
- package/privilege_criteria_configuration/docs/Methods/PrivilegeCriteriaConfigurationApi.md +3 -3
- package/prompt_insights/docs/Methods/PromptInsightsApi.md +2 -2
- package/public_identities/docs/Methods/PublicIdentitiesApi.md +1 -1
- package/public_identities_config/docs/Methods/PublicIdentitiesConfigApi.md +2 -2
- package/reports_data_extraction/docs/Methods/ReportsDataExtractionApi.md +4 -4
- package/requestable_objects/docs/Methods/RequestableObjectsApi.md +1 -1
- package/role_insights/docs/Methods/RoleInsightsApi.md +9 -9
- package/role_propagation/docs/Methods/RolePropagationApi.md +6 -6
- package/roles/docs/Methods/RolesApi.md +16 -16
- package/saved_search/docs/Methods/SavedSearchApi.md +6 -6
- package/scheduled_search/docs/Methods/ScheduledSearchApi.md +6 -6
- package/search/docs/Methods/SearchApi.md +4 -4
- package/search_attribute_configuration/docs/Methods/SearchAttributeConfigurationApi.md +5 -5
- package/segments/docs/Methods/SegmentsApi.md +5 -5
- package/service_desk_integration/docs/Methods/ServiceDeskIntegrationApi.md +10 -10
- package/shared_signals_framework_ssf/docs/Methods/SharedSignalsFrameworkSSFApi.md +10 -10
- package/sim_integrations/docs/Methods/SIMIntegrationsApi.md +7 -7
- package/sod_policies/docs/Methods/SODPoliciesApi.md +17 -17
- package/sod_violations/docs/Methods/SODViolationsApi.md +2 -2
- package/source_usages/docs/Methods/SourceUsagesApi.md +2 -2
- package/sources/.openapi-generator/FILES +2 -0
- package/sources/api.ts +846 -9
- package/sources/docs/Examples/typescript_code_examples_overlay.yaml +101 -0
- package/sources/docs/Methods/SourcesApi.md +344 -56
- package/sources/docs/Models/Fielddetailsdtov2.md +24 -0
- package/sources/docs/Models/Provisioningpolicydtov2.md +24 -0
- package/sources/docs/Models/Usagetype.md +2 -0
- package/sp_config/docs/Methods/SPConfigApi.md +7 -7
- package/suggested_entitlement_description/docs/Methods/SuggestedEntitlementDescriptionApi.md +15 -15
- package/tagged_objects/docs/Methods/TaggedObjectsApi.md +8 -8
- package/tags/docs/Methods/TagsApi.md +4 -4
- package/task_management/docs/Methods/TaskManagementApi.md +3 -3
- package/tenant/docs/Methods/TenantApi.md +1 -1
- package/tenant_context/docs/Methods/TenantContextApi.md +2 -2
- package/transforms/docs/Methods/TransformsApi.md +5 -5
- package/triggers/docs/Methods/TriggersApi.md +10 -10
- package/ui_metadata/docs/Methods/UIMetadataApi.md +2 -2
- package/work_items/docs/Methods/WorkItemsApi.md +13 -13
- package/work_reassignment/docs/Methods/WorkReassignmentApi.md +9 -9
- package/workflows/docs/Methods/WorkflowsApi.md +19 -19
|
@@ -73,12 +73,14 @@ All URIs are relative to *https://sailpoint.api.identitynow.com*
|
|
|
73
73
|
Method | HTTP request | Description
|
|
74
74
|
------------- | ------------- | -------------
|
|
75
75
|
[**create-provisioning-policy-v1**](#create-provisioning-policy-v1) | **POST** `/sources/v1/{sourceId}/provisioning-policies` | Create provisioning policy
|
|
76
|
+
[**create-provisioning-policy-v2**](#create-provisioning-policy-v2) | **POST** `/sources/v2/{sourceId}/provisioning-policies` | Create provisioning policy
|
|
76
77
|
[**create-source-schedule-v1**](#create-source-schedule-v1) | **POST** `/sources/v1/{sourceId}/schedules` | Create schedule on source
|
|
77
78
|
[**create-source-schema-v1**](#create-source-schema-v1) | **POST** `/sources/v1/{sourceId}/schemas` | Create schema on source
|
|
78
79
|
[**create-source-v1**](#create-source-v1) | **POST** `/sources/v1` | Creates a source in identitynow.
|
|
79
80
|
[**delete-accounts-async-v1**](#delete-accounts-async-v1) | **POST** `/sources/v1/{id}/remove-accounts` | Remove all accounts in source
|
|
80
81
|
[**delete-native-change-detection-config-v1**](#delete-native-change-detection-config-v1) | **DELETE** `/sources/v1/{sourceId}/native-change-detection-config` | Delete native change detection configuration
|
|
81
82
|
[**delete-provisioning-policy-v1**](#delete-provisioning-policy-v1) | **DELETE** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Delete provisioning policy by usagetype
|
|
83
|
+
[**delete-provisioning-policy-v2**](#delete-provisioning-policy-v2) | **DELETE** `/sources/v2/{sourceId}/provisioning-policies/{id}` | Delete provisioning policy by ID
|
|
82
84
|
[**delete-source-schedule-v1**](#delete-source-schedule-v1) | **DELETE** `/sources/v1/{sourceId}/schedules/{scheduleType}` | Delete source schedule by type.
|
|
83
85
|
[**delete-source-schema-v1**](#delete-source-schema-v1) | **DELETE** `/sources/v1/{sourceId}/schemas/{schemaId}` | Delete source schema by id
|
|
84
86
|
[**delete-source-v1**](#delete-source-v1) | **DELETE** `/sources/v1/{id}` | Delete source by id
|
|
@@ -89,6 +91,7 @@ Method | HTTP request | Description
|
|
|
89
91
|
[**get-machine-account-deletion-approval-config-by-source-v1**](#get-machine-account-deletion-approval-config-by-source-v1) | **GET** `/sources/v1/{sourceId}/approval-config/machine-account-delete` | Machine Account Deletion Approval Config
|
|
90
92
|
[**get-native-change-detection-config-v1**](#get-native-change-detection-config-v1) | **GET** `/sources/v1/{sourceId}/native-change-detection-config` | Native change detection configuration
|
|
91
93
|
[**get-provisioning-policy-v1**](#get-provisioning-policy-v1) | **GET** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Get provisioning policy by usagetype
|
|
94
|
+
[**get-provisioning-policy-v2**](#get-provisioning-policy-v2) | **GET** `/sources/v2/{sourceId}/provisioning-policies/{id}` | Get provisioning policy by ID
|
|
92
95
|
[**get-source-attr-sync-config-v1**](#get-source-attr-sync-config-v1) | **GET** `/sources/v1/{id}/attribute-sync-config` | Attribute sync config
|
|
93
96
|
[**get-source-config-v1**](#get-source-config-v1) | **GET** `/sources/v1/{id}/connectors/source-config` | Gets source config with language-translations
|
|
94
97
|
[**get-source-connections-v1**](#get-source-connections-v1) | **GET** `/sources/v1/{sourceId}/connections` | Get source connections by id
|
|
@@ -107,11 +110,13 @@ Method | HTTP request | Description
|
|
|
107
110
|
[**import-uncorrelated-accounts-v1**](#import-uncorrelated-accounts-v1) | **POST** `/sources/v1/{id}/load-uncorrelated-accounts` | Process uncorrelated accounts
|
|
108
111
|
[**list-password-policy-holders-on-source-v1**](#list-password-policy-holders-on-source-v1) | **GET** `/sources/v1/{sourceId}/password-policies` | Get Password Policy for source
|
|
109
112
|
[**list-provisioning-policies-v1**](#list-provisioning-policies-v1) | **GET** `/sources/v1/{sourceId}/provisioning-policies` | Lists provisioningpolicies
|
|
113
|
+
[**list-provisioning-policies-v2**](#list-provisioning-policies-v2) | **GET** `/sources/v2/{sourceId}/provisioning-policies` | Lists Provisioning Policies
|
|
110
114
|
[**list-sources-v1**](#list-sources-v1) | **GET** `/sources/v1` | Lists all sources in identitynow.
|
|
111
115
|
[**ping-cluster-v1**](#ping-cluster-v1) | **POST** `/sources/v1/{sourceId}/connector/ping-cluster` | Ping cluster for source connector
|
|
112
116
|
[**put-correlation-config-v1**](#put-correlation-config-v1) | **PUT** `/sources/v1/{id}/correlation-config` | Update source correlation configuration
|
|
113
117
|
[**put-native-change-detection-config-v1**](#put-native-change-detection-config-v1) | **PUT** `/sources/v1/{sourceId}/native-change-detection-config` | Update native change detection configuration
|
|
114
118
|
[**put-provisioning-policy-v1**](#put-provisioning-policy-v1) | **PUT** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Update provisioning policy by usagetype
|
|
119
|
+
[**put-provisioning-policy-v2**](#put-provisioning-policy-v2) | **PUT** `/sources/v2/{sourceId}/provisioning-policies/{id}` | Update provisioning policy by ID
|
|
115
120
|
[**put-source-attr-sync-config-v1**](#put-source-attr-sync-config-v1) | **PUT** `/sources/v1/{id}/attribute-sync-config` | Update attribute sync config
|
|
116
121
|
[**put-source-schema-v1**](#put-source-schema-v1) | **PUT** `/sources/v1/{sourceId}/schemas/{schemaId}` | Update source schema (full)
|
|
117
122
|
[**put-source-v1**](#put-source-v1) | **PUT** `/sources/v1/{id}` | Update source (full)
|
|
@@ -124,6 +129,7 @@ Method | HTTP request | Description
|
|
|
124
129
|
[**update-password-policy-holders-v1**](#update-password-policy-holders-v1) | **PATCH** `/sources/v1/{sourceId}/password-policies` | Update password policy
|
|
125
130
|
[**update-provisioning-policies-in-bulk-v1**](#update-provisioning-policies-in-bulk-v1) | **POST** `/sources/v1/{sourceId}/provisioning-policies/bulk-update` | Bulk update provisioning policies
|
|
126
131
|
[**update-provisioning-policy-v1**](#update-provisioning-policy-v1) | **PATCH** `/sources/v1/{sourceId}/provisioning-policies/{usageType}` | Partial update of provisioning policy
|
|
132
|
+
[**update-provisioning-policy-v2**](#update-provisioning-policy-v2) | **PATCH** `/sources/v2/{sourceId}/provisioning-policies/{id}` | Partial update of provisioning policy
|
|
127
133
|
[**update-source-entitlement-request-config-v1**](#update-source-entitlement-request-config-v1) | **PUT** `/sources/v1/{id}/entitlement-request-config` | Update source entitlement request configuration
|
|
128
134
|
[**update-source-schedule-v1**](#update-source-schedule-v1) | **PATCH** `/sources/v1/{sourceId}/schedules/{scheduleType}` | Update source schedule (partial)
|
|
129
135
|
[**update-source-schema-v1**](#update-source-schema-v1) | **PATCH** `/sources/v1/{sourceId}/schemas/{schemaId}` | Update source schema (partial)
|
|
@@ -136,7 +142,7 @@ This API generates a create policy/template based on field value transforms. Thi
|
|
|
136
142
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
137
143
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
138
144
|
|
|
139
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
145
|
+
[API Spec](https://developer.sailpoint.com/docs/api/create-provisioning-policy-v-1)
|
|
140
146
|
|
|
141
147
|
### Parameters
|
|
142
148
|
|
|
@@ -171,12 +177,62 @@ console.log(result);
|
|
|
171
177
|
|
|
172
178
|
[[Back to top]](#)
|
|
173
179
|
|
|
180
|
+
## create-provisioning-policy-v2
|
|
181
|
+
:::warning experimental
|
|
182
|
+
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.
|
|
183
|
+
:::
|
|
184
|
+
Create provisioning policy
|
|
185
|
+
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.
|
|
186
|
+
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
187
|
+
The V2 API allows you to use a unique identifier (id) for each provisioning policy instead of usageType. This enables read, update, and delete operations on policies using their id.
|
|
188
|
+
Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT.
|
|
189
|
+
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
190
|
+
|
|
191
|
+
[API Spec](https://developer.sailpoint.com/docs/api/create-provisioning-policy-v-2)
|
|
192
|
+
|
|
193
|
+
### Parameters
|
|
194
|
+
|
|
195
|
+
|
|
196
|
+
Name | Type | Description | Notes
|
|
197
|
+
------------- | ------------- | ------------- | -------------
|
|
198
|
+
**sourceId** | `string` | The Source id | [default to undefined]
|
|
199
|
+
**provisioningpolicydtov2** | `Provisioningpolicydtov2` | |
|
|
200
|
+
**useDefaultFields** | `boolean` | If passed as true, then it uses default fields from the connector template. | [optional] [default to false]
|
|
201
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
202
|
+
|
|
203
|
+
### Return type
|
|
204
|
+
|
|
205
|
+
`Provisioningpolicydtov2`
|
|
206
|
+
|
|
207
|
+
### HTTP request headers
|
|
208
|
+
|
|
209
|
+
- **Content-Type**: application/json
|
|
210
|
+
- **Accept**: application/json
|
|
211
|
+
|
|
212
|
+
### Example
|
|
213
|
+
|
|
214
|
+
```typescript
|
|
215
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
216
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
217
|
+
|
|
218
|
+
const configuration = new Configuration();
|
|
219
|
+
const apiInstance = new SourcesApi(configuration);
|
|
220
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id
|
|
221
|
+
const provisioningpolicydtov2: Provisioningpolicydtov2 = {"name":"Account","description":"Account Provisioning Policy","usageType":"CREATE","fields":[{"name":"displayName","transform":{"type":"identityAttribute","attributes":{"name":"displayName"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false},{"name":"distinguishedName","transform":{"type":"usernameGenerator","attributes":{"sourceCheck":true,"patterns":["CN=$fi $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fti $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn $ln,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com","CN=$fn$ln<uniqueCounter>,OU=zzUsers,OU=Demo,DC=seri,DC=sailpointdemo,DC=com"],"fn":{"type":"identityAttribute","attributes":{"name":"firstname"}},"ln":{"type":"identityAttribute","attributes":{"name":"lastname"}},"fi":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":1}},"fti":{"type":"substring","attributes":{"input":{"type":"identityAttribute","attributes":{"name":"firstname"}},"begin":0,"end":2}}}},"attributes":{"cloudMaxUniqueChecks":"5","cloudMaxSize":"100","cloudRequired":"true"},"isRequired":false,"type":"","isMultiValued":false},{"name":"description","transform":{"type":"static","attributes":{"value":""}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}]}; //
|
|
222
|
+
const useDefaultFields: boolean = false; // If passed as true, then it uses default fields from the connector template. (optional)
|
|
223
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
224
|
+
const result = await apiInstance.createProvisioningPolicyV2({ sourceId: sourceId, provisioningpolicydtov2: provisioningpolicydtov2 });
|
|
225
|
+
console.log(result);
|
|
226
|
+
```
|
|
227
|
+
|
|
228
|
+
[[Back to top]](#)
|
|
229
|
+
|
|
174
230
|
## create-source-schedule-v1
|
|
175
231
|
Create schedule on source
|
|
176
232
|
Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
|
177
233
|
|
|
178
234
|
|
|
179
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
235
|
+
[API Spec](https://developer.sailpoint.com/docs/api/create-source-schedule-v-1)
|
|
180
236
|
|
|
181
237
|
### Parameters
|
|
182
238
|
|
|
@@ -216,7 +272,7 @@ Create schema on source
|
|
|
216
272
|
Use this API to create a new schema on the specified source in Identity Security Cloud (ISC).
|
|
217
273
|
|
|
218
274
|
|
|
219
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
275
|
+
[API Spec](https://developer.sailpoint.com/docs/api/create-source-schema-v-1)
|
|
220
276
|
|
|
221
277
|
### Parameters
|
|
222
278
|
|
|
@@ -255,7 +311,7 @@ console.log(result);
|
|
|
255
311
|
Creates a source in identitynow.
|
|
256
312
|
This creates a specific source with a full source JSON representation. Any passwords are submitted as plain-text and encrypted upon receipt in IdentityNow.
|
|
257
313
|
|
|
258
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
314
|
+
[API Spec](https://developer.sailpoint.com/docs/api/create-source-v-1)
|
|
259
315
|
|
|
260
316
|
### Parameters
|
|
261
317
|
|
|
@@ -300,7 +356,7 @@ This endpoint is good for:
|
|
|
300
356
|
* Forcing accounts to be re-created following the next aggregation to re-run account processing, support testing, etc.
|
|
301
357
|
|
|
302
358
|
|
|
303
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
359
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-accounts-async-v-1)
|
|
304
360
|
|
|
305
361
|
### Parameters
|
|
306
362
|
|
|
@@ -337,7 +393,7 @@ console.log(result);
|
|
|
337
393
|
Delete native change detection configuration
|
|
338
394
|
Deletes the native change detection configuration for the source specified by the given ID.
|
|
339
395
|
|
|
340
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
396
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-native-change-detection-config-v-1)
|
|
341
397
|
|
|
342
398
|
### Parameters
|
|
343
399
|
|
|
@@ -374,7 +430,7 @@ console.log(result);
|
|
|
374
430
|
Delete provisioning policy by usagetype
|
|
375
431
|
Deletes the provisioning policy with the specified usage on an application.
|
|
376
432
|
|
|
377
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
433
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-provisioning-policy-v-1)
|
|
378
434
|
|
|
379
435
|
### Parameters
|
|
380
436
|
|
|
@@ -409,11 +465,55 @@ console.log(result);
|
|
|
409
465
|
|
|
410
466
|
[[Back to top]](#)
|
|
411
467
|
|
|
468
|
+
## delete-provisioning-policy-v2
|
|
469
|
+
:::warning experimental
|
|
470
|
+
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.
|
|
471
|
+
:::
|
|
472
|
+
Delete provisioning policy by ID
|
|
473
|
+
Deletes the provisioning policy with the specified ID on an application.
|
|
474
|
+
|
|
475
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-provisioning-policy-v-2)
|
|
476
|
+
|
|
477
|
+
### Parameters
|
|
478
|
+
|
|
479
|
+
|
|
480
|
+
Name | Type | Description | Notes
|
|
481
|
+
------------- | ------------- | ------------- | -------------
|
|
482
|
+
**sourceId** | `string` | The Source ID. | [default to undefined]
|
|
483
|
+
**id** | `string` | The provisioning policy ID. | [default to undefined]
|
|
484
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
485
|
+
|
|
486
|
+
### Return type
|
|
487
|
+
|
|
488
|
+
(empty response body)
|
|
489
|
+
|
|
490
|
+
### HTTP request headers
|
|
491
|
+
|
|
492
|
+
- **Content-Type**: Not defined
|
|
493
|
+
- **Accept**: application/json
|
|
494
|
+
|
|
495
|
+
### Example
|
|
496
|
+
|
|
497
|
+
```typescript
|
|
498
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
499
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
500
|
+
|
|
501
|
+
const configuration = new Configuration();
|
|
502
|
+
const apiInstance = new SourcesApi(configuration);
|
|
503
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
|
|
504
|
+
const id: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The provisioning policy ID.
|
|
505
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
506
|
+
const result = await apiInstance.deleteProvisioningPolicyV2({ sourceId: sourceId, id: id });
|
|
507
|
+
console.log(result);
|
|
508
|
+
```
|
|
509
|
+
|
|
510
|
+
[[Back to top]](#)
|
|
511
|
+
|
|
412
512
|
## delete-source-schedule-v1
|
|
413
513
|
Delete source schedule by type.
|
|
414
514
|
|
|
415
515
|
|
|
416
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
516
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-source-schedule-v-1)
|
|
417
517
|
|
|
418
518
|
### Parameters
|
|
419
519
|
|
|
@@ -452,7 +552,7 @@ console.log(result);
|
|
|
452
552
|
Delete source schema by id
|
|
453
553
|
|
|
454
554
|
|
|
455
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
555
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-source-schema-v-1)
|
|
456
556
|
|
|
457
557
|
### Parameters
|
|
458
558
|
|
|
@@ -492,7 +592,7 @@ Delete source by id
|
|
|
492
592
|
Use this API to delete a specific source in Identity Security Cloud (ISC).
|
|
493
593
|
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}`
|
|
494
594
|
|
|
495
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
595
|
+
[API Spec](https://developer.sailpoint.com/docs/api/delete-source-v-1)
|
|
496
596
|
|
|
497
597
|
### Parameters
|
|
498
598
|
|
|
@@ -530,7 +630,7 @@ Human Account Deletion Approval Config
|
|
|
530
630
|
The endpoint retrieves the approval configuration for deleting human accounts from a specified source. It returns details such as whether approval is required, who the approvers are, and any additional approval settings. This helps administrators understand and manage the approval workflow for human account deletions in their organization. The response is provided as an AccountDeleteConfigDto object.
|
|
531
631
|
|
|
532
632
|
|
|
533
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
633
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-account-delete-approval-config-v-1)
|
|
534
634
|
|
|
535
635
|
### Parameters
|
|
536
636
|
|
|
@@ -568,7 +668,7 @@ Downloads source accounts schema template
|
|
|
568
668
|
This API downloads the CSV schema that defines the account attributes on a source.
|
|
569
669
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
570
670
|
|
|
571
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
671
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-accounts-schema-v-1)
|
|
572
672
|
|
|
573
673
|
### Parameters
|
|
574
674
|
|
|
@@ -605,7 +705,7 @@ console.log(result);
|
|
|
605
705
|
Get source correlation configuration
|
|
606
706
|
This API returns the existing correlation configuration for a source specified by the given ID.
|
|
607
707
|
|
|
608
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
708
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-correlation-config-v-1)
|
|
609
709
|
|
|
610
710
|
### Parameters
|
|
611
711
|
|
|
@@ -644,7 +744,7 @@ This API downloads the CSV schema that defines the entitlement attributes on a s
|
|
|
644
744
|
|
|
645
745
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
646
746
|
|
|
647
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
747
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-entitlements-schema-v-1)
|
|
648
748
|
|
|
649
749
|
### Parameters
|
|
650
750
|
|
|
@@ -683,7 +783,7 @@ console.log(result);
|
|
|
683
783
|
Machine Account Deletion Approval Config
|
|
684
784
|
Retrieves the machine account deletion approval configuration for a specific source. This endpoint returns details about the approval requirements, approvers, and comment settings that govern the deletion of machine accounts associated with the given source ID.
|
|
685
785
|
|
|
686
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
786
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-machine-account-deletion-approval-config-by-source-v-1)
|
|
687
787
|
|
|
688
788
|
### Parameters
|
|
689
789
|
|
|
@@ -720,7 +820,7 @@ console.log(result);
|
|
|
720
820
|
Native change detection configuration
|
|
721
821
|
This API returns the existing native change detection configuration for a source specified by the given ID.
|
|
722
822
|
|
|
723
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
823
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-native-change-detection-config-v-1)
|
|
724
824
|
|
|
725
825
|
### Parameters
|
|
726
826
|
|
|
@@ -757,7 +857,7 @@ console.log(result);
|
|
|
757
857
|
Get provisioning policy by usagetype
|
|
758
858
|
This end-point retrieves the ProvisioningPolicy with the specified usage on the specified Source in IdentityNow.
|
|
759
859
|
|
|
760
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
860
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-provisioning-policy-v-1)
|
|
761
861
|
|
|
762
862
|
### Parameters
|
|
763
863
|
|
|
@@ -792,6 +892,50 @@ console.log(result);
|
|
|
792
892
|
|
|
793
893
|
[[Back to top]](#)
|
|
794
894
|
|
|
895
|
+
## get-provisioning-policy-v2
|
|
896
|
+
:::warning experimental
|
|
897
|
+
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.
|
|
898
|
+
:::
|
|
899
|
+
Get provisioning policy by ID
|
|
900
|
+
This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud.
|
|
901
|
+
|
|
902
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-provisioning-policy-v-2)
|
|
903
|
+
|
|
904
|
+
### Parameters
|
|
905
|
+
|
|
906
|
+
|
|
907
|
+
Name | Type | Description | Notes
|
|
908
|
+
------------- | ------------- | ------------- | -------------
|
|
909
|
+
**sourceId** | `string` | The Source ID. | [default to undefined]
|
|
910
|
+
**id** | `string` | The provisioning policy ID. | [default to undefined]
|
|
911
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
912
|
+
|
|
913
|
+
### Return type
|
|
914
|
+
|
|
915
|
+
`Provisioningpolicydtov2`
|
|
916
|
+
|
|
917
|
+
### HTTP request headers
|
|
918
|
+
|
|
919
|
+
- **Content-Type**: Not defined
|
|
920
|
+
- **Accept**: application/json
|
|
921
|
+
|
|
922
|
+
### Example
|
|
923
|
+
|
|
924
|
+
```typescript
|
|
925
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
926
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
927
|
+
|
|
928
|
+
const configuration = new Configuration();
|
|
929
|
+
const apiInstance = new SourcesApi(configuration);
|
|
930
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
|
|
931
|
+
const id: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The provisioning policy ID.
|
|
932
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
933
|
+
const result = await apiInstance.getProvisioningPolicyV2({ sourceId: sourceId, id: id });
|
|
934
|
+
console.log(result);
|
|
935
|
+
```
|
|
936
|
+
|
|
937
|
+
[[Back to top]](#)
|
|
938
|
+
|
|
795
939
|
## get-source-attr-sync-config-v1
|
|
796
940
|
:::warning experimental
|
|
797
941
|
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.
|
|
@@ -799,7 +943,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
|
|
799
943
|
Attribute sync config
|
|
800
944
|
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.
|
|
801
945
|
|
|
802
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
946
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-attr-sync-config-v-1)
|
|
803
947
|
|
|
804
948
|
### Parameters
|
|
805
949
|
|
|
@@ -838,7 +982,7 @@ console.log(result);
|
|
|
838
982
|
Gets source config with language-translations
|
|
839
983
|
Looks up and returns the source config for the requested source id after populating the source config values and applying language translations.
|
|
840
984
|
|
|
841
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
985
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-config-v-1)
|
|
842
986
|
|
|
843
987
|
### Parameters
|
|
844
988
|
|
|
@@ -877,7 +1021,7 @@ console.log(result);
|
|
|
877
1021
|
Get source connections by id
|
|
878
1022
|
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).
|
|
879
1023
|
|
|
880
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1024
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-connections-v-1)
|
|
881
1025
|
|
|
882
1026
|
### Parameters
|
|
883
1027
|
|
|
@@ -921,7 +1065,7 @@ Access request to any entitlements in the source should follow this configuratio
|
|
|
921
1065
|
- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.
|
|
922
1066
|
- However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
923
1067
|
|
|
924
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1068
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-entitlement-request-config-v-1)
|
|
925
1069
|
|
|
926
1070
|
### Parameters
|
|
927
1071
|
|
|
@@ -960,7 +1104,7 @@ console.log(result);
|
|
|
960
1104
|
Fetches source health by id
|
|
961
1105
|
This endpoint fetches source health by source's id
|
|
962
1106
|
|
|
963
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1107
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-health-v-1)
|
|
964
1108
|
|
|
965
1109
|
### Parameters
|
|
966
1110
|
|
|
@@ -998,7 +1142,7 @@ Get source schedule by type
|
|
|
998
1142
|
Get the source schedule by type in Identity Security Cloud (ISC).
|
|
999
1143
|
|
|
1000
1144
|
|
|
1001
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1145
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-schedule-v-1)
|
|
1002
1146
|
|
|
1003
1147
|
### Parameters
|
|
1004
1148
|
|
|
@@ -1045,7 +1189,7 @@ For example, `0 0 12 1/1 * ? *` runs the task **daily at 12:00 PM**.
|
|
|
1045
1189
|
:::
|
|
1046
1190
|
|
|
1047
1191
|
|
|
1048
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1192
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-schedules-v-1)
|
|
1049
1193
|
|
|
1050
1194
|
### Parameters
|
|
1051
1195
|
|
|
@@ -1083,7 +1227,7 @@ Get source schema by id
|
|
|
1083
1227
|
Get the Source Schema by ID in IdentityNow.
|
|
1084
1228
|
|
|
1085
1229
|
|
|
1086
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1230
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-schema-v-1)
|
|
1087
1231
|
|
|
1088
1232
|
### Parameters
|
|
1089
1233
|
|
|
@@ -1122,7 +1266,7 @@ console.log(result);
|
|
|
1122
1266
|
List schemas on source
|
|
1123
1267
|
Use this API to list the schemas that exist on the specified source in Identity Security Cloud (ISC).
|
|
1124
1268
|
|
|
1125
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1269
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-schemas-v-1)
|
|
1126
1270
|
|
|
1127
1271
|
### Parameters
|
|
1128
1272
|
|
|
@@ -1163,7 +1307,7 @@ console.log(result);
|
|
|
1163
1307
|
Get source by id
|
|
1164
1308
|
Use this API to get a source by a specified ID in Identity Security Cloud (ISC).
|
|
1165
1309
|
|
|
1166
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1310
|
+
[API Spec](https://developer.sailpoint.com/docs/api/get-source-v-1)
|
|
1167
1311
|
|
|
1168
1312
|
### Parameters
|
|
1169
1313
|
|
|
@@ -1206,7 +1350,7 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp
|
|
|
1206
1350
|
|
|
1207
1351
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
1208
1352
|
|
|
1209
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1353
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-accounts-schema-v-1)
|
|
1210
1354
|
|
|
1211
1355
|
### Parameters
|
|
1212
1356
|
|
|
@@ -1247,7 +1391,7 @@ Starts an account aggregation on the specified source.
|
|
|
1247
1391
|
If the target source is a delimited file source, then the CSV file needs to be included in the request body.
|
|
1248
1392
|
You will also need to set the Content-Type header to `multipart/form-data`.
|
|
1249
1393
|
|
|
1250
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1394
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-accounts-v-1)
|
|
1251
1395
|
|
|
1252
1396
|
### Parameters
|
|
1253
1397
|
|
|
@@ -1288,7 +1432,7 @@ console.log(result);
|
|
|
1288
1432
|
Upload connector file to source
|
|
1289
1433
|
This uploads a supplemental source connector file (like jdbc driver jars) to a source's S3 bucket. This also sends ETS and Audit events.
|
|
1290
1434
|
|
|
1291
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1435
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-connector-file-v-1)
|
|
1292
1436
|
|
|
1293
1437
|
### Parameters
|
|
1294
1438
|
|
|
@@ -1333,7 +1477,7 @@ Click **Admin** -> **Connections** -> **Sources** -> **`{SourceName}`** -> **Imp
|
|
|
1333
1477
|
|
|
1334
1478
|
>**NOTE: This API is designated only for Delimited File sources.**
|
|
1335
1479
|
|
|
1336
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1480
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-entitlements-schema-v-1)
|
|
1337
1481
|
|
|
1338
1482
|
### Parameters
|
|
1339
1483
|
|
|
@@ -1377,7 +1521,7 @@ If the target source is a delimited file source, then the CSV file needs to be i
|
|
|
1377
1521
|
You will also need to set the Content-Type header to `multipart/form-data`.
|
|
1378
1522
|
A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
1379
1523
|
|
|
1380
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1524
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-entitlements-v-1)
|
|
1381
1525
|
|
|
1382
1526
|
### Parameters
|
|
1383
1527
|
|
|
@@ -1416,7 +1560,7 @@ console.log(result);
|
|
|
1416
1560
|
Process uncorrelated accounts
|
|
1417
1561
|
File is required for upload. You will also need to set the Content-Type header to `multipart/form-data`
|
|
1418
1562
|
|
|
1419
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1563
|
+
[API Spec](https://developer.sailpoint.com/docs/api/import-uncorrelated-accounts-v-1)
|
|
1420
1564
|
|
|
1421
1565
|
### Parameters
|
|
1422
1566
|
|
|
@@ -1457,7 +1601,7 @@ This API can be used to get Password Policy in IdentityNow for the specified Sou
|
|
|
1457
1601
|
Source must support PASSWORD feature.
|
|
1458
1602
|
|
|
1459
1603
|
|
|
1460
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1604
|
+
[API Spec](https://developer.sailpoint.com/docs/api/list-password-policy-holders-on-source-v-1)
|
|
1461
1605
|
|
|
1462
1606
|
### Parameters
|
|
1463
1607
|
|
|
@@ -1500,7 +1644,7 @@ console.log(result);
|
|
|
1500
1644
|
Lists provisioningpolicies
|
|
1501
1645
|
This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
1502
1646
|
|
|
1503
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1647
|
+
[API Spec](https://developer.sailpoint.com/docs/api/list-provisioning-policies-v-1)
|
|
1504
1648
|
|
|
1505
1649
|
### Parameters
|
|
1506
1650
|
|
|
@@ -1537,11 +1681,59 @@ console.log(result);
|
|
|
1537
1681
|
|
|
1538
1682
|
[[Back to top]](#)
|
|
1539
1683
|
|
|
1684
|
+
## list-provisioning-policies-v2
|
|
1685
|
+
:::warning experimental
|
|
1686
|
+
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.
|
|
1687
|
+
:::
|
|
1688
|
+
Lists Provisioning Policies
|
|
1689
|
+
This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
1690
|
+
|
|
1691
|
+
[API Spec](https://developer.sailpoint.com/docs/api/list-provisioning-policies-v-2)
|
|
1692
|
+
|
|
1693
|
+
### Parameters
|
|
1694
|
+
|
|
1695
|
+
|
|
1696
|
+
Name | Type | Description | Notes
|
|
1697
|
+
------------- | ------------- | ------------- | -------------
|
|
1698
|
+
**sourceId** | `string` | The Source id | [default to undefined]
|
|
1699
|
+
**filters** | `string` | 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: **subtypeId**: *eq* **usageType**: *eq* | [optional] [default to undefined]
|
|
1700
|
+
**offset** | `number` | Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. | [optional] [default to 0]
|
|
1701
|
+
**limit** | `number` | Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. | [optional] [default to 250]
|
|
1702
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
1703
|
+
|
|
1704
|
+
### Return type
|
|
1705
|
+
|
|
1706
|
+
`Array<Provisioningpolicydtov2>`
|
|
1707
|
+
|
|
1708
|
+
### HTTP request headers
|
|
1709
|
+
|
|
1710
|
+
- **Content-Type**: Not defined
|
|
1711
|
+
- **Accept**: application/json
|
|
1712
|
+
|
|
1713
|
+
### Example
|
|
1714
|
+
|
|
1715
|
+
```typescript
|
|
1716
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
1717
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
1718
|
+
|
|
1719
|
+
const configuration = new Configuration();
|
|
1720
|
+
const apiInstance = new SourcesApi(configuration);
|
|
1721
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id
|
|
1722
|
+
const filters: string = subtypeId eq "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"; // 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: **subtypeId**: *eq* **usageType**: *eq* (optional)
|
|
1723
|
+
const offset: number = 0; // Offset Integer specifying the offset of the first result from the beginning of the collection. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). The offset value is record-based, not page-based, and the index starts at 0. (optional)
|
|
1724
|
+
const limit: number = 250; // Limit Integer specifying the maximum number of records to return in a single API call. The standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-results). If it is not specified, a default limit is used. (optional)
|
|
1725
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
1726
|
+
const result = await apiInstance.listProvisioningPoliciesV2({ sourceId: sourceId });
|
|
1727
|
+
console.log(result);
|
|
1728
|
+
```
|
|
1729
|
+
|
|
1730
|
+
[[Back to top]](#)
|
|
1731
|
+
|
|
1540
1732
|
## list-sources-v1
|
|
1541
1733
|
Lists all sources in identitynow.
|
|
1542
1734
|
This end-point lists all the sources in IdentityNow.
|
|
1543
1735
|
|
|
1544
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1736
|
+
[API Spec](https://developer.sailpoint.com/docs/api/list-sources-v-1)
|
|
1545
1737
|
|
|
1546
1738
|
### Parameters
|
|
1547
1739
|
|
|
@@ -1590,7 +1782,7 @@ console.log(result);
|
|
|
1590
1782
|
Ping cluster for source connector
|
|
1591
1783
|
This endpoint validates that the cluster being used by the source is reachable from IdentityNow.
|
|
1592
1784
|
|
|
1593
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1785
|
+
[API Spec](https://developer.sailpoint.com/docs/api/ping-cluster-v-1)
|
|
1594
1786
|
|
|
1595
1787
|
### Parameters
|
|
1596
1788
|
|
|
@@ -1627,7 +1819,7 @@ console.log(result);
|
|
|
1627
1819
|
Update source correlation configuration
|
|
1628
1820
|
Replaces the correlation configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
1629
1821
|
|
|
1630
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1822
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-correlation-config-v-1)
|
|
1631
1823
|
|
|
1632
1824
|
### Parameters
|
|
1633
1825
|
|
|
@@ -1666,7 +1858,7 @@ console.log(result);
|
|
|
1666
1858
|
Update native change detection configuration
|
|
1667
1859
|
Replaces the native change detection configuration for the source specified by the given ID with the configuration provided in the request body.
|
|
1668
1860
|
|
|
1669
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1861
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-native-change-detection-config-v-1)
|
|
1670
1862
|
|
|
1671
1863
|
### Parameters
|
|
1672
1864
|
|
|
@@ -1707,7 +1899,7 @@ This end-point updates the provisioning policy with the specified usage on the s
|
|
|
1707
1899
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
1708
1900
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
1709
1901
|
|
|
1710
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1902
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-provisioning-policy-v-1)
|
|
1711
1903
|
|
|
1712
1904
|
### Parameters
|
|
1713
1905
|
|
|
@@ -1744,6 +1936,54 @@ console.log(result);
|
|
|
1744
1936
|
|
|
1745
1937
|
[[Back to top]](#)
|
|
1746
1938
|
|
|
1939
|
+
## put-provisioning-policy-v2
|
|
1940
|
+
:::warning experimental
|
|
1941
|
+
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.
|
|
1942
|
+
:::
|
|
1943
|
+
Update provisioning policy by ID
|
|
1944
|
+
This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud.
|
|
1945
|
+
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
1946
|
+
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
1947
|
+
|
|
1948
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-provisioning-policy-v-2)
|
|
1949
|
+
|
|
1950
|
+
### Parameters
|
|
1951
|
+
|
|
1952
|
+
|
|
1953
|
+
Name | Type | Description | Notes
|
|
1954
|
+
------------- | ------------- | ------------- | -------------
|
|
1955
|
+
**sourceId** | `string` | The Source ID. | [default to undefined]
|
|
1956
|
+
**id** | `string` | The provisioning policy ID. | [default to undefined]
|
|
1957
|
+
**provisioningpolicydtov2** | `Provisioningpolicydtov2` | |
|
|
1958
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
1959
|
+
|
|
1960
|
+
### Return type
|
|
1961
|
+
|
|
1962
|
+
`Provisioningpolicydtov2`
|
|
1963
|
+
|
|
1964
|
+
### HTTP request headers
|
|
1965
|
+
|
|
1966
|
+
- **Content-Type**: application/json
|
|
1967
|
+
- **Accept**: application/json
|
|
1968
|
+
|
|
1969
|
+
### Example
|
|
1970
|
+
|
|
1971
|
+
```typescript
|
|
1972
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
1973
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
1974
|
+
|
|
1975
|
+
const configuration = new Configuration();
|
|
1976
|
+
const apiInstance = new SourcesApi(configuration);
|
|
1977
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source ID.
|
|
1978
|
+
const id: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The provisioning policy ID.
|
|
1979
|
+
const provisioningpolicydtov2: Provisioningpolicydtov2 = ; //
|
|
1980
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
1981
|
+
const result = await apiInstance.putProvisioningPolicyV2({ sourceId: sourceId, id: id, provisioningpolicydtov2: provisioningpolicydtov2 });
|
|
1982
|
+
console.log(result);
|
|
1983
|
+
```
|
|
1984
|
+
|
|
1985
|
+
[[Back to top]](#)
|
|
1986
|
+
|
|
1747
1987
|
## put-source-attr-sync-config-v1
|
|
1748
1988
|
:::warning experimental
|
|
1749
1989
|
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.
|
|
@@ -1752,7 +1992,7 @@ Update attribute sync config
|
|
|
1752
1992
|
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.
|
|
1753
1993
|
|
|
1754
1994
|
|
|
1755
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
1995
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-source-attr-sync-config-v-1)
|
|
1756
1996
|
|
|
1757
1997
|
### Parameters
|
|
1758
1998
|
|
|
@@ -1803,7 +2043,7 @@ Any attempt to modify these fields will result in an error response with a statu
|
|
|
1803
2043
|
> `id` must remain in the request body, but it cannot be changed. If `id` is omitted from the request body, the result will be a 400 error.
|
|
1804
2044
|
|
|
1805
2045
|
|
|
1806
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2046
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-source-schema-v-1)
|
|
1807
2047
|
|
|
1808
2048
|
### Parameters
|
|
1809
2049
|
|
|
@@ -1856,7 +2096,7 @@ These fields are immutable, so they cannot be changed:
|
|
|
1856
2096
|
Attempts to modify these fields will result in a 400 error.
|
|
1857
2097
|
|
|
1858
2098
|
|
|
1859
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2099
|
+
[API Spec](https://developer.sailpoint.com/docs/api/put-source-v-1)
|
|
1860
2100
|
|
|
1861
2101
|
### Parameters
|
|
1862
2102
|
|
|
@@ -1895,7 +2135,7 @@ console.log(result);
|
|
|
1895
2135
|
Peek source connector\'s resource objects
|
|
1896
2136
|
Retrieves a sample of data returned from account and group aggregation requests.
|
|
1897
2137
|
|
|
1898
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2138
|
+
[API Spec](https://developer.sailpoint.com/docs/api/search-resource-objects-v-1)
|
|
1899
2139
|
|
|
1900
2140
|
### Parameters
|
|
1901
2141
|
|
|
@@ -1937,7 +2177,7 @@ This API is currently in an experimental state. The API is subject to change bas
|
|
|
1937
2177
|
Synchronize single source attributes.
|
|
1938
2178
|
This end-point performs attribute synchronization for a selected source.
|
|
1939
2179
|
|
|
1940
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2180
|
+
[API Spec](https://developer.sailpoint.com/docs/api/sync-attributes-for-source-v-1)
|
|
1941
2181
|
|
|
1942
2182
|
### Parameters
|
|
1943
2183
|
|
|
@@ -1976,7 +2216,7 @@ console.log(result);
|
|
|
1976
2216
|
Test configuration for source connector
|
|
1977
2217
|
This endpoint performs a more detailed validation of the source''s configuration that can take longer than the lighter weight credential validation performed by the checkConnection API.
|
|
1978
2218
|
|
|
1979
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2219
|
+
[API Spec](https://developer.sailpoint.com/docs/api/test-source-configuration-v-1)
|
|
1980
2220
|
|
|
1981
2221
|
### Parameters
|
|
1982
2222
|
|
|
@@ -2013,7 +2253,7 @@ console.log(result);
|
|
|
2013
2253
|
Check connection for source connector.
|
|
2014
2254
|
This endpoint validates that the configured credentials are valid and will properly authenticate with the source identified by the sourceId path parameter.
|
|
2015
2255
|
|
|
2016
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2256
|
+
[API Spec](https://developer.sailpoint.com/docs/api/test-source-connection-v-1)
|
|
2017
2257
|
|
|
2018
2258
|
### Parameters
|
|
2019
2259
|
|
|
@@ -2051,7 +2291,7 @@ Human Account Deletion Approval Config
|
|
|
2051
2291
|
Updates the approval configuration for deleting human accounts for a specific source, identified by source ID. This endpoint allows administrators to modify settings such as whether approval is required, who the approvers are, and other approval-related options. The update is performed using a JSON Patch payload, and the response returns the updated AccountDeleteConfigDto object reflecting the new approval workflow configuration.
|
|
2052
2292
|
|
|
2053
2293
|
|
|
2054
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2294
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-account-deletion-approval-config-v-1)
|
|
2055
2295
|
|
|
2056
2296
|
### Parameters
|
|
2057
2297
|
|
|
@@ -2094,7 +2334,7 @@ This operation is typically used to change approval requirements, approvers, or
|
|
|
2094
2334
|
The endpoint expects the source ID as a path parameter and a valid JSON Patch array in the request body.
|
|
2095
2335
|
|
|
2096
2336
|
|
|
2097
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2337
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-machine-account-deletion-approval-config-v-1)
|
|
2098
2338
|
|
|
2099
2339
|
### Parameters
|
|
2100
2340
|
|
|
@@ -2135,7 +2375,7 @@ This API can be used to set up or update Password Policy in IdentityNow for the
|
|
|
2135
2375
|
Source must support PASSWORD feature.
|
|
2136
2376
|
|
|
2137
2377
|
|
|
2138
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2378
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-password-policy-holders-v-1)
|
|
2139
2379
|
|
|
2140
2380
|
### Parameters
|
|
2141
2381
|
|
|
@@ -2174,7 +2414,7 @@ console.log(result);
|
|
|
2174
2414
|
Bulk update provisioning policies
|
|
2175
2415
|
This end-point updates a list of provisioning policies on the specified source in IdentityNow.
|
|
2176
2416
|
|
|
2177
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2417
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-provisioning-policies-in-bulk-v-1)
|
|
2178
2418
|
|
|
2179
2419
|
### Parameters
|
|
2180
2420
|
|
|
@@ -2215,7 +2455,7 @@ This API selectively updates an existing Provisioning Policy using a JSONPatch p
|
|
|
2215
2455
|
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
2216
2456
|
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
2217
2457
|
|
|
2218
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2458
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-provisioning-policy-v-1)
|
|
2219
2459
|
|
|
2220
2460
|
### Parameters
|
|
2221
2461
|
|
|
@@ -2252,6 +2492,54 @@ console.log(result);
|
|
|
2252
2492
|
|
|
2253
2493
|
[[Back to top]](#)
|
|
2254
2494
|
|
|
2495
|
+
## update-provisioning-policy-v2
|
|
2496
|
+
:::warning experimental
|
|
2497
|
+
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.
|
|
2498
|
+
:::
|
|
2499
|
+
Partial update of provisioning policy
|
|
2500
|
+
This API selectively updates an existing Provisioning Policy using a JSONPatch payload.
|
|
2501
|
+
Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning.
|
|
2502
|
+
Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
2503
|
+
|
|
2504
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-provisioning-policy-v-2)
|
|
2505
|
+
|
|
2506
|
+
### Parameters
|
|
2507
|
+
|
|
2508
|
+
|
|
2509
|
+
Name | Type | Description | Notes
|
|
2510
|
+
------------- | ------------- | ------------- | -------------
|
|
2511
|
+
**sourceId** | `string` | The Source id. | [default to undefined]
|
|
2512
|
+
**id** | `string` | The provisioning policy ID. | [default to undefined]
|
|
2513
|
+
**jsonpatchoperation** | `Array<Jsonpatchoperation>` | The JSONPatch payload used to update the schema. |
|
|
2514
|
+
**xSailPointExperimental** | `string` | Use this header to enable this experimental API. | [optional] [default to 'true']
|
|
2515
|
+
|
|
2516
|
+
### Return type
|
|
2517
|
+
|
|
2518
|
+
`Provisioningpolicydtov2`
|
|
2519
|
+
|
|
2520
|
+
### HTTP request headers
|
|
2521
|
+
|
|
2522
|
+
- **Content-Type**: application/json-patch+json
|
|
2523
|
+
- **Accept**: application/json
|
|
2524
|
+
|
|
2525
|
+
### Example
|
|
2526
|
+
|
|
2527
|
+
```typescript
|
|
2528
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
2529
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
2530
|
+
|
|
2531
|
+
const configuration = new Configuration();
|
|
2532
|
+
const apiInstance = new SourcesApi(configuration);
|
|
2533
|
+
const sourceId: string = 2c9180835d191a86015d28455b4a2329; // The Source id.
|
|
2534
|
+
const id: string = f5dd23fe-3414-42b7-bb1c-869400ad7a10; // The provisioning policy ID.
|
|
2535
|
+
const jsonpatchoperation: Array<Jsonpatchoperation> = [{"op":"add","path":"/fields/0","value":{"name":"email","transform":{"type":"identityAttribute","attributes":{"name":"email"}},"attributes":{},"isRequired":false,"type":"string","isMultiValued":false}}]; // The JSONPatch payload used to update the schema.
|
|
2536
|
+
const xSailPointExperimental: string = true; // Use this header to enable this experimental API. (optional)
|
|
2537
|
+
const result = await apiInstance.updateProvisioningPolicyV2({ sourceId: sourceId, id: id, jsonpatchoperation: jsonpatchoperation });
|
|
2538
|
+
console.log(result);
|
|
2539
|
+
```
|
|
2540
|
+
|
|
2541
|
+
[[Back to top]](#)
|
|
2542
|
+
|
|
2255
2543
|
## update-source-entitlement-request-config-v1
|
|
2256
2544
|
:::warning experimental
|
|
2257
2545
|
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.
|
|
@@ -2263,7 +2551,7 @@ Access request to any entitlements in the source should follow this configuratio
|
|
|
2263
2551
|
- During access request, this source-level entitlement request configuration overrides the global organization-level configuration.
|
|
2264
2552
|
- However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
2265
2553
|
|
|
2266
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2554
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-source-entitlement-request-config-v-1)
|
|
2267
2555
|
|
|
2268
2556
|
### Parameters
|
|
2269
2557
|
|
|
@@ -2309,7 +2597,7 @@ The following schedule fields are immutable and cannot be updated:
|
|
|
2309
2597
|
- type
|
|
2310
2598
|
|
|
2311
2599
|
|
|
2312
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2600
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-source-schedule-v-1)
|
|
2313
2601
|
|
|
2314
2602
|
### Parameters
|
|
2315
2603
|
|
|
@@ -2379,7 +2667,7 @@ To switch an account attribute to a group entitlement, you need to have the foll
|
|
|
2379
2667
|
```
|
|
2380
2668
|
|
|
2381
2669
|
|
|
2382
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2670
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-source-schema-v-1)
|
|
2383
2671
|
|
|
2384
2672
|
### Parameters
|
|
2385
2673
|
|
|
@@ -2435,7 +2723,7 @@ These fields are immutable, so they cannot be changed:
|
|
|
2435
2723
|
Attempts to modify these fields will result in a 400 error.
|
|
2436
2724
|
|
|
2437
2725
|
|
|
2438
|
-
[API Spec](https://developer.sailpoint.com/docs/api/
|
|
2726
|
+
[API Spec](https://developer.sailpoint.com/docs/api/update-source-v-1)
|
|
2439
2727
|
|
|
2440
2728
|
### Parameters
|
|
2441
2729
|
|