sailpoint-api-client 2.0.4 → 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/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/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/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/package.json +1 -1
- 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 +288 -0
- package/sources/docs/Models/Fielddetailsdtov2.md +24 -0
- package/sources/docs/Models/Provisioningpolicydtov2.md +24 -0
- package/sources/docs/Models/Usagetype.md +2 -0
|
@@ -13,6 +13,23 @@
|
|
|
13
13
|
const provisioningpolicydto: Provisioningpolicydto = {"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}]}; // Provisioningpolicydto |
|
|
14
14
|
const result = await apiInstance.createProvisioningPolicyV1({ sourceId: sourceId, provisioningpolicydto: provisioningpolicydto });
|
|
15
15
|
console.log(result);
|
|
16
|
+
- path: /sources/v2/{sourceId}/provisioning-policies
|
|
17
|
+
method: POST
|
|
18
|
+
xCodeSample:
|
|
19
|
+
- lang: TypeScript
|
|
20
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#create-provisioning-policy-v2
|
|
21
|
+
source: |
|
|
22
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
23
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
24
|
+
|
|
25
|
+
const configuration = new Configuration();
|
|
26
|
+
const apiInstance = new SourcesApi(configuration);
|
|
27
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id (default to undefined)
|
|
28
|
+
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}]}; // Provisioningpolicydtov2 |
|
|
29
|
+
const useDefaultFields: boolean = false; // boolean | If passed as true, then it uses default fields from the connector template. (optional) (default to false)
|
|
30
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
31
|
+
const result = await apiInstance.createProvisioningPolicyV2({ sourceId: sourceId, provisioningpolicydtov2: provisioningpolicydtov2 });
|
|
32
|
+
console.log(result);
|
|
16
33
|
- path: /sources/v1/{sourceId}/schedules
|
|
17
34
|
method: POST
|
|
18
35
|
xCodeSample:
|
|
@@ -101,6 +118,22 @@
|
|
|
101
118
|
const usageType: Usagetype = CREATE; // 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. (default to undefined)
|
|
102
119
|
const result = await apiInstance.deleteProvisioningPolicyV1({ sourceId: sourceId, usageType: usageType });
|
|
103
120
|
console.log(result);
|
|
121
|
+
- path: /sources/v2/{sourceId}/provisioning-policies/{id}
|
|
122
|
+
method: DELETE
|
|
123
|
+
xCodeSample:
|
|
124
|
+
- lang: TypeScript
|
|
125
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#delete-provisioning-policy-v2
|
|
126
|
+
source: |
|
|
127
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
128
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
129
|
+
|
|
130
|
+
const configuration = new Configuration();
|
|
131
|
+
const apiInstance = new SourcesApi(configuration);
|
|
132
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
|
|
133
|
+
const id: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The provisioning policy ID. (default to undefined)
|
|
134
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
135
|
+
const result = await apiInstance.deleteProvisioningPolicyV2({ sourceId: sourceId, id: id });
|
|
136
|
+
console.log(result);
|
|
104
137
|
- path: /sources/v1/{sourceId}/schedules/{scheduleType}
|
|
105
138
|
method: DELETE
|
|
106
139
|
xCodeSample:
|
|
@@ -245,6 +278,22 @@
|
|
|
245
278
|
const usageType: Usagetype = CREATE; // 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. (default to undefined)
|
|
246
279
|
const result = await apiInstance.getProvisioningPolicyV1({ sourceId: sourceId, usageType: usageType });
|
|
247
280
|
console.log(result);
|
|
281
|
+
- path: /sources/v2/{sourceId}/provisioning-policies/{id}
|
|
282
|
+
method: GET
|
|
283
|
+
xCodeSample:
|
|
284
|
+
- lang: TypeScript
|
|
285
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#get-provisioning-policy-v2
|
|
286
|
+
source: |
|
|
287
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
288
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
289
|
+
|
|
290
|
+
const configuration = new Configuration();
|
|
291
|
+
const apiInstance = new SourcesApi(configuration);
|
|
292
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
|
|
293
|
+
const id: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The provisioning policy ID. (default to undefined)
|
|
294
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
295
|
+
const result = await apiInstance.getProvisioningPolicyV2({ sourceId: sourceId, id: id });
|
|
296
|
+
console.log(result);
|
|
248
297
|
- path: /sources/v1/{id}/attribute-sync-config
|
|
249
298
|
method: GET
|
|
250
299
|
xCodeSample:
|
|
@@ -517,6 +566,24 @@
|
|
|
517
566
|
const limit: number = 250; // 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)
|
|
518
567
|
const result = await apiInstance.listProvisioningPoliciesV1({ sourceId: sourceId });
|
|
519
568
|
console.log(result);
|
|
569
|
+
- path: /sources/v2/{sourceId}/provisioning-policies
|
|
570
|
+
method: GET
|
|
571
|
+
xCodeSample:
|
|
572
|
+
- lang: TypeScript
|
|
573
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#list-provisioning-policies-v2
|
|
574
|
+
source: |
|
|
575
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
576
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
577
|
+
|
|
578
|
+
const configuration = new Configuration();
|
|
579
|
+
const apiInstance = new SourcesApi(configuration);
|
|
580
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id (default to undefined)
|
|
581
|
+
const filters: string = 'subtypeId eq "6d28b7c1-620c-49c6-b6d5-cbf81eb4b5fa"'; // 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)
|
|
582
|
+
const offset: number = 0; // 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)
|
|
583
|
+
const limit: number = 250; // 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)
|
|
584
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
585
|
+
const result = await apiInstance.listProvisioningPoliciesV2({ sourceId: sourceId });
|
|
586
|
+
console.log(result);
|
|
520
587
|
- path: /sources/v1
|
|
521
588
|
method: GET
|
|
522
589
|
xCodeSample:
|
|
@@ -597,6 +664,23 @@
|
|
|
597
664
|
const provisioningpolicydto: Provisioningpolicydto = ; // Provisioningpolicydto |
|
|
598
665
|
const result = await apiInstance.putProvisioningPolicyV1({ sourceId: sourceId, usageType: usageType, provisioningpolicydto: provisioningpolicydto });
|
|
599
666
|
console.log(result);
|
|
667
|
+
- path: /sources/v2/{sourceId}/provisioning-policies/{id}
|
|
668
|
+
method: PUT
|
|
669
|
+
xCodeSample:
|
|
670
|
+
- lang: TypeScript
|
|
671
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#put-provisioning-policy-v2
|
|
672
|
+
source: |
|
|
673
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
674
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
675
|
+
|
|
676
|
+
const configuration = new Configuration();
|
|
677
|
+
const apiInstance = new SourcesApi(configuration);
|
|
678
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source ID. (default to undefined)
|
|
679
|
+
const id: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The provisioning policy ID. (default to undefined)
|
|
680
|
+
const provisioningpolicydtov2: Provisioningpolicydtov2 = ; // Provisioningpolicydtov2 |
|
|
681
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
682
|
+
const result = await apiInstance.putProvisioningPolicyV2({ sourceId: sourceId, id: id, provisioningpolicydtov2: provisioningpolicydtov2 });
|
|
683
|
+
console.log(result);
|
|
600
684
|
- path: /sources/v1/{id}/attribute-sync-config
|
|
601
685
|
method: PUT
|
|
602
686
|
xCodeSample:
|
|
@@ -778,6 +862,23 @@
|
|
|
778
862
|
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}}]; // Array<Jsonpatchoperation> | The JSONPatch payload used to update the schema.
|
|
779
863
|
const result = await apiInstance.updateProvisioningPolicyV1({ sourceId: sourceId, usageType: usageType, jsonpatchoperation: jsonpatchoperation });
|
|
780
864
|
console.log(result);
|
|
865
|
+
- path: /sources/v2/{sourceId}/provisioning-policies/{id}
|
|
866
|
+
method: PATCH
|
|
867
|
+
xCodeSample:
|
|
868
|
+
- lang: TypeScript
|
|
869
|
+
label: SDK_tools/sdk/typescript/sources/methods/sources#update-provisioning-policy-v2
|
|
870
|
+
source: |
|
|
871
|
+
import { SourcesApi } from 'sailpoint-api-client';
|
|
872
|
+
import { Configuration } from 'sailpoint-api-client';
|
|
873
|
+
|
|
874
|
+
const configuration = new Configuration();
|
|
875
|
+
const apiInstance = new SourcesApi(configuration);
|
|
876
|
+
const sourceId: string = '2c9180835d191a86015d28455b4a2329'; // string | The Source id. (default to undefined)
|
|
877
|
+
const id: string = 'f5dd23fe-3414-42b7-bb1c-869400ad7a10'; // string | The provisioning policy ID. (default to undefined)
|
|
878
|
+
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}}]; // Array<Jsonpatchoperation> | The JSONPatch payload used to update the schema.
|
|
879
|
+
const xSailPointExperimental: string = 'true'; // string | Use this header to enable this experimental API. (optional) (default to 'true')
|
|
880
|
+
const result = await apiInstance.updateProvisioningPolicyV2({ sourceId: sourceId, id: id, jsonpatchoperation: jsonpatchoperation });
|
|
881
|
+
console.log(result);
|
|
781
882
|
- path: /sources/v1/{id}/entitlement-request-config
|
|
782
883
|
method: PUT
|
|
783
884
|
xCodeSample:
|
|
@@ -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)
|
|
@@ -171,6 +177,56 @@ 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).
|
|
@@ -409,6 +465,50 @@ 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
|
|
|
@@ -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.
|
|
@@ -1537,6 +1681,54 @@ 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.
|
|
@@ -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.
|
|
@@ -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.
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-fielddetailsdtov2
|
|
3
|
+
title: Fielddetailsdtov2
|
|
4
|
+
pagination_label: Fielddetailsdtov2
|
|
5
|
+
sidebar_label: Fielddetailsdtov2
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Fielddetailsdtov2', 'v1Fielddetailsdtov2']
|
|
8
|
+
slug: /tools/sdk/typescript/sources/models/fielddetailsdtov2
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Fielddetailsdtov2', 'v1Fielddetailsdtov2']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Fielddetailsdtov2
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**name** | **(optional)** `string` | The name of the attribute. | [default to undefined]
|
|
19
|
+
**transform** | **(optional)** `object` | The transform to apply to the field | [default to undefined]
|
|
20
|
+
**attributes** | **(optional)** `object` | Attributes required for the transform | [default to undefined]
|
|
21
|
+
**isRequired** | **(optional)** `boolean` | Flag indicating whether or not the attribute is required. | [readonly] [default to false]
|
|
22
|
+
**type** | **(optional)** `string` | The type of the attribute. string: For text-based data. int: For whole numbers. long: For larger whole numbers. date: For date and time values. boolean: For true/false values. secret: For sensitive data like passwords, which will be masked and encrypted. | [default to undefined]
|
|
23
|
+
**isMultiValued** | **(optional)** `boolean` | Flag indicating whether or not the attribute is multi-valued. | [default to false]
|
|
24
|
+
|
|
@@ -0,0 +1,24 @@
|
|
|
1
|
+
---
|
|
2
|
+
id: v1-provisioningpolicydtov2
|
|
3
|
+
title: Provisioningpolicydtov2
|
|
4
|
+
pagination_label: Provisioningpolicydtov2
|
|
5
|
+
sidebar_label: Provisioningpolicydtov2
|
|
6
|
+
sidebar_class_name: typescriptsdk
|
|
7
|
+
keywords: ['typescript', 'TypeScript', 'sdk', 'Provisioningpolicydtov2', 'v1Provisioningpolicydtov2']
|
|
8
|
+
slug: /tools/sdk/typescript/sources/models/provisioningpolicydtov2
|
|
9
|
+
tags: ['SDK', 'Software Development Kit', 'Provisioningpolicydtov2', 'v1Provisioningpolicydtov2']
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
# Provisioningpolicydtov2
|
|
13
|
+
|
|
14
|
+
## Properties
|
|
15
|
+
|
|
16
|
+
Name | Type | Description | Notes
|
|
17
|
+
------------ | ------------- | ------------- | -------------
|
|
18
|
+
**id** | **(optional)** `string` | System-generated unique ID of the provisioning policy. | [default to undefined]
|
|
19
|
+
**name** | `string` | the provisioning policy name | [default to undefined]
|
|
20
|
+
**subtypeId** | **(optional)** `string` | Subtype ID for which provisioning policy will be created when usageType is CREATE_MACHINE_ACCOUNT. | [default to undefined]
|
|
21
|
+
**description** | **(optional)** `string` | the description of the provisioning policy | [default to undefined]
|
|
22
|
+
**usageType** | **(optional)** `Usagetype` | | [default to undefined]
|
|
23
|
+
**fields** | **(optional)** `Array<Fielddetailsdtov2>` | | [default to undefined]
|
|
24
|
+
|