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
package/dist/sources/api.d.ts
CHANGED
|
@@ -1216,6 +1216,58 @@ export declare const FielddetailsdtoTypeEnum: {
|
|
|
1216
1216
|
readonly Secret: "secret";
|
|
1217
1217
|
};
|
|
1218
1218
|
export type FielddetailsdtoTypeEnum = typeof FielddetailsdtoTypeEnum[keyof typeof FielddetailsdtoTypeEnum];
|
|
1219
|
+
/**
|
|
1220
|
+
*
|
|
1221
|
+
* @export
|
|
1222
|
+
* @interface Fielddetailsdtov2
|
|
1223
|
+
*/
|
|
1224
|
+
export interface Fielddetailsdtov2 {
|
|
1225
|
+
/**
|
|
1226
|
+
* The name of the attribute.
|
|
1227
|
+
* @type {string}
|
|
1228
|
+
* @memberof Fielddetailsdtov2
|
|
1229
|
+
*/
|
|
1230
|
+
'name'?: string;
|
|
1231
|
+
/**
|
|
1232
|
+
* The transform to apply to the field
|
|
1233
|
+
* @type {object}
|
|
1234
|
+
* @memberof Fielddetailsdtov2
|
|
1235
|
+
*/
|
|
1236
|
+
'transform'?: object;
|
|
1237
|
+
/**
|
|
1238
|
+
* Attributes required for the transform
|
|
1239
|
+
* @type {object}
|
|
1240
|
+
* @memberof Fielddetailsdtov2
|
|
1241
|
+
*/
|
|
1242
|
+
'attributes'?: object;
|
|
1243
|
+
/**
|
|
1244
|
+
* Flag indicating whether or not the attribute is required.
|
|
1245
|
+
* @type {boolean}
|
|
1246
|
+
* @memberof Fielddetailsdtov2
|
|
1247
|
+
*/
|
|
1248
|
+
'isRequired'?: boolean;
|
|
1249
|
+
/**
|
|
1250
|
+
* 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.
|
|
1251
|
+
* @type {string}
|
|
1252
|
+
* @memberof Fielddetailsdtov2
|
|
1253
|
+
*/
|
|
1254
|
+
'type'?: Fielddetailsdtov2TypeEnum;
|
|
1255
|
+
/**
|
|
1256
|
+
* Flag indicating whether or not the attribute is multi-valued.
|
|
1257
|
+
* @type {boolean}
|
|
1258
|
+
* @memberof Fielddetailsdtov2
|
|
1259
|
+
*/
|
|
1260
|
+
'isMultiValued'?: boolean;
|
|
1261
|
+
}
|
|
1262
|
+
export declare const Fielddetailsdtov2TypeEnum: {
|
|
1263
|
+
readonly String: "string";
|
|
1264
|
+
readonly Int: "int";
|
|
1265
|
+
readonly Long: "long";
|
|
1266
|
+
readonly Date: "date";
|
|
1267
|
+
readonly Boolean: "boolean";
|
|
1268
|
+
readonly Secret: "secret";
|
|
1269
|
+
};
|
|
1270
|
+
export type Fielddetailsdtov2TypeEnum = typeof Fielddetailsdtov2TypeEnum[keyof typeof Fielddetailsdtov2TypeEnum];
|
|
1219
1271
|
/**
|
|
1220
1272
|
*
|
|
1221
1273
|
* @export
|
|
@@ -1966,6 +2018,49 @@ export interface Provisioningpolicydto {
|
|
|
1966
2018
|
*/
|
|
1967
2019
|
'fields'?: Array<Fielddetailsdto>;
|
|
1968
2020
|
}
|
|
2021
|
+
/**
|
|
2022
|
+
*
|
|
2023
|
+
* @export
|
|
2024
|
+
* @interface Provisioningpolicydtov2
|
|
2025
|
+
*/
|
|
2026
|
+
export interface Provisioningpolicydtov2 {
|
|
2027
|
+
/**
|
|
2028
|
+
* System-generated unique ID of the provisioning policy.
|
|
2029
|
+
* @type {string}
|
|
2030
|
+
* @memberof Provisioningpolicydtov2
|
|
2031
|
+
*/
|
|
2032
|
+
'id'?: string;
|
|
2033
|
+
/**
|
|
2034
|
+
* the provisioning policy name
|
|
2035
|
+
* @type {string}
|
|
2036
|
+
* @memberof Provisioningpolicydtov2
|
|
2037
|
+
*/
|
|
2038
|
+
'name': string | null;
|
|
2039
|
+
/**
|
|
2040
|
+
* Subtype ID for which provisioning policy will be created when usageType is CREATE_MACHINE_ACCOUNT.
|
|
2041
|
+
* @type {string}
|
|
2042
|
+
* @memberof Provisioningpolicydtov2
|
|
2043
|
+
*/
|
|
2044
|
+
'subtypeId'?: string | null;
|
|
2045
|
+
/**
|
|
2046
|
+
* the description of the provisioning policy
|
|
2047
|
+
* @type {string}
|
|
2048
|
+
* @memberof Provisioningpolicydtov2
|
|
2049
|
+
*/
|
|
2050
|
+
'description'?: string;
|
|
2051
|
+
/**
|
|
2052
|
+
*
|
|
2053
|
+
* @type {Usagetype}
|
|
2054
|
+
* @memberof Provisioningpolicydtov2
|
|
2055
|
+
*/
|
|
2056
|
+
'usageType'?: Usagetype;
|
|
2057
|
+
/**
|
|
2058
|
+
*
|
|
2059
|
+
* @type {Array<Fielddetailsdtov2>}
|
|
2060
|
+
* @memberof Provisioningpolicydtov2
|
|
2061
|
+
*/
|
|
2062
|
+
'fields'?: Array<Fielddetailsdtov2>;
|
|
2063
|
+
}
|
|
1969
2064
|
/**
|
|
1970
2065
|
* Representation of the object which is returned from source connectors.
|
|
1971
2066
|
* @export
|
|
@@ -3179,7 +3274,7 @@ export declare const TransformreadTypeEnum: {
|
|
|
3179
3274
|
};
|
|
3180
3275
|
export type TransformreadTypeEnum = typeof TransformreadTypeEnum[keyof typeof TransformreadTypeEnum];
|
|
3181
3276
|
/**
|
|
3182
|
-
* 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.
|
|
3277
|
+
* 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. CREATE_MACHINE_ACCOUNT - This usage type can be used to create the provisioning template for a source subtype which will be used in creating a machine account. You can use these usage types for all your provisioning policy needs.
|
|
3183
3278
|
* @export
|
|
3184
3279
|
* @enum {string}
|
|
3185
3280
|
*/
|
|
@@ -3200,6 +3295,7 @@ export declare const Usagetype: {
|
|
|
3200
3295
|
readonly EditGroup: "EDIT_GROUP";
|
|
3201
3296
|
readonly Unlock: "UNLOCK";
|
|
3202
3297
|
readonly ChangePassword: "CHANGE_PASSWORD";
|
|
3298
|
+
readonly CreateMachineAccount: "CREATE_MACHINE_ACCOUNT";
|
|
3203
3299
|
};
|
|
3204
3300
|
export type Usagetype = typeof Usagetype[keyof typeof Usagetype];
|
|
3205
3301
|
/**
|
|
@@ -3216,6 +3312,17 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3216
3312
|
* @throws {RequiredError}
|
|
3217
3313
|
*/
|
|
3218
3314
|
createProvisioningPolicyV1: (sourceId: string, provisioningpolicydto: Provisioningpolicydto, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3315
|
+
/**
|
|
3316
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. 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. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
3317
|
+
* @summary Create provisioning policy
|
|
3318
|
+
* @param {string} sourceId The Source id
|
|
3319
|
+
* @param {Provisioningpolicydtov2} provisioningpolicydtov2
|
|
3320
|
+
* @param {boolean} [useDefaultFields] If passed as true, then it uses default fields from the connector template.
|
|
3321
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3322
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3323
|
+
* @throws {RequiredError}
|
|
3324
|
+
*/
|
|
3325
|
+
createProvisioningPolicyV2: (sourceId: string, provisioningpolicydtov2: Provisioningpolicydtov2, useDefaultFields?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3219
3326
|
/**
|
|
3220
3327
|
* Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
|
3221
3328
|
* @summary Create schedule on source
|
|
@@ -3268,6 +3375,16 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3268
3375
|
* @throws {RequiredError}
|
|
3269
3376
|
*/
|
|
3270
3377
|
deleteProvisioningPolicyV1: (sourceId: string, usageType: Usagetype, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3378
|
+
/**
|
|
3379
|
+
* Deletes the provisioning policy with the specified ID on an application.
|
|
3380
|
+
* @summary Delete provisioning policy by ID
|
|
3381
|
+
* @param {string} sourceId The Source ID.
|
|
3382
|
+
* @param {string} id The provisioning policy ID.
|
|
3383
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3384
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3385
|
+
* @throws {RequiredError}
|
|
3386
|
+
*/
|
|
3387
|
+
deleteProvisioningPolicyV2: (sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3271
3388
|
/**
|
|
3272
3389
|
*
|
|
3273
3390
|
* @summary Delete source schedule by type.
|
|
@@ -3352,6 +3469,16 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3352
3469
|
* @throws {RequiredError}
|
|
3353
3470
|
*/
|
|
3354
3471
|
getProvisioningPolicyV1: (sourceId: string, usageType: Usagetype, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3472
|
+
/**
|
|
3473
|
+
* This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud.
|
|
3474
|
+
* @summary Get provisioning policy by ID
|
|
3475
|
+
* @param {string} sourceId The Source ID.
|
|
3476
|
+
* @param {string} id The provisioning policy ID.
|
|
3477
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3478
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3479
|
+
* @throws {RequiredError}
|
|
3480
|
+
*/
|
|
3481
|
+
getProvisioningPolicyV2: (sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3355
3482
|
/**
|
|
3356
3483
|
* 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.
|
|
3357
3484
|
* @summary Attribute sync config
|
|
@@ -3516,6 +3643,18 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3516
3643
|
* @throws {RequiredError}
|
|
3517
3644
|
*/
|
|
3518
3645
|
listProvisioningPoliciesV1: (sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3646
|
+
/**
|
|
3647
|
+
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
3648
|
+
* @summary Lists Provisioning Policies
|
|
3649
|
+
* @param {string} sourceId The Source id
|
|
3650
|
+
* @param {string} [filters] 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*
|
|
3651
|
+
* @param {number} [offset] 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.
|
|
3652
|
+
* @param {number} [limit] 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.
|
|
3653
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3654
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3655
|
+
* @throws {RequiredError}
|
|
3656
|
+
*/
|
|
3657
|
+
listProvisioningPoliciesV2: (sourceId: string, filters?: string, offset?: number, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3519
3658
|
/**
|
|
3520
3659
|
* This end-point lists all the sources in IdentityNow.
|
|
3521
3660
|
* @summary Lists all sources in identitynow.
|
|
@@ -3566,6 +3705,17 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3566
3705
|
* @throws {RequiredError}
|
|
3567
3706
|
*/
|
|
3568
3707
|
putProvisioningPolicyV1: (sourceId: string, usageType: Usagetype, provisioningpolicydto: Provisioningpolicydto, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3708
|
+
/**
|
|
3709
|
+
* This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
3710
|
+
* @summary Update provisioning policy by ID
|
|
3711
|
+
* @param {string} sourceId The Source ID.
|
|
3712
|
+
* @param {string} id The provisioning policy ID.
|
|
3713
|
+
* @param {Provisioningpolicydtov2} provisioningpolicydtov2
|
|
3714
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3715
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3716
|
+
* @throws {RequiredError}
|
|
3717
|
+
*/
|
|
3718
|
+
putProvisioningPolicyV2: (sourceId: string, id: string, provisioningpolicydtov2: Provisioningpolicydtov2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3569
3719
|
/**
|
|
3570
3720
|
* 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.
|
|
3571
3721
|
* @summary Update attribute sync config
|
|
@@ -3675,6 +3825,17 @@ export declare const SourcesApiAxiosParamCreator: (configuration?: Configuration
|
|
|
3675
3825
|
* @throws {RequiredError}
|
|
3676
3826
|
*/
|
|
3677
3827
|
updateProvisioningPolicyV1: (sourceId: string, usageType: Usagetype, jsonpatchoperation: Array<Jsonpatchoperation>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3828
|
+
/**
|
|
3829
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
3830
|
+
* @summary Partial update of provisioning policy
|
|
3831
|
+
* @param {string} sourceId The Source id.
|
|
3832
|
+
* @param {string} id The provisioning policy ID.
|
|
3833
|
+
* @param {Array<Jsonpatchoperation>} jsonpatchoperation The JSONPatch payload used to update the schema.
|
|
3834
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3835
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3836
|
+
* @throws {RequiredError}
|
|
3837
|
+
*/
|
|
3838
|
+
updateProvisioningPolicyV2: (sourceId: string, id: string, jsonpatchoperation: Array<Jsonpatchoperation>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
3678
3839
|
/**
|
|
3679
3840
|
* This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
3680
3841
|
* @summary Update source entitlement request configuration
|
|
@@ -3729,6 +3890,17 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
3729
3890
|
* @throws {RequiredError}
|
|
3730
3891
|
*/
|
|
3731
3892
|
createProvisioningPolicyV1(sourceId: string, provisioningpolicydto: Provisioningpolicydto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydto>>;
|
|
3893
|
+
/**
|
|
3894
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. 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. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
3895
|
+
* @summary Create provisioning policy
|
|
3896
|
+
* @param {string} sourceId The Source id
|
|
3897
|
+
* @param {Provisioningpolicydtov2} provisioningpolicydtov2
|
|
3898
|
+
* @param {boolean} [useDefaultFields] If passed as true, then it uses default fields from the connector template.
|
|
3899
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3900
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3901
|
+
* @throws {RequiredError}
|
|
3902
|
+
*/
|
|
3903
|
+
createProvisioningPolicyV2(sourceId: string, provisioningpolicydtov2: Provisioningpolicydtov2, useDefaultFields?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydtov2>>;
|
|
3732
3904
|
/**
|
|
3733
3905
|
* Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
|
3734
3906
|
* @summary Create schedule on source
|
|
@@ -3781,6 +3953,16 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
3781
3953
|
* @throws {RequiredError}
|
|
3782
3954
|
*/
|
|
3783
3955
|
deleteProvisioningPolicyV1(sourceId: string, usageType: Usagetype, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3956
|
+
/**
|
|
3957
|
+
* Deletes the provisioning policy with the specified ID on an application.
|
|
3958
|
+
* @summary Delete provisioning policy by ID
|
|
3959
|
+
* @param {string} sourceId The Source ID.
|
|
3960
|
+
* @param {string} id The provisioning policy ID.
|
|
3961
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
3962
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3963
|
+
* @throws {RequiredError}
|
|
3964
|
+
*/
|
|
3965
|
+
deleteProvisioningPolicyV2(sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
3784
3966
|
/**
|
|
3785
3967
|
*
|
|
3786
3968
|
* @summary Delete source schedule by type.
|
|
@@ -3865,6 +4047,16 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
3865
4047
|
* @throws {RequiredError}
|
|
3866
4048
|
*/
|
|
3867
4049
|
getProvisioningPolicyV1(sourceId: string, usageType: Usagetype, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydto>>;
|
|
4050
|
+
/**
|
|
4051
|
+
* This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud.
|
|
4052
|
+
* @summary Get provisioning policy by ID
|
|
4053
|
+
* @param {string} sourceId The Source ID.
|
|
4054
|
+
* @param {string} id The provisioning policy ID.
|
|
4055
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
4056
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4057
|
+
* @throws {RequiredError}
|
|
4058
|
+
*/
|
|
4059
|
+
getProvisioningPolicyV2(sourceId: string, id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydtov2>>;
|
|
3868
4060
|
/**
|
|
3869
4061
|
* 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.
|
|
3870
4062
|
* @summary Attribute sync config
|
|
@@ -4029,6 +4221,18 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
4029
4221
|
* @throws {RequiredError}
|
|
4030
4222
|
*/
|
|
4031
4223
|
listProvisioningPoliciesV1(sourceId: string, offset?: number, limit?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Provisioningpolicydto>>>;
|
|
4224
|
+
/**
|
|
4225
|
+
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
4226
|
+
* @summary Lists Provisioning Policies
|
|
4227
|
+
* @param {string} sourceId The Source id
|
|
4228
|
+
* @param {string} [filters] 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*
|
|
4229
|
+
* @param {number} [offset] 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.
|
|
4230
|
+
* @param {number} [limit] 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.
|
|
4231
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
4232
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4233
|
+
* @throws {RequiredError}
|
|
4234
|
+
*/
|
|
4235
|
+
listProvisioningPoliciesV2(sourceId: string, filters?: string, offset?: number, limit?: number, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Provisioningpolicydtov2>>>;
|
|
4032
4236
|
/**
|
|
4033
4237
|
* This end-point lists all the sources in IdentityNow.
|
|
4034
4238
|
* @summary Lists all sources in identitynow.
|
|
@@ -4079,6 +4283,17 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
4079
4283
|
* @throws {RequiredError}
|
|
4080
4284
|
*/
|
|
4081
4285
|
putProvisioningPolicyV1(sourceId: string, usageType: Usagetype, provisioningpolicydto: Provisioningpolicydto, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydto>>;
|
|
4286
|
+
/**
|
|
4287
|
+
* This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
4288
|
+
* @summary Update provisioning policy by ID
|
|
4289
|
+
* @param {string} sourceId The Source ID.
|
|
4290
|
+
* @param {string} id The provisioning policy ID.
|
|
4291
|
+
* @param {Provisioningpolicydtov2} provisioningpolicydtov2
|
|
4292
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
4293
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4294
|
+
* @throws {RequiredError}
|
|
4295
|
+
*/
|
|
4296
|
+
putProvisioningPolicyV2(sourceId: string, id: string, provisioningpolicydtov2: Provisioningpolicydtov2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydtov2>>;
|
|
4082
4297
|
/**
|
|
4083
4298
|
* 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.
|
|
4084
4299
|
* @summary Update attribute sync config
|
|
@@ -4188,6 +4403,17 @@ export declare const SourcesApiFp: (configuration?: Configuration) => {
|
|
|
4188
4403
|
* @throws {RequiredError}
|
|
4189
4404
|
*/
|
|
4190
4405
|
updateProvisioningPolicyV1(sourceId: string, usageType: Usagetype, jsonpatchoperation: Array<Jsonpatchoperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydto>>;
|
|
4406
|
+
/**
|
|
4407
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
4408
|
+
* @summary Partial update of provisioning policy
|
|
4409
|
+
* @param {string} sourceId The Source id.
|
|
4410
|
+
* @param {string} id The provisioning policy ID.
|
|
4411
|
+
* @param {Array<Jsonpatchoperation>} jsonpatchoperation The JSONPatch payload used to update the schema.
|
|
4412
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
4413
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4414
|
+
* @throws {RequiredError}
|
|
4415
|
+
*/
|
|
4416
|
+
updateProvisioningPolicyV2(sourceId: string, id: string, jsonpatchoperation: Array<Jsonpatchoperation>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Provisioningpolicydtov2>>;
|
|
4191
4417
|
/**
|
|
4192
4418
|
* This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
4193
4419
|
* @summary Update source entitlement request configuration
|
|
@@ -4241,6 +4467,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4241
4467
|
* @throws {RequiredError}
|
|
4242
4468
|
*/
|
|
4243
4469
|
createProvisioningPolicyV1(requestParameters: SourcesApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydto>;
|
|
4470
|
+
/**
|
|
4471
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. 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. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
4472
|
+
* @summary Create provisioning policy
|
|
4473
|
+
* @param {SourcesApiCreateProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
4474
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4475
|
+
* @throws {RequiredError}
|
|
4476
|
+
*/
|
|
4477
|
+
createProvisioningPolicyV2(requestParameters: SourcesApiCreateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydtov2>;
|
|
4244
4478
|
/**
|
|
4245
4479
|
* Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
|
4246
4480
|
* @summary Create schedule on source
|
|
@@ -4289,6 +4523,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4289
4523
|
* @throws {RequiredError}
|
|
4290
4524
|
*/
|
|
4291
4525
|
deleteProvisioningPolicyV1(requestParameters: SourcesApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4526
|
+
/**
|
|
4527
|
+
* Deletes the provisioning policy with the specified ID on an application.
|
|
4528
|
+
* @summary Delete provisioning policy by ID
|
|
4529
|
+
* @param {SourcesApiDeleteProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
4530
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4531
|
+
* @throws {RequiredError}
|
|
4532
|
+
*/
|
|
4533
|
+
deleteProvisioningPolicyV2(requestParameters: SourcesApiDeleteProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
4292
4534
|
/**
|
|
4293
4535
|
*
|
|
4294
4536
|
* @summary Delete source schedule by type.
|
|
@@ -4369,6 +4611,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4369
4611
|
* @throws {RequiredError}
|
|
4370
4612
|
*/
|
|
4371
4613
|
getProvisioningPolicyV1(requestParameters: SourcesApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydto>;
|
|
4614
|
+
/**
|
|
4615
|
+
* This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud.
|
|
4616
|
+
* @summary Get provisioning policy by ID
|
|
4617
|
+
* @param {SourcesApiGetProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
4618
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4619
|
+
* @throws {RequiredError}
|
|
4620
|
+
*/
|
|
4621
|
+
getProvisioningPolicyV2(requestParameters: SourcesApiGetProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydtov2>;
|
|
4372
4622
|
/**
|
|
4373
4623
|
* 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.
|
|
4374
4624
|
* @summary Attribute sync config
|
|
@@ -4513,6 +4763,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4513
4763
|
* @throws {RequiredError}
|
|
4514
4764
|
*/
|
|
4515
4765
|
listProvisioningPoliciesV1(requestParameters: SourcesApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Provisioningpolicydto>>;
|
|
4766
|
+
/**
|
|
4767
|
+
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
4768
|
+
* @summary Lists Provisioning Policies
|
|
4769
|
+
* @param {SourcesApiListProvisioningPoliciesV2Request} requestParameters Request parameters.
|
|
4770
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4771
|
+
* @throws {RequiredError}
|
|
4772
|
+
*/
|
|
4773
|
+
listProvisioningPoliciesV2(requestParameters: SourcesApiListProvisioningPoliciesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Provisioningpolicydtov2>>;
|
|
4516
4774
|
/**
|
|
4517
4775
|
* This end-point lists all the sources in IdentityNow.
|
|
4518
4776
|
* @summary Lists all sources in identitynow.
|
|
@@ -4553,6 +4811,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4553
4811
|
* @throws {RequiredError}
|
|
4554
4812
|
*/
|
|
4555
4813
|
putProvisioningPolicyV1(requestParameters: SourcesApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydto>;
|
|
4814
|
+
/**
|
|
4815
|
+
* This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
4816
|
+
* @summary Update provisioning policy by ID
|
|
4817
|
+
* @param {SourcesApiPutProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
4818
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4819
|
+
* @throws {RequiredError}
|
|
4820
|
+
*/
|
|
4821
|
+
putProvisioningPolicyV2(requestParameters: SourcesApiPutProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydtov2>;
|
|
4556
4822
|
/**
|
|
4557
4823
|
* 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.
|
|
4558
4824
|
* @summary Update attribute sync config
|
|
@@ -4649,6 +4915,14 @@ export declare const SourcesApiFactory: (configuration?: Configuration, basePath
|
|
|
4649
4915
|
* @throws {RequiredError}
|
|
4650
4916
|
*/
|
|
4651
4917
|
updateProvisioningPolicyV1(requestParameters: SourcesApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydto>;
|
|
4918
|
+
/**
|
|
4919
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
4920
|
+
* @summary Partial update of provisioning policy
|
|
4921
|
+
* @param {SourcesApiUpdateProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
4922
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
4923
|
+
* @throws {RequiredError}
|
|
4924
|
+
*/
|
|
4925
|
+
updateProvisioningPolicyV2(requestParameters: SourcesApiUpdateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Provisioningpolicydtov2>;
|
|
4652
4926
|
/**
|
|
4653
4927
|
* This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
4654
4928
|
* @summary Update source entitlement request configuration
|
|
@@ -4701,6 +4975,37 @@ export interface SourcesApiCreateProvisioningPolicyV1Request {
|
|
|
4701
4975
|
*/
|
|
4702
4976
|
readonly provisioningpolicydto: Provisioningpolicydto;
|
|
4703
4977
|
}
|
|
4978
|
+
/**
|
|
4979
|
+
* Request parameters for createProvisioningPolicyV2 operation in SourcesApi.
|
|
4980
|
+
* @export
|
|
4981
|
+
* @interface SourcesApiCreateProvisioningPolicyV2Request
|
|
4982
|
+
*/
|
|
4983
|
+
export interface SourcesApiCreateProvisioningPolicyV2Request {
|
|
4984
|
+
/**
|
|
4985
|
+
* The Source id
|
|
4986
|
+
* @type {string}
|
|
4987
|
+
* @memberof SourcesApiCreateProvisioningPolicyV2
|
|
4988
|
+
*/
|
|
4989
|
+
readonly sourceId: string;
|
|
4990
|
+
/**
|
|
4991
|
+
*
|
|
4992
|
+
* @type {Provisioningpolicydtov2}
|
|
4993
|
+
* @memberof SourcesApiCreateProvisioningPolicyV2
|
|
4994
|
+
*/
|
|
4995
|
+
readonly provisioningpolicydtov2: Provisioningpolicydtov2;
|
|
4996
|
+
/**
|
|
4997
|
+
* If passed as true, then it uses default fields from the connector template.
|
|
4998
|
+
* @type {boolean}
|
|
4999
|
+
* @memberof SourcesApiCreateProvisioningPolicyV2
|
|
5000
|
+
*/
|
|
5001
|
+
readonly useDefaultFields?: boolean;
|
|
5002
|
+
/**
|
|
5003
|
+
* Use this header to enable this experimental API.
|
|
5004
|
+
* @type {string}
|
|
5005
|
+
* @memberof SourcesApiCreateProvisioningPolicyV2
|
|
5006
|
+
*/
|
|
5007
|
+
readonly xSailPointExperimental?: string;
|
|
5008
|
+
}
|
|
4704
5009
|
/**
|
|
4705
5010
|
* Request parameters for createSourceScheduleV1 operation in SourcesApi.
|
|
4706
5011
|
* @export
|
|
@@ -4803,6 +5108,31 @@ export interface SourcesApiDeleteProvisioningPolicyV1Request {
|
|
|
4803
5108
|
*/
|
|
4804
5109
|
readonly usageType: Usagetype;
|
|
4805
5110
|
}
|
|
5111
|
+
/**
|
|
5112
|
+
* Request parameters for deleteProvisioningPolicyV2 operation in SourcesApi.
|
|
5113
|
+
* @export
|
|
5114
|
+
* @interface SourcesApiDeleteProvisioningPolicyV2Request
|
|
5115
|
+
*/
|
|
5116
|
+
export interface SourcesApiDeleteProvisioningPolicyV2Request {
|
|
5117
|
+
/**
|
|
5118
|
+
* The Source ID.
|
|
5119
|
+
* @type {string}
|
|
5120
|
+
* @memberof SourcesApiDeleteProvisioningPolicyV2
|
|
5121
|
+
*/
|
|
5122
|
+
readonly sourceId: string;
|
|
5123
|
+
/**
|
|
5124
|
+
* The provisioning policy ID.
|
|
5125
|
+
* @type {string}
|
|
5126
|
+
* @memberof SourcesApiDeleteProvisioningPolicyV2
|
|
5127
|
+
*/
|
|
5128
|
+
readonly id: string;
|
|
5129
|
+
/**
|
|
5130
|
+
* Use this header to enable this experimental API.
|
|
5131
|
+
* @type {string}
|
|
5132
|
+
* @memberof SourcesApiDeleteProvisioningPolicyV2
|
|
5133
|
+
*/
|
|
5134
|
+
readonly xSailPointExperimental?: string;
|
|
5135
|
+
}
|
|
4806
5136
|
/**
|
|
4807
5137
|
* Request parameters for deleteSourceScheduleV1 operation in SourcesApi.
|
|
4808
5138
|
* @export
|
|
@@ -4957,6 +5287,31 @@ export interface SourcesApiGetProvisioningPolicyV1Request {
|
|
|
4957
5287
|
*/
|
|
4958
5288
|
readonly usageType: Usagetype;
|
|
4959
5289
|
}
|
|
5290
|
+
/**
|
|
5291
|
+
* Request parameters for getProvisioningPolicyV2 operation in SourcesApi.
|
|
5292
|
+
* @export
|
|
5293
|
+
* @interface SourcesApiGetProvisioningPolicyV2Request
|
|
5294
|
+
*/
|
|
5295
|
+
export interface SourcesApiGetProvisioningPolicyV2Request {
|
|
5296
|
+
/**
|
|
5297
|
+
* The Source ID.
|
|
5298
|
+
* @type {string}
|
|
5299
|
+
* @memberof SourcesApiGetProvisioningPolicyV2
|
|
5300
|
+
*/
|
|
5301
|
+
readonly sourceId: string;
|
|
5302
|
+
/**
|
|
5303
|
+
* The provisioning policy ID.
|
|
5304
|
+
* @type {string}
|
|
5305
|
+
* @memberof SourcesApiGetProvisioningPolicyV2
|
|
5306
|
+
*/
|
|
5307
|
+
readonly id: string;
|
|
5308
|
+
/**
|
|
5309
|
+
* Use this header to enable this experimental API.
|
|
5310
|
+
* @type {string}
|
|
5311
|
+
* @memberof SourcesApiGetProvisioningPolicyV2
|
|
5312
|
+
*/
|
|
5313
|
+
readonly xSailPointExperimental?: string;
|
|
5314
|
+
}
|
|
4960
5315
|
/**
|
|
4961
5316
|
* Request parameters for getSourceAttrSyncConfigV1 operation in SourcesApi.
|
|
4962
5317
|
* @export
|
|
@@ -5311,6 +5666,43 @@ export interface SourcesApiListProvisioningPoliciesV1Request {
|
|
|
5311
5666
|
*/
|
|
5312
5667
|
readonly limit?: number;
|
|
5313
5668
|
}
|
|
5669
|
+
/**
|
|
5670
|
+
* Request parameters for listProvisioningPoliciesV2 operation in SourcesApi.
|
|
5671
|
+
* @export
|
|
5672
|
+
* @interface SourcesApiListProvisioningPoliciesV2Request
|
|
5673
|
+
*/
|
|
5674
|
+
export interface SourcesApiListProvisioningPoliciesV2Request {
|
|
5675
|
+
/**
|
|
5676
|
+
* The Source id
|
|
5677
|
+
* @type {string}
|
|
5678
|
+
* @memberof SourcesApiListProvisioningPoliciesV2
|
|
5679
|
+
*/
|
|
5680
|
+
readonly sourceId: string;
|
|
5681
|
+
/**
|
|
5682
|
+
* 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*
|
|
5683
|
+
* @type {string}
|
|
5684
|
+
* @memberof SourcesApiListProvisioningPoliciesV2
|
|
5685
|
+
*/
|
|
5686
|
+
readonly filters?: string;
|
|
5687
|
+
/**
|
|
5688
|
+
* 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.
|
|
5689
|
+
* @type {number}
|
|
5690
|
+
* @memberof SourcesApiListProvisioningPoliciesV2
|
|
5691
|
+
*/
|
|
5692
|
+
readonly offset?: number;
|
|
5693
|
+
/**
|
|
5694
|
+
* 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.
|
|
5695
|
+
* @type {number}
|
|
5696
|
+
* @memberof SourcesApiListProvisioningPoliciesV2
|
|
5697
|
+
*/
|
|
5698
|
+
readonly limit?: number;
|
|
5699
|
+
/**
|
|
5700
|
+
* Use this header to enable this experimental API.
|
|
5701
|
+
* @type {string}
|
|
5702
|
+
* @memberof SourcesApiListProvisioningPoliciesV2
|
|
5703
|
+
*/
|
|
5704
|
+
readonly xSailPointExperimental?: string;
|
|
5705
|
+
}
|
|
5314
5706
|
/**
|
|
5315
5707
|
* Request parameters for listSourcesV1 operation in SourcesApi.
|
|
5316
5708
|
* @export
|
|
@@ -5436,6 +5828,37 @@ export interface SourcesApiPutProvisioningPolicyV1Request {
|
|
|
5436
5828
|
*/
|
|
5437
5829
|
readonly provisioningpolicydto: Provisioningpolicydto;
|
|
5438
5830
|
}
|
|
5831
|
+
/**
|
|
5832
|
+
* Request parameters for putProvisioningPolicyV2 operation in SourcesApi.
|
|
5833
|
+
* @export
|
|
5834
|
+
* @interface SourcesApiPutProvisioningPolicyV2Request
|
|
5835
|
+
*/
|
|
5836
|
+
export interface SourcesApiPutProvisioningPolicyV2Request {
|
|
5837
|
+
/**
|
|
5838
|
+
* The Source ID.
|
|
5839
|
+
* @type {string}
|
|
5840
|
+
* @memberof SourcesApiPutProvisioningPolicyV2
|
|
5841
|
+
*/
|
|
5842
|
+
readonly sourceId: string;
|
|
5843
|
+
/**
|
|
5844
|
+
* The provisioning policy ID.
|
|
5845
|
+
* @type {string}
|
|
5846
|
+
* @memberof SourcesApiPutProvisioningPolicyV2
|
|
5847
|
+
*/
|
|
5848
|
+
readonly id: string;
|
|
5849
|
+
/**
|
|
5850
|
+
*
|
|
5851
|
+
* @type {Provisioningpolicydtov2}
|
|
5852
|
+
* @memberof SourcesApiPutProvisioningPolicyV2
|
|
5853
|
+
*/
|
|
5854
|
+
readonly provisioningpolicydtov2: Provisioningpolicydtov2;
|
|
5855
|
+
/**
|
|
5856
|
+
* Use this header to enable this experimental API.
|
|
5857
|
+
* @type {string}
|
|
5858
|
+
* @memberof SourcesApiPutProvisioningPolicyV2
|
|
5859
|
+
*/
|
|
5860
|
+
readonly xSailPointExperimental?: string;
|
|
5861
|
+
}
|
|
5439
5862
|
/**
|
|
5440
5863
|
* Request parameters for putSourceAttrSyncConfigV1 operation in SourcesApi.
|
|
5441
5864
|
* @export
|
|
@@ -5670,6 +6093,37 @@ export interface SourcesApiUpdateProvisioningPolicyV1Request {
|
|
|
5670
6093
|
*/
|
|
5671
6094
|
readonly jsonpatchoperation: Array<Jsonpatchoperation>;
|
|
5672
6095
|
}
|
|
6096
|
+
/**
|
|
6097
|
+
* Request parameters for updateProvisioningPolicyV2 operation in SourcesApi.
|
|
6098
|
+
* @export
|
|
6099
|
+
* @interface SourcesApiUpdateProvisioningPolicyV2Request
|
|
6100
|
+
*/
|
|
6101
|
+
export interface SourcesApiUpdateProvisioningPolicyV2Request {
|
|
6102
|
+
/**
|
|
6103
|
+
* The Source id.
|
|
6104
|
+
* @type {string}
|
|
6105
|
+
* @memberof SourcesApiUpdateProvisioningPolicyV2
|
|
6106
|
+
*/
|
|
6107
|
+
readonly sourceId: string;
|
|
6108
|
+
/**
|
|
6109
|
+
* The provisioning policy ID.
|
|
6110
|
+
* @type {string}
|
|
6111
|
+
* @memberof SourcesApiUpdateProvisioningPolicyV2
|
|
6112
|
+
*/
|
|
6113
|
+
readonly id: string;
|
|
6114
|
+
/**
|
|
6115
|
+
* The JSONPatch payload used to update the schema.
|
|
6116
|
+
* @type {Array<Jsonpatchoperation>}
|
|
6117
|
+
* @memberof SourcesApiUpdateProvisioningPolicyV2
|
|
6118
|
+
*/
|
|
6119
|
+
readonly jsonpatchoperation: Array<Jsonpatchoperation>;
|
|
6120
|
+
/**
|
|
6121
|
+
* Use this header to enable this experimental API.
|
|
6122
|
+
* @type {string}
|
|
6123
|
+
* @memberof SourcesApiUpdateProvisioningPolicyV2
|
|
6124
|
+
*/
|
|
6125
|
+
readonly xSailPointExperimental?: string;
|
|
6126
|
+
}
|
|
5673
6127
|
/**
|
|
5674
6128
|
* Request parameters for updateSourceEntitlementRequestConfigV1 operation in SourcesApi.
|
|
5675
6129
|
* @export
|
|
@@ -5780,6 +6234,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
5780
6234
|
* @memberof SourcesApi
|
|
5781
6235
|
*/
|
|
5782
6236
|
createProvisioningPolicyV1(requestParameters: SourcesApiCreateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydto, any>>;
|
|
6237
|
+
/**
|
|
6238
|
+
* This API generates a create policy/template based on field value transforms. This API is intended for use when setting up JDBC Provisioning type sources, but it will also work on other source types. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. 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. Note: The subtypeId field is required if usageType is CREATE_MACHINE_ACCOUNT. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
6239
|
+
* @summary Create provisioning policy
|
|
6240
|
+
* @param {SourcesApiCreateProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
6241
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6242
|
+
* @throws {RequiredError}
|
|
6243
|
+
* @memberof SourcesApi
|
|
6244
|
+
*/
|
|
6245
|
+
createProvisioningPolicyV2(requestParameters: SourcesApiCreateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydtov2, any>>;
|
|
5783
6246
|
/**
|
|
5784
6247
|
* Use this API to create a new schedule for a type on the specified source in Identity Security Cloud (ISC).
|
|
5785
6248
|
* @summary Create schedule on source
|
|
@@ -5834,6 +6297,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
5834
6297
|
* @memberof SourcesApi
|
|
5835
6298
|
*/
|
|
5836
6299
|
deleteProvisioningPolicyV1(requestParameters: SourcesApiDeleteProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
6300
|
+
/**
|
|
6301
|
+
* Deletes the provisioning policy with the specified ID on an application.
|
|
6302
|
+
* @summary Delete provisioning policy by ID
|
|
6303
|
+
* @param {SourcesApiDeleteProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
6304
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6305
|
+
* @throws {RequiredError}
|
|
6306
|
+
* @memberof SourcesApi
|
|
6307
|
+
*/
|
|
6308
|
+
deleteProvisioningPolicyV2(requestParameters: SourcesApiDeleteProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
5837
6309
|
/**
|
|
5838
6310
|
*
|
|
5839
6311
|
* @summary Delete source schedule by type.
|
|
@@ -5924,6 +6396,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
5924
6396
|
* @memberof SourcesApi
|
|
5925
6397
|
*/
|
|
5926
6398
|
getProvisioningPolicyV1(requestParameters: SourcesApiGetProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydto, any>>;
|
|
6399
|
+
/**
|
|
6400
|
+
* This end-point retrieves the ProvisioningPolicy with the specified ID on the specified Source in Identity Security Cloud.
|
|
6401
|
+
* @summary Get provisioning policy by ID
|
|
6402
|
+
* @param {SourcesApiGetProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
6403
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6404
|
+
* @throws {RequiredError}
|
|
6405
|
+
* @memberof SourcesApi
|
|
6406
|
+
*/
|
|
6407
|
+
getProvisioningPolicyV2(requestParameters: SourcesApiGetProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydtov2, any>>;
|
|
5927
6408
|
/**
|
|
5928
6409
|
* 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.
|
|
5929
6410
|
* @summary Attribute sync config
|
|
@@ -6086,6 +6567,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
6086
6567
|
* @memberof SourcesApi
|
|
6087
6568
|
*/
|
|
6088
6569
|
listProvisioningPoliciesV1(requestParameters: SourcesApiListProvisioningPoliciesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydto[], any>>;
|
|
6570
|
+
/**
|
|
6571
|
+
* This end-point lists all the ProvisioningPolicies in IdentityNow.
|
|
6572
|
+
* @summary Lists Provisioning Policies
|
|
6573
|
+
* @param {SourcesApiListProvisioningPoliciesV2Request} requestParameters Request parameters.
|
|
6574
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6575
|
+
* @throws {RequiredError}
|
|
6576
|
+
* @memberof SourcesApi
|
|
6577
|
+
*/
|
|
6578
|
+
listProvisioningPoliciesV2(requestParameters: SourcesApiListProvisioningPoliciesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydtov2[], any>>;
|
|
6089
6579
|
/**
|
|
6090
6580
|
* This end-point lists all the sources in IdentityNow.
|
|
6091
6581
|
* @summary Lists all sources in identitynow.
|
|
@@ -6131,6 +6621,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
6131
6621
|
* @memberof SourcesApi
|
|
6132
6622
|
*/
|
|
6133
6623
|
putProvisioningPolicyV1(requestParameters: SourcesApiPutProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydto, any>>;
|
|
6624
|
+
/**
|
|
6625
|
+
* This end-point updates the provisioning policy with the specified ID on the specified source in Identity Security Cloud. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
6626
|
+
* @summary Update provisioning policy by ID
|
|
6627
|
+
* @param {SourcesApiPutProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
6628
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6629
|
+
* @throws {RequiredError}
|
|
6630
|
+
* @memberof SourcesApi
|
|
6631
|
+
*/
|
|
6632
|
+
putProvisioningPolicyV2(requestParameters: SourcesApiPutProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydtov2, any>>;
|
|
6134
6633
|
/**
|
|
6135
6634
|
* 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.
|
|
6136
6635
|
* @summary Update attribute sync config
|
|
@@ -6239,6 +6738,15 @@ export declare class SourcesApi extends BaseAPI {
|
|
|
6239
6738
|
* @memberof SourcesApi
|
|
6240
6739
|
*/
|
|
6241
6740
|
updateProvisioningPolicyV1(requestParameters: SourcesApiUpdateProvisioningPolicyV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydto, any>>;
|
|
6741
|
+
/**
|
|
6742
|
+
* This API selectively updates an existing Provisioning Policy using a JSONPatch payload. Transforms can be used in the provisioning policy to create a new attribute that you only need during provisioning. Refer to [Transforms in Provisioning Policies](https://developer.sailpoint.com/docs/extensibility/transforms/guides/transforms-in-provisioning-policies) for more information.
|
|
6743
|
+
* @summary Partial update of provisioning policy
|
|
6744
|
+
* @param {SourcesApiUpdateProvisioningPolicyV2Request} requestParameters Request parameters.
|
|
6745
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
6746
|
+
* @throws {RequiredError}
|
|
6747
|
+
* @memberof SourcesApi
|
|
6748
|
+
*/
|
|
6749
|
+
updateProvisioningPolicyV2(requestParameters: SourcesApiUpdateProvisioningPolicyV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Provisioningpolicydtov2, any>>;
|
|
6242
6750
|
/**
|
|
6243
6751
|
* This API replaces the current entitlement request configuration for a source. This source-level configuration should apply for all the entitlements in the source. Access request to any entitlements in the source should follow this configuration unless a separate entitlement-level configuration is defined. - During access request, this source-level entitlement request configuration overrides the global organization-level configuration. - However, the entitlement-level configuration (if defined) overrides this source-level configuration.
|
|
6244
6752
|
* @summary Update source entitlement request configuration
|