sailpoint-api-client 1.3.6 → 1.4.8
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/beta/README.md +2 -2
- package/beta/api.ts +1078 -971
- package/beta/common.ts +9 -2
- package/beta/package.json +1 -1
- package/configuration.ts +1 -0
- package/dist/beta/api.d.ts +599 -528
- package/dist/beta/api.js +1181 -1153
- package/dist/beta/api.js.map +1 -1
- package/dist/beta/common.js +7 -1
- package/dist/beta/common.js.map +1 -1
- package/dist/configuration.d.ts +1 -0
- package/dist/configuration.js.map +1 -1
- package/dist/index.d.ts +2 -0
- package/dist/index.js +6 -3
- package/dist/index.js.map +1 -1
- package/dist/index.spec.js +65 -0
- package/dist/index.spec.js.map +1 -1
- package/dist/v2024/api.d.ts +74558 -0
- package/dist/v2024/api.js +68142 -0
- package/dist/v2024/api.js.map +1 -0
- package/dist/v2024/base.d.ts +55 -0
- package/dist/v2024/base.js +86 -0
- package/dist/v2024/base.js.map +1 -0
- package/dist/v2024/common.d.ts +65 -0
- package/dist/v2024/common.js +257 -0
- package/dist/v2024/common.js.map +1 -0
- package/dist/v2024/configuration.d.ts +83 -0
- package/dist/v2024/configuration.js +45 -0
- package/dist/v2024/configuration.js.map +1 -0
- package/dist/v2024/index.d.ts +12 -0
- package/dist/v2024/index.js +31 -0
- package/dist/v2024/index.js.map +1 -0
- package/dist/v3/api.d.ts +1825 -207
- package/dist/v3/api.js +2422 -794
- package/dist/v3/api.js.map +1 -1
- package/dist/v3/common.js +7 -1
- package/dist/v3/common.js.map +1 -1
- package/index.spec.ts +44 -1
- package/index.ts +3 -0
- package/package.json +1 -1
- package/v2024/.openapi-generator/FILES +12 -0
- package/v2024/.openapi-generator/VERSION +1 -0
- package/v2024/.openapi-generator-ignore +23 -0
- package/v2024/README.md +45 -0
- package/v2024/api.ts +107265 -0
- package/v2024/base.ts +71 -0
- package/v2024/common.ts +153 -0
- package/v2024/configuration.ts +101 -0
- package/v2024/git_push.sh +57 -0
- package/v2024/index.ts +17 -0
- package/v2024/package.json +35 -0
- package/v2024/tsconfig.json +21 -0
- package/v3/README.md +2 -2
- package/v3/api.ts +3052 -684
- package/v3/common.ts +9 -2
- package/v3/package.json +1 -1
package/dist/v3/api.d.ts
CHANGED
|
@@ -1267,6 +1267,30 @@ export interface Account {
|
|
|
1267
1267
|
* @memberof Account
|
|
1268
1268
|
*/
|
|
1269
1269
|
'identityId'?: string;
|
|
1270
|
+
/**
|
|
1271
|
+
* The lifecycle state of the identity this account is correlated to
|
|
1272
|
+
* @type {string}
|
|
1273
|
+
* @memberof Account
|
|
1274
|
+
*/
|
|
1275
|
+
'cloudLifecycleState'?: string | null;
|
|
1276
|
+
/**
|
|
1277
|
+
* The identity state of the identity this account is correlated to
|
|
1278
|
+
* @type {string}
|
|
1279
|
+
* @memberof Account
|
|
1280
|
+
*/
|
|
1281
|
+
'identityState'?: string | null;
|
|
1282
|
+
/**
|
|
1283
|
+
* The connection type of the source this account is from
|
|
1284
|
+
* @type {string}
|
|
1285
|
+
* @memberof Account
|
|
1286
|
+
*/
|
|
1287
|
+
'connectionType'?: string | null;
|
|
1288
|
+
/**
|
|
1289
|
+
* The type of the account
|
|
1290
|
+
* @type {string}
|
|
1291
|
+
* @memberof Account
|
|
1292
|
+
*/
|
|
1293
|
+
'type'?: string | null;
|
|
1270
1294
|
/**
|
|
1271
1295
|
* The account attributes that are aggregated
|
|
1272
1296
|
* @type {{ [key: string]: any; }}
|
|
@@ -1343,17 +1367,41 @@ export interface Account {
|
|
|
1343
1367
|
'identity'?: BaseReferenceDto;
|
|
1344
1368
|
/**
|
|
1345
1369
|
*
|
|
1346
|
-
* @type {
|
|
1370
|
+
* @type {AccountAllOfSourceOwner}
|
|
1347
1371
|
* @memberof Account
|
|
1348
1372
|
*/
|
|
1349
|
-
'sourceOwner'?:
|
|
1373
|
+
'sourceOwner'?: AccountAllOfSourceOwner | null;
|
|
1350
1374
|
/**
|
|
1351
1375
|
* A string list containing the owning source\'s features
|
|
1352
1376
|
* @type {string}
|
|
1353
1377
|
* @memberof Account
|
|
1354
1378
|
*/
|
|
1355
1379
|
'features'?: string | null;
|
|
1380
|
+
/**
|
|
1381
|
+
* The origin of the account either aggregated or provisioned
|
|
1382
|
+
* @type {string}
|
|
1383
|
+
* @memberof Account
|
|
1384
|
+
*/
|
|
1385
|
+
'origin'?: AccountOriginEnum;
|
|
1386
|
+
/**
|
|
1387
|
+
*
|
|
1388
|
+
* @type {AccountAllOfOwnerIdentity}
|
|
1389
|
+
* @memberof Account
|
|
1390
|
+
*/
|
|
1391
|
+
'ownerIdentity'?: AccountAllOfOwnerIdentity | null;
|
|
1392
|
+
/**
|
|
1393
|
+
*
|
|
1394
|
+
* @type {AccountAllOfOwnerGroup}
|
|
1395
|
+
* @memberof Account
|
|
1396
|
+
*/
|
|
1397
|
+
'ownerGroup'?: AccountAllOfOwnerGroup | null;
|
|
1356
1398
|
}
|
|
1399
|
+
export declare const AccountOriginEnum: {
|
|
1400
|
+
readonly Aggregated: "AGGREGATED";
|
|
1401
|
+
readonly Provisioned: "PROVISIONED";
|
|
1402
|
+
readonly Null: "null";
|
|
1403
|
+
};
|
|
1404
|
+
export type AccountOriginEnum = typeof AccountOriginEnum[keyof typeof AccountOriginEnum];
|
|
1357
1405
|
/**
|
|
1358
1406
|
* Object for specifying Actions to be performed on a specified list of sources\' account.
|
|
1359
1407
|
* @export
|
|
@@ -1979,6 +2027,30 @@ export interface AccountAllOf {
|
|
|
1979
2027
|
* @memberof AccountAllOf
|
|
1980
2028
|
*/
|
|
1981
2029
|
'identityId'?: string;
|
|
2030
|
+
/**
|
|
2031
|
+
* The lifecycle state of the identity this account is correlated to
|
|
2032
|
+
* @type {string}
|
|
2033
|
+
* @memberof AccountAllOf
|
|
2034
|
+
*/
|
|
2035
|
+
'cloudLifecycleState'?: string | null;
|
|
2036
|
+
/**
|
|
2037
|
+
* The identity state of the identity this account is correlated to
|
|
2038
|
+
* @type {string}
|
|
2039
|
+
* @memberof AccountAllOf
|
|
2040
|
+
*/
|
|
2041
|
+
'identityState'?: string | null;
|
|
2042
|
+
/**
|
|
2043
|
+
* The connection type of the source this account is from
|
|
2044
|
+
* @type {string}
|
|
2045
|
+
* @memberof AccountAllOf
|
|
2046
|
+
*/
|
|
2047
|
+
'connectionType'?: string | null;
|
|
2048
|
+
/**
|
|
2049
|
+
* The type of the account
|
|
2050
|
+
* @type {string}
|
|
2051
|
+
* @memberof AccountAllOf
|
|
2052
|
+
*/
|
|
2053
|
+
'type'?: string | null;
|
|
1982
2054
|
/**
|
|
1983
2055
|
* The account attributes that are aggregated
|
|
1984
2056
|
* @type {{ [key: string]: any; }}
|
|
@@ -2055,17 +2127,128 @@ export interface AccountAllOf {
|
|
|
2055
2127
|
'identity'?: BaseReferenceDto;
|
|
2056
2128
|
/**
|
|
2057
2129
|
*
|
|
2058
|
-
* @type {
|
|
2130
|
+
* @type {AccountAllOfSourceOwner}
|
|
2059
2131
|
* @memberof AccountAllOf
|
|
2060
2132
|
*/
|
|
2061
|
-
'sourceOwner'?:
|
|
2133
|
+
'sourceOwner'?: AccountAllOfSourceOwner | null;
|
|
2062
2134
|
/**
|
|
2063
2135
|
* A string list containing the owning source\'s features
|
|
2064
2136
|
* @type {string}
|
|
2065
2137
|
* @memberof AccountAllOf
|
|
2066
2138
|
*/
|
|
2067
2139
|
'features'?: string | null;
|
|
2140
|
+
/**
|
|
2141
|
+
* The origin of the account either aggregated or provisioned
|
|
2142
|
+
* @type {string}
|
|
2143
|
+
* @memberof AccountAllOf
|
|
2144
|
+
*/
|
|
2145
|
+
'origin'?: AccountAllOfOriginEnum;
|
|
2146
|
+
/**
|
|
2147
|
+
*
|
|
2148
|
+
* @type {AccountAllOfOwnerIdentity}
|
|
2149
|
+
* @memberof AccountAllOf
|
|
2150
|
+
*/
|
|
2151
|
+
'ownerIdentity'?: AccountAllOfOwnerIdentity | null;
|
|
2152
|
+
/**
|
|
2153
|
+
*
|
|
2154
|
+
* @type {AccountAllOfOwnerGroup}
|
|
2155
|
+
* @memberof AccountAllOf
|
|
2156
|
+
*/
|
|
2157
|
+
'ownerGroup'?: AccountAllOfOwnerGroup | null;
|
|
2158
|
+
}
|
|
2159
|
+
export declare const AccountAllOfOriginEnum: {
|
|
2160
|
+
readonly Aggregated: "AGGREGATED";
|
|
2161
|
+
readonly Provisioned: "PROVISIONED";
|
|
2162
|
+
readonly Null: "null";
|
|
2163
|
+
};
|
|
2164
|
+
export type AccountAllOfOriginEnum = typeof AccountAllOfOriginEnum[keyof typeof AccountAllOfOriginEnum];
|
|
2165
|
+
/**
|
|
2166
|
+
* The governance group who owns this account, typically used for non-human accounts
|
|
2167
|
+
* @export
|
|
2168
|
+
* @interface AccountAllOfOwnerGroup
|
|
2169
|
+
*/
|
|
2170
|
+
export interface AccountAllOfOwnerGroup {
|
|
2171
|
+
/**
|
|
2172
|
+
* The type of object being referenced
|
|
2173
|
+
* @type {string}
|
|
2174
|
+
* @memberof AccountAllOfOwnerGroup
|
|
2175
|
+
*/
|
|
2176
|
+
'type'?: AccountAllOfOwnerGroupTypeEnum;
|
|
2177
|
+
/**
|
|
2178
|
+
* ID of the governance group
|
|
2179
|
+
* @type {string}
|
|
2180
|
+
* @memberof AccountAllOfOwnerGroup
|
|
2181
|
+
*/
|
|
2182
|
+
'id'?: string;
|
|
2183
|
+
/**
|
|
2184
|
+
* Human-readable display name of the governance group
|
|
2185
|
+
* @type {string}
|
|
2186
|
+
* @memberof AccountAllOfOwnerGroup
|
|
2187
|
+
*/
|
|
2188
|
+
'name'?: string;
|
|
2189
|
+
}
|
|
2190
|
+
export declare const AccountAllOfOwnerGroupTypeEnum: {
|
|
2191
|
+
readonly GovernanceGroup: "GOVERNANCE_GROUP";
|
|
2192
|
+
};
|
|
2193
|
+
export type AccountAllOfOwnerGroupTypeEnum = typeof AccountAllOfOwnerGroupTypeEnum[keyof typeof AccountAllOfOwnerGroupTypeEnum];
|
|
2194
|
+
/**
|
|
2195
|
+
* The identity who owns this account, typically used for non-human accounts
|
|
2196
|
+
* @export
|
|
2197
|
+
* @interface AccountAllOfOwnerIdentity
|
|
2198
|
+
*/
|
|
2199
|
+
export interface AccountAllOfOwnerIdentity {
|
|
2200
|
+
/**
|
|
2201
|
+
* The type of object being referenced
|
|
2202
|
+
* @type {string}
|
|
2203
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2204
|
+
*/
|
|
2205
|
+
'type'?: AccountAllOfOwnerIdentityTypeEnum;
|
|
2206
|
+
/**
|
|
2207
|
+
* ID of the identity
|
|
2208
|
+
* @type {string}
|
|
2209
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2210
|
+
*/
|
|
2211
|
+
'id'?: string;
|
|
2212
|
+
/**
|
|
2213
|
+
* Human-readable display name of the identity
|
|
2214
|
+
* @type {string}
|
|
2215
|
+
* @memberof AccountAllOfOwnerIdentity
|
|
2216
|
+
*/
|
|
2217
|
+
'name'?: string;
|
|
2068
2218
|
}
|
|
2219
|
+
export declare const AccountAllOfOwnerIdentityTypeEnum: {
|
|
2220
|
+
readonly Identity: "IDENTITY";
|
|
2221
|
+
};
|
|
2222
|
+
export type AccountAllOfOwnerIdentityTypeEnum = typeof AccountAllOfOwnerIdentityTypeEnum[keyof typeof AccountAllOfOwnerIdentityTypeEnum];
|
|
2223
|
+
/**
|
|
2224
|
+
* The owner of this object.
|
|
2225
|
+
* @export
|
|
2226
|
+
* @interface AccountAllOfSourceOwner
|
|
2227
|
+
*/
|
|
2228
|
+
export interface AccountAllOfSourceOwner {
|
|
2229
|
+
/**
|
|
2230
|
+
* Type of owner object.
|
|
2231
|
+
* @type {string}
|
|
2232
|
+
* @memberof AccountAllOfSourceOwner
|
|
2233
|
+
*/
|
|
2234
|
+
'type'?: AccountAllOfSourceOwnerTypeEnum;
|
|
2235
|
+
/**
|
|
2236
|
+
* Identity id
|
|
2237
|
+
* @type {string}
|
|
2238
|
+
* @memberof AccountAllOfSourceOwner
|
|
2239
|
+
*/
|
|
2240
|
+
'id'?: string;
|
|
2241
|
+
/**
|
|
2242
|
+
* Human-readable display name of the owner.
|
|
2243
|
+
* @type {string}
|
|
2244
|
+
* @memberof AccountAllOfSourceOwner
|
|
2245
|
+
*/
|
|
2246
|
+
'name'?: string;
|
|
2247
|
+
}
|
|
2248
|
+
export declare const AccountAllOfSourceOwnerTypeEnum: {
|
|
2249
|
+
readonly Identity: "IDENTITY";
|
|
2250
|
+
};
|
|
2251
|
+
export type AccountAllOfSourceOwnerTypeEnum = typeof AccountAllOfSourceOwnerTypeEnum[keyof typeof AccountAllOfSourceOwnerTypeEnum];
|
|
2069
2252
|
/**
|
|
2070
2253
|
*
|
|
2071
2254
|
* @export
|
|
@@ -4028,33 +4211,52 @@ export type BucketType = typeof BucketType[keyof typeof BucketType];
|
|
|
4028
4211
|
/**
|
|
4029
4212
|
*
|
|
4030
4213
|
* @export
|
|
4031
|
-
* @interface
|
|
4214
|
+
* @interface BulkAddTaggedObject
|
|
4032
4215
|
*/
|
|
4033
|
-
export interface
|
|
4216
|
+
export interface BulkAddTaggedObject {
|
|
4034
4217
|
/**
|
|
4035
4218
|
*
|
|
4036
4219
|
* @type {Array<TaggedObjectDto>}
|
|
4037
|
-
* @memberof
|
|
4220
|
+
* @memberof BulkAddTaggedObject
|
|
4038
4221
|
*/
|
|
4039
4222
|
'objectRefs'?: Array<TaggedObjectDto>;
|
|
4040
4223
|
/**
|
|
4041
4224
|
* Label to be applied to an Object
|
|
4042
4225
|
* @type {Array<string>}
|
|
4043
|
-
* @memberof
|
|
4226
|
+
* @memberof BulkAddTaggedObject
|
|
4044
4227
|
*/
|
|
4045
4228
|
'tags'?: Array<string>;
|
|
4046
4229
|
/**
|
|
4047
4230
|
* If APPEND, tags are appended to the list of tags for the object. A 400 error is returned if this would add duplicate tags to the object. If MERGE, tags are merged with the existing tags. Duplicate tags are silently ignored.
|
|
4048
4231
|
* @type {string}
|
|
4049
|
-
* @memberof
|
|
4232
|
+
* @memberof BulkAddTaggedObject
|
|
4050
4233
|
*/
|
|
4051
|
-
'operation'?:
|
|
4234
|
+
'operation'?: BulkAddTaggedObjectOperationEnum;
|
|
4052
4235
|
}
|
|
4053
|
-
export declare const
|
|
4236
|
+
export declare const BulkAddTaggedObjectOperationEnum: {
|
|
4054
4237
|
readonly Append: "APPEND";
|
|
4055
4238
|
readonly Merge: "MERGE";
|
|
4056
4239
|
};
|
|
4057
|
-
export type
|
|
4240
|
+
export type BulkAddTaggedObjectOperationEnum = typeof BulkAddTaggedObjectOperationEnum[keyof typeof BulkAddTaggedObjectOperationEnum];
|
|
4241
|
+
/**
|
|
4242
|
+
*
|
|
4243
|
+
* @export
|
|
4244
|
+
* @interface BulkRemoveTaggedObject
|
|
4245
|
+
*/
|
|
4246
|
+
export interface BulkRemoveTaggedObject {
|
|
4247
|
+
/**
|
|
4248
|
+
*
|
|
4249
|
+
* @type {Array<TaggedObjectDto>}
|
|
4250
|
+
* @memberof BulkRemoveTaggedObject
|
|
4251
|
+
*/
|
|
4252
|
+
'objectRefs'?: Array<TaggedObjectDto>;
|
|
4253
|
+
/**
|
|
4254
|
+
* Label to be applied to an Object
|
|
4255
|
+
* @type {Array<string>}
|
|
4256
|
+
* @memberof BulkRemoveTaggedObject
|
|
4257
|
+
*/
|
|
4258
|
+
'tags'?: Array<string>;
|
|
4259
|
+
}
|
|
4058
4260
|
/**
|
|
4059
4261
|
*
|
|
4060
4262
|
* @export
|
|
@@ -5434,11 +5636,11 @@ export interface CompletedApproval {
|
|
|
5434
5636
|
*/
|
|
5435
5637
|
'requester'?: AccessItemRequester;
|
|
5436
5638
|
/**
|
|
5437
|
-
*
|
|
5438
|
-
* @type {
|
|
5639
|
+
*
|
|
5640
|
+
* @type {RequestedItemStatusRequestedFor}
|
|
5439
5641
|
* @memberof CompletedApproval
|
|
5440
5642
|
*/
|
|
5441
|
-
'requestedFor'?:
|
|
5643
|
+
'requestedFor'?: RequestedItemStatusRequestedFor;
|
|
5442
5644
|
/**
|
|
5443
5645
|
*
|
|
5444
5646
|
* @type {AccessItemReviewedBy}
|
|
@@ -5516,7 +5718,7 @@ export interface CompletedApproval {
|
|
|
5516
5718
|
* @type {SodViolationContextCheckCompleted}
|
|
5517
5719
|
* @memberof CompletedApproval
|
|
5518
5720
|
*/
|
|
5519
|
-
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
5721
|
+
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
5520
5722
|
/**
|
|
5521
5723
|
*
|
|
5522
5724
|
* @type {CompletedApprovalPreApprovalTriggerResult}
|
|
@@ -5531,12 +5733,6 @@ export interface CompletedApproval {
|
|
|
5531
5733
|
'clientMetadata'?: {
|
|
5532
5734
|
[key: string]: string;
|
|
5533
5735
|
};
|
|
5534
|
-
/**
|
|
5535
|
-
* Information about the requested accounts
|
|
5536
|
-
* @type {string}
|
|
5537
|
-
* @memberof CompletedApproval
|
|
5538
|
-
*/
|
|
5539
|
-
'requestedAccounts'?: string | null;
|
|
5540
5736
|
}
|
|
5541
5737
|
/**
|
|
5542
5738
|
* If the access request submitted event trigger is configured and this access request was intercepted by it, then this is the result of the trigger\'s decision to either approve or deny the request.
|
|
@@ -6639,6 +6835,68 @@ export declare const DeleteSource202ResponseTypeEnum: {
|
|
|
6639
6835
|
readonly TaskResult: "TASK_RESULT";
|
|
6640
6836
|
};
|
|
6641
6837
|
export type DeleteSource202ResponseTypeEnum = typeof DeleteSource202ResponseTypeEnum[keyof typeof DeleteSource202ResponseTypeEnum];
|
|
6838
|
+
/**
|
|
6839
|
+
*
|
|
6840
|
+
* @export
|
|
6841
|
+
* @interface DeleteVendorConnectorMapping200Response
|
|
6842
|
+
*/
|
|
6843
|
+
export interface DeleteVendorConnectorMapping200Response {
|
|
6844
|
+
/**
|
|
6845
|
+
* The number of vendor connector mappings successfully deleted.
|
|
6846
|
+
* @type {number}
|
|
6847
|
+
* @memberof DeleteVendorConnectorMapping200Response
|
|
6848
|
+
*/
|
|
6849
|
+
'count'?: number;
|
|
6850
|
+
}
|
|
6851
|
+
/**
|
|
6852
|
+
*
|
|
6853
|
+
* @export
|
|
6854
|
+
* @interface DiscoveredApplicationsInner
|
|
6855
|
+
*/
|
|
6856
|
+
export interface DiscoveredApplicationsInner {
|
|
6857
|
+
/**
|
|
6858
|
+
* Unique identifier for the discovered application.
|
|
6859
|
+
* @type {string}
|
|
6860
|
+
* @memberof DiscoveredApplicationsInner
|
|
6861
|
+
*/
|
|
6862
|
+
'id'?: string;
|
|
6863
|
+
/**
|
|
6864
|
+
* Name of the discovered application.
|
|
6865
|
+
* @type {string}
|
|
6866
|
+
* @memberof DiscoveredApplicationsInner
|
|
6867
|
+
*/
|
|
6868
|
+
'name'?: string;
|
|
6869
|
+
/**
|
|
6870
|
+
* Source from which the application was discovered.
|
|
6871
|
+
* @type {string}
|
|
6872
|
+
* @memberof DiscoveredApplicationsInner
|
|
6873
|
+
*/
|
|
6874
|
+
'discoverySource'?: string;
|
|
6875
|
+
/**
|
|
6876
|
+
* The vendor associated with the discovered application.
|
|
6877
|
+
* @type {string}
|
|
6878
|
+
* @memberof DiscoveredApplicationsInner
|
|
6879
|
+
*/
|
|
6880
|
+
'discoveredVendor'?: string;
|
|
6881
|
+
/**
|
|
6882
|
+
* A brief description of the discovered application.
|
|
6883
|
+
* @type {string}
|
|
6884
|
+
* @memberof DiscoveredApplicationsInner
|
|
6885
|
+
*/
|
|
6886
|
+
'description'?: string;
|
|
6887
|
+
/**
|
|
6888
|
+
* List of recommended connectors for the application.
|
|
6889
|
+
* @type {Array<string>}
|
|
6890
|
+
* @memberof DiscoveredApplicationsInner
|
|
6891
|
+
*/
|
|
6892
|
+
'recommendedConnectors'?: Array<string>;
|
|
6893
|
+
/**
|
|
6894
|
+
* The timestamp when the application was discovered, in ISO 8601 format.
|
|
6895
|
+
* @type {string}
|
|
6896
|
+
* @memberof DiscoveredApplicationsInner
|
|
6897
|
+
*/
|
|
6898
|
+
'discoveredTimestamp'?: string;
|
|
6899
|
+
}
|
|
6642
6900
|
/**
|
|
6643
6901
|
*
|
|
6644
6902
|
* @export
|
|
@@ -7740,6 +7998,12 @@ export interface EventAttributes {
|
|
|
7740
7998
|
* @memberof EventAttributes
|
|
7741
7999
|
*/
|
|
7742
8000
|
'filter.$'?: string;
|
|
8001
|
+
/**
|
|
8002
|
+
* Description of the event trigger
|
|
8003
|
+
* @type {string}
|
|
8004
|
+
* @memberof EventAttributes
|
|
8005
|
+
*/
|
|
8006
|
+
'description'?: string;
|
|
7743
8007
|
}
|
|
7744
8008
|
/**
|
|
7745
8009
|
* Event
|
|
@@ -8088,13 +8352,25 @@ export interface ExternalAttributes {
|
|
|
8088
8352
|
* @type {string}
|
|
8089
8353
|
* @memberof ExternalAttributes
|
|
8090
8354
|
*/
|
|
8091
|
-
'name'
|
|
8355
|
+
'name'?: string;
|
|
8092
8356
|
/**
|
|
8093
8357
|
* Additonal context about the external trigger
|
|
8094
8358
|
* @type {string}
|
|
8095
8359
|
* @memberof ExternalAttributes
|
|
8096
8360
|
*/
|
|
8097
8361
|
'description'?: string;
|
|
8362
|
+
/**
|
|
8363
|
+
* OAuth Client ID to authenticate with this trigger
|
|
8364
|
+
* @type {string}
|
|
8365
|
+
* @memberof ExternalAttributes
|
|
8366
|
+
*/
|
|
8367
|
+
'clientId'?: string;
|
|
8368
|
+
/**
|
|
8369
|
+
* URL to invoke this workflow
|
|
8370
|
+
* @type {string}
|
|
8371
|
+
* @memberof ExternalAttributes
|
|
8372
|
+
*/
|
|
8373
|
+
'url'?: string;
|
|
8098
8374
|
}
|
|
8099
8375
|
/**
|
|
8100
8376
|
*
|
|
@@ -8379,25 +8655,6 @@ export interface GenerateRandomString {
|
|
|
8379
8655
|
*/
|
|
8380
8656
|
'requiresPeriodicRefresh'?: boolean;
|
|
8381
8657
|
}
|
|
8382
|
-
/**
|
|
8383
|
-
*
|
|
8384
|
-
* @export
|
|
8385
|
-
* @interface GenericRule
|
|
8386
|
-
*/
|
|
8387
|
-
export interface GenericRule {
|
|
8388
|
-
/**
|
|
8389
|
-
* This is the name of the Generic rule that needs to be invoked by the transform
|
|
8390
|
-
* @type {string}
|
|
8391
|
-
* @memberof GenericRule
|
|
8392
|
-
*/
|
|
8393
|
-
'name': string;
|
|
8394
|
-
/**
|
|
8395
|
-
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
8396
|
-
* @type {boolean}
|
|
8397
|
-
* @memberof GenericRule
|
|
8398
|
-
*/
|
|
8399
|
-
'requiresPeriodicRefresh'?: boolean;
|
|
8400
|
-
}
|
|
8401
8658
|
/**
|
|
8402
8659
|
* @type GetActiveCampaigns200ResponseInner
|
|
8403
8660
|
* @export
|
|
@@ -8511,6 +8768,18 @@ export interface GetOAuthClientResponse {
|
|
|
8511
8768
|
* @memberof GetOAuthClientResponse
|
|
8512
8769
|
*/
|
|
8513
8770
|
'modified': string;
|
|
8771
|
+
/**
|
|
8772
|
+
*
|
|
8773
|
+
* @type {string}
|
|
8774
|
+
* @memberof GetOAuthClientResponse
|
|
8775
|
+
*/
|
|
8776
|
+
'secret'?: string | null;
|
|
8777
|
+
/**
|
|
8778
|
+
*
|
|
8779
|
+
* @type {string}
|
|
8780
|
+
* @memberof GetOAuthClientResponse
|
|
8781
|
+
*/
|
|
8782
|
+
'metadata'?: string | null;
|
|
8514
8783
|
/**
|
|
8515
8784
|
* The date and time, down to the millisecond, when this API Client was last used to generate an access token. This timestamp does not get updated on every API Client usage, but only once a day. This property can be useful for identifying which API Clients are no longer actively used and can be removed.
|
|
8516
8785
|
* @type {string}
|
|
@@ -8604,6 +8873,31 @@ export interface GetReferenceIdentityAttribute {
|
|
|
8604
8873
|
*/
|
|
8605
8874
|
'requiresPeriodicRefresh'?: boolean;
|
|
8606
8875
|
}
|
|
8876
|
+
/**
|
|
8877
|
+
*
|
|
8878
|
+
* @export
|
|
8879
|
+
* @interface GetVendorConnectorMappings405Response
|
|
8880
|
+
*/
|
|
8881
|
+
export interface GetVendorConnectorMappings405Response {
|
|
8882
|
+
/**
|
|
8883
|
+
* A message describing the error
|
|
8884
|
+
* @type {object}
|
|
8885
|
+
* @memberof GetVendorConnectorMappings405Response
|
|
8886
|
+
*/
|
|
8887
|
+
'errorName'?: object;
|
|
8888
|
+
/**
|
|
8889
|
+
* Description of the error
|
|
8890
|
+
* @type {object}
|
|
8891
|
+
* @memberof GetVendorConnectorMappings405Response
|
|
8892
|
+
*/
|
|
8893
|
+
'errorMessage'?: object;
|
|
8894
|
+
/**
|
|
8895
|
+
* Unique tracking id for the error.
|
|
8896
|
+
* @type {string}
|
|
8897
|
+
* @memberof GetVendorConnectorMappings405Response
|
|
8898
|
+
*/
|
|
8899
|
+
'trackingId'?: string;
|
|
8900
|
+
}
|
|
8607
8901
|
/**
|
|
8608
8902
|
* OAuth2 Grant Type
|
|
8609
8903
|
* @export
|
|
@@ -8744,6 +9038,37 @@ export interface IdentityAttributeConfig {
|
|
|
8744
9038
|
*/
|
|
8745
9039
|
'attributeTransforms'?: Array<IdentityAttributeTransform>;
|
|
8746
9040
|
}
|
|
9041
|
+
/**
|
|
9042
|
+
*
|
|
9043
|
+
* @export
|
|
9044
|
+
* @interface IdentityAttributePreview
|
|
9045
|
+
*/
|
|
9046
|
+
export interface IdentityAttributePreview {
|
|
9047
|
+
/**
|
|
9048
|
+
* Name of the attribute that is being previewed.
|
|
9049
|
+
* @type {string}
|
|
9050
|
+
* @memberof IdentityAttributePreview
|
|
9051
|
+
*/
|
|
9052
|
+
'name'?: string;
|
|
9053
|
+
/**
|
|
9054
|
+
* Value that was derived during the preview.
|
|
9055
|
+
* @type {object}
|
|
9056
|
+
* @memberof IdentityAttributePreview
|
|
9057
|
+
*/
|
|
9058
|
+
'value'?: object;
|
|
9059
|
+
/**
|
|
9060
|
+
* The value of the attribute before the preview.
|
|
9061
|
+
* @type {object}
|
|
9062
|
+
* @memberof IdentityAttributePreview
|
|
9063
|
+
*/
|
|
9064
|
+
'previousValue'?: object;
|
|
9065
|
+
/**
|
|
9066
|
+
*
|
|
9067
|
+
* @type {Array<ErrorMessageDto>}
|
|
9068
|
+
* @memberof IdentityAttributePreview
|
|
9069
|
+
*/
|
|
9070
|
+
'errorMessages'?: Array<ErrorMessageDto>;
|
|
9071
|
+
}
|
|
8747
9072
|
/**
|
|
8748
9073
|
* Defines a transformation definition for an identity attribute.
|
|
8749
9074
|
* @export
|
|
@@ -9465,6 +9790,73 @@ export interface IdentityExceptionReportReference {
|
|
|
9465
9790
|
*/
|
|
9466
9791
|
'reportName'?: string;
|
|
9467
9792
|
}
|
|
9793
|
+
/**
|
|
9794
|
+
*
|
|
9795
|
+
* @export
|
|
9796
|
+
* @interface IdentityPreviewRequest
|
|
9797
|
+
*/
|
|
9798
|
+
export interface IdentityPreviewRequest {
|
|
9799
|
+
/**
|
|
9800
|
+
* The Identity id
|
|
9801
|
+
* @type {string}
|
|
9802
|
+
* @memberof IdentityPreviewRequest
|
|
9803
|
+
*/
|
|
9804
|
+
'identityId'?: string;
|
|
9805
|
+
/**
|
|
9806
|
+
*
|
|
9807
|
+
* @type {Array<IdentityAttributeConfig>}
|
|
9808
|
+
* @memberof IdentityPreviewRequest
|
|
9809
|
+
*/
|
|
9810
|
+
'identityAttributeConfig'?: Array<IdentityAttributeConfig>;
|
|
9811
|
+
}
|
|
9812
|
+
/**
|
|
9813
|
+
*
|
|
9814
|
+
* @export
|
|
9815
|
+
* @interface IdentityPreviewResponse
|
|
9816
|
+
*/
|
|
9817
|
+
export interface IdentityPreviewResponse {
|
|
9818
|
+
/**
|
|
9819
|
+
*
|
|
9820
|
+
* @type {IdentityPreviewResponseIdentity}
|
|
9821
|
+
* @memberof IdentityPreviewResponse
|
|
9822
|
+
*/
|
|
9823
|
+
'identity'?: IdentityPreviewResponseIdentity;
|
|
9824
|
+
/**
|
|
9825
|
+
*
|
|
9826
|
+
* @type {Array<IdentityAttributePreview>}
|
|
9827
|
+
* @memberof IdentityPreviewResponse
|
|
9828
|
+
*/
|
|
9829
|
+
'previewAttributes'?: Array<IdentityAttributePreview>;
|
|
9830
|
+
}
|
|
9831
|
+
/**
|
|
9832
|
+
* Identity\'s basic details.
|
|
9833
|
+
* @export
|
|
9834
|
+
* @interface IdentityPreviewResponseIdentity
|
|
9835
|
+
*/
|
|
9836
|
+
export interface IdentityPreviewResponseIdentity {
|
|
9837
|
+
/**
|
|
9838
|
+
* Identity\'s DTO type.
|
|
9839
|
+
* @type {string}
|
|
9840
|
+
* @memberof IdentityPreviewResponseIdentity
|
|
9841
|
+
*/
|
|
9842
|
+
'type'?: IdentityPreviewResponseIdentityTypeEnum;
|
|
9843
|
+
/**
|
|
9844
|
+
* Identity ID.
|
|
9845
|
+
* @type {string}
|
|
9846
|
+
* @memberof IdentityPreviewResponseIdentity
|
|
9847
|
+
*/
|
|
9848
|
+
'id'?: string;
|
|
9849
|
+
/**
|
|
9850
|
+
* Identity\'s display name.
|
|
9851
|
+
* @type {string}
|
|
9852
|
+
* @memberof IdentityPreviewResponseIdentity
|
|
9853
|
+
*/
|
|
9854
|
+
'name'?: string;
|
|
9855
|
+
}
|
|
9856
|
+
export declare const IdentityPreviewResponseIdentityTypeEnum: {
|
|
9857
|
+
readonly Identity: "IDENTITY";
|
|
9858
|
+
};
|
|
9859
|
+
export type IdentityPreviewResponseIdentityTypeEnum = typeof IdentityPreviewResponseIdentityTypeEnum[keyof typeof IdentityPreviewResponseIdentityTypeEnum];
|
|
9468
9860
|
/**
|
|
9469
9861
|
*
|
|
9470
9862
|
* @export
|
|
@@ -10725,7 +11117,37 @@ export interface ListCompleteWorkflowLibrary200ResponseInner {
|
|
|
10725
11117
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
10726
11118
|
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
10727
11119
|
*/
|
|
10728
|
-
'formFields'?: Array<WorkflowLibraryFormFields
|
|
11120
|
+
'formFields'?: Array<WorkflowLibraryFormFields> | null;
|
|
11121
|
+
/**
|
|
11122
|
+
*
|
|
11123
|
+
* @type {WorkflowLibraryActionExampleOutput}
|
|
11124
|
+
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
11125
|
+
*/
|
|
11126
|
+
'exampleOutput'?: WorkflowLibraryActionExampleOutput;
|
|
11127
|
+
/**
|
|
11128
|
+
*
|
|
11129
|
+
* @type {boolean}
|
|
11130
|
+
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
11131
|
+
*/
|
|
11132
|
+
'deprecated'?: boolean;
|
|
11133
|
+
/**
|
|
11134
|
+
*
|
|
11135
|
+
* @type {string}
|
|
11136
|
+
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
11137
|
+
*/
|
|
11138
|
+
'deprecatedBy'?: string;
|
|
11139
|
+
/**
|
|
11140
|
+
* Version number
|
|
11141
|
+
* @type {number}
|
|
11142
|
+
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
11143
|
+
*/
|
|
11144
|
+
'versionNumber'?: number;
|
|
11145
|
+
/**
|
|
11146
|
+
*
|
|
11147
|
+
* @type {boolean}
|
|
11148
|
+
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
11149
|
+
*/
|
|
11150
|
+
'isSimulationEnabled'?: boolean;
|
|
10729
11151
|
/**
|
|
10730
11152
|
* Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
10731
11153
|
* @type {boolean}
|
|
@@ -10733,7 +11155,7 @@ export interface ListCompleteWorkflowLibrary200ResponseInner {
|
|
|
10733
11155
|
*/
|
|
10734
11156
|
'isDynamicSchema'?: boolean;
|
|
10735
11157
|
/**
|
|
10736
|
-
*
|
|
11158
|
+
* Example output schema
|
|
10737
11159
|
* @type {object}
|
|
10738
11160
|
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
10739
11161
|
*/
|
|
@@ -10849,6 +11271,18 @@ export interface ManagedClient {
|
|
|
10849
11271
|
* @memberof ManagedClient
|
|
10850
11272
|
*/
|
|
10851
11273
|
'alertKey'?: string | null;
|
|
11274
|
+
/**
|
|
11275
|
+
*
|
|
11276
|
+
* @type {string}
|
|
11277
|
+
* @memberof ManagedClient
|
|
11278
|
+
*/
|
|
11279
|
+
'apiGatewayBaseUrl'?: string | null;
|
|
11280
|
+
/**
|
|
11281
|
+
*
|
|
11282
|
+
* @type {string}
|
|
11283
|
+
* @memberof ManagedClient
|
|
11284
|
+
*/
|
|
11285
|
+
'cookbook'?: string | null;
|
|
10852
11286
|
/**
|
|
10853
11287
|
* Previous CC ID to be used in data migration. (This field will be deleted after CC migration!)
|
|
10854
11288
|
* @type {number}
|
|
@@ -11373,6 +11807,38 @@ export interface ManagerCorrelationMapping {
|
|
|
11373
11807
|
*/
|
|
11374
11808
|
'identityAttributeName'?: string;
|
|
11375
11809
|
}
|
|
11810
|
+
/**
|
|
11811
|
+
*
|
|
11812
|
+
* @export
|
|
11813
|
+
* @interface ManualDiscoverApplications
|
|
11814
|
+
*/
|
|
11815
|
+
export interface ManualDiscoverApplications {
|
|
11816
|
+
/**
|
|
11817
|
+
* The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
11818
|
+
* @type {any}
|
|
11819
|
+
* @memberof ManualDiscoverApplications
|
|
11820
|
+
*/
|
|
11821
|
+
'file': any;
|
|
11822
|
+
}
|
|
11823
|
+
/**
|
|
11824
|
+
*
|
|
11825
|
+
* @export
|
|
11826
|
+
* @interface ManualDiscoverApplicationsTemplate
|
|
11827
|
+
*/
|
|
11828
|
+
export interface ManualDiscoverApplicationsTemplate {
|
|
11829
|
+
/**
|
|
11830
|
+
* Name of the application.
|
|
11831
|
+
* @type {string}
|
|
11832
|
+
* @memberof ManualDiscoverApplicationsTemplate
|
|
11833
|
+
*/
|
|
11834
|
+
'application_name'?: string;
|
|
11835
|
+
/**
|
|
11836
|
+
* Description of the application.
|
|
11837
|
+
* @type {string}
|
|
11838
|
+
* @memberof ManualDiscoverApplicationsTemplate
|
|
11839
|
+
*/
|
|
11840
|
+
'description'?: string;
|
|
11841
|
+
}
|
|
11376
11842
|
/**
|
|
11377
11843
|
*
|
|
11378
11844
|
* @export
|
|
@@ -14273,7 +14739,7 @@ export interface PendingApproval {
|
|
|
14273
14739
|
* @type {SodViolationContextCheckCompleted}
|
|
14274
14740
|
* @memberof PendingApproval
|
|
14275
14741
|
*/
|
|
14276
|
-
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
14742
|
+
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
14277
14743
|
}
|
|
14278
14744
|
/**
|
|
14279
14745
|
* Enum represents action that is being processed on an approval.
|
|
@@ -17172,7 +17638,7 @@ export interface RoleSummaryAllOf {
|
|
|
17172
17638
|
* @type Rule
|
|
17173
17639
|
* @export
|
|
17174
17640
|
*/
|
|
17175
|
-
export type Rule = GenerateRandomString |
|
|
17641
|
+
export type Rule = GenerateRandomString | GetReferenceIdentityAttribute | TransformRule;
|
|
17176
17642
|
/**
|
|
17177
17643
|
*
|
|
17178
17644
|
* @export
|
|
@@ -17702,8 +18168,40 @@ export interface ScheduledAttributes {
|
|
|
17702
18168
|
* @type {string}
|
|
17703
18169
|
* @memberof ScheduledAttributes
|
|
17704
18170
|
*/
|
|
17705
|
-
'cronString'
|
|
18171
|
+
'cronString'?: string;
|
|
18172
|
+
/**
|
|
18173
|
+
* Frequency of execution
|
|
18174
|
+
* @type {string}
|
|
18175
|
+
* @memberof ScheduledAttributes
|
|
18176
|
+
*/
|
|
18177
|
+
'frequency': ScheduledAttributesFrequencyEnum;
|
|
18178
|
+
/**
|
|
18179
|
+
* Time zone identifier
|
|
18180
|
+
* @type {string}
|
|
18181
|
+
* @memberof ScheduledAttributes
|
|
18182
|
+
*/
|
|
18183
|
+
'timeZone'?: string;
|
|
18184
|
+
/**
|
|
18185
|
+
* Scheduled days of the week for execution
|
|
18186
|
+
* @type {Array<string>}
|
|
18187
|
+
* @memberof ScheduledAttributes
|
|
18188
|
+
*/
|
|
18189
|
+
'weeklyDays'?: Array<string>;
|
|
18190
|
+
/**
|
|
18191
|
+
* Scheduled execution times
|
|
18192
|
+
* @type {Array<string>}
|
|
18193
|
+
* @memberof ScheduledAttributes
|
|
18194
|
+
*/
|
|
18195
|
+
'weeklyTimes'?: Array<string>;
|
|
17706
18196
|
}
|
|
18197
|
+
export declare const ScheduledAttributesFrequencyEnum: {
|
|
18198
|
+
readonly Daily: "daily";
|
|
18199
|
+
readonly Weekly: "weekly";
|
|
18200
|
+
readonly Monthly: "monthly";
|
|
18201
|
+
readonly Yearly: "yearly";
|
|
18202
|
+
readonly CronSchedule: "cronSchedule";
|
|
18203
|
+
};
|
|
18204
|
+
export type ScheduledAttributesFrequencyEnum = typeof ScheduledAttributesFrequencyEnum[keyof typeof ScheduledAttributesFrequencyEnum];
|
|
17707
18205
|
/**
|
|
17708
18206
|
*
|
|
17709
18207
|
* @export
|
|
@@ -18170,6 +18668,31 @@ export interface SearchArgumentsOwner {
|
|
|
18170
18668
|
*/
|
|
18171
18669
|
'id': string;
|
|
18172
18670
|
}
|
|
18671
|
+
/**
|
|
18672
|
+
*
|
|
18673
|
+
* @export
|
|
18674
|
+
* @interface SearchAttributeConfig
|
|
18675
|
+
*/
|
|
18676
|
+
export interface SearchAttributeConfig {
|
|
18677
|
+
/**
|
|
18678
|
+
* Name of the new attribute
|
|
18679
|
+
* @type {string}
|
|
18680
|
+
* @memberof SearchAttributeConfig
|
|
18681
|
+
*/
|
|
18682
|
+
'name'?: string;
|
|
18683
|
+
/**
|
|
18684
|
+
* The display name of the new attribute
|
|
18685
|
+
* @type {string}
|
|
18686
|
+
* @memberof SearchAttributeConfig
|
|
18687
|
+
*/
|
|
18688
|
+
'displayName'?: string;
|
|
18689
|
+
/**
|
|
18690
|
+
* Map of application id and their associated attribute.
|
|
18691
|
+
* @type {object}
|
|
18692
|
+
* @memberof SearchAttributeConfig
|
|
18693
|
+
*/
|
|
18694
|
+
'applicationAttributes'?: object;
|
|
18695
|
+
}
|
|
18173
18696
|
/**
|
|
18174
18697
|
* @type SearchDocument
|
|
18175
18698
|
* @export
|
|
@@ -19733,6 +20256,7 @@ export declare const SourceFeaturesEnum: {
|
|
|
19733
20256
|
};
|
|
19734
20257
|
export type SourceFeaturesEnum = typeof SourceFeaturesEnum[keyof typeof SourceFeaturesEnum];
|
|
19735
20258
|
export declare const SourceStatusEnum: {
|
|
20259
|
+
readonly ErrorAccountFileImport: "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT";
|
|
19736
20260
|
readonly ErrorCluster: "SOURCE_STATE_ERROR_CLUSTER";
|
|
19737
20261
|
readonly ErrorSource: "SOURCE_STATE_ERROR_SOURCE";
|
|
19738
20262
|
readonly ErrorVa: "SOURCE_STATE_ERROR_VA";
|
|
@@ -21080,6 +21604,25 @@ export interface TransformReadAllOf {
|
|
|
21080
21604
|
*/
|
|
21081
21605
|
'internal': boolean;
|
|
21082
21606
|
}
|
|
21607
|
+
/**
|
|
21608
|
+
*
|
|
21609
|
+
* @export
|
|
21610
|
+
* @interface TransformRule
|
|
21611
|
+
*/
|
|
21612
|
+
export interface TransformRule {
|
|
21613
|
+
/**
|
|
21614
|
+
* This is the name of the Transform rule that needs to be invoked by the transform
|
|
21615
|
+
* @type {string}
|
|
21616
|
+
* @memberof TransformRule
|
|
21617
|
+
*/
|
|
21618
|
+
'name': string;
|
|
21619
|
+
/**
|
|
21620
|
+
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
21621
|
+
* @type {boolean}
|
|
21622
|
+
* @memberof TransformRule
|
|
21623
|
+
*/
|
|
21624
|
+
'requiresPeriodicRefresh'?: boolean;
|
|
21625
|
+
}
|
|
21083
21626
|
/**
|
|
21084
21627
|
*
|
|
21085
21628
|
* @export
|
|
@@ -21597,6 +22140,143 @@ export interface Value {
|
|
|
21597
22140
|
*/
|
|
21598
22141
|
'value'?: string;
|
|
21599
22142
|
}
|
|
22143
|
+
/**
|
|
22144
|
+
*
|
|
22145
|
+
* @export
|
|
22146
|
+
* @interface VendorConnectorMapping
|
|
22147
|
+
*/
|
|
22148
|
+
export interface VendorConnectorMapping {
|
|
22149
|
+
/**
|
|
22150
|
+
* The unique identifier for the vendor-connector mapping.
|
|
22151
|
+
* @type {string}
|
|
22152
|
+
* @memberof VendorConnectorMapping
|
|
22153
|
+
*/
|
|
22154
|
+
'id'?: string;
|
|
22155
|
+
/**
|
|
22156
|
+
* The name of the vendor.
|
|
22157
|
+
* @type {string}
|
|
22158
|
+
* @memberof VendorConnectorMapping
|
|
22159
|
+
*/
|
|
22160
|
+
'vendor'?: string;
|
|
22161
|
+
/**
|
|
22162
|
+
* The name of the connector.
|
|
22163
|
+
* @type {string}
|
|
22164
|
+
* @memberof VendorConnectorMapping
|
|
22165
|
+
*/
|
|
22166
|
+
'connector'?: string;
|
|
22167
|
+
/**
|
|
22168
|
+
* The creation timestamp of the mapping.
|
|
22169
|
+
* @type {string}
|
|
22170
|
+
* @memberof VendorConnectorMapping
|
|
22171
|
+
*/
|
|
22172
|
+
'createdAt'?: string;
|
|
22173
|
+
/**
|
|
22174
|
+
* The identifier of the user who created the mapping.
|
|
22175
|
+
* @type {string}
|
|
22176
|
+
* @memberof VendorConnectorMapping
|
|
22177
|
+
*/
|
|
22178
|
+
'createdBy'?: string;
|
|
22179
|
+
/**
|
|
22180
|
+
*
|
|
22181
|
+
* @type {VendorConnectorMappingUpdatedAt}
|
|
22182
|
+
* @memberof VendorConnectorMapping
|
|
22183
|
+
*/
|
|
22184
|
+
'updatedAt'?: VendorConnectorMappingUpdatedAt | null;
|
|
22185
|
+
/**
|
|
22186
|
+
*
|
|
22187
|
+
* @type {VendorConnectorMappingUpdatedBy}
|
|
22188
|
+
* @memberof VendorConnectorMapping
|
|
22189
|
+
*/
|
|
22190
|
+
'updatedBy'?: VendorConnectorMappingUpdatedBy | null;
|
|
22191
|
+
/**
|
|
22192
|
+
*
|
|
22193
|
+
* @type {VendorConnectorMappingDeletedAt}
|
|
22194
|
+
* @memberof VendorConnectorMapping
|
|
22195
|
+
*/
|
|
22196
|
+
'deletedAt'?: VendorConnectorMappingDeletedAt | null;
|
|
22197
|
+
/**
|
|
22198
|
+
*
|
|
22199
|
+
* @type {VendorConnectorMappingDeletedBy}
|
|
22200
|
+
* @memberof VendorConnectorMapping
|
|
22201
|
+
*/
|
|
22202
|
+
'deletedBy'?: VendorConnectorMappingDeletedBy | null;
|
|
22203
|
+
}
|
|
22204
|
+
/**
|
|
22205
|
+
* An object representing the nullable timestamp of when the mapping was deleted.
|
|
22206
|
+
* @export
|
|
22207
|
+
* @interface VendorConnectorMappingDeletedAt
|
|
22208
|
+
*/
|
|
22209
|
+
export interface VendorConnectorMappingDeletedAt {
|
|
22210
|
+
/**
|
|
22211
|
+
* The timestamp when the mapping was deleted, represented in ISO 8601 format, if applicable.
|
|
22212
|
+
* @type {string}
|
|
22213
|
+
* @memberof VendorConnectorMappingDeletedAt
|
|
22214
|
+
*/
|
|
22215
|
+
'Time'?: string;
|
|
22216
|
+
/**
|
|
22217
|
+
* A flag indicating if the \'Time\' field is set and valid, i.e., if the mapping has been deleted.
|
|
22218
|
+
* @type {boolean}
|
|
22219
|
+
* @memberof VendorConnectorMappingDeletedAt
|
|
22220
|
+
*/
|
|
22221
|
+
'Valid'?: boolean;
|
|
22222
|
+
}
|
|
22223
|
+
/**
|
|
22224
|
+
* An object representing the nullable identifier of the user who deleted the mapping.
|
|
22225
|
+
* @export
|
|
22226
|
+
* @interface VendorConnectorMappingDeletedBy
|
|
22227
|
+
*/
|
|
22228
|
+
export interface VendorConnectorMappingDeletedBy {
|
|
22229
|
+
/**
|
|
22230
|
+
* The identifier of the user who deleted the mapping, if applicable.
|
|
22231
|
+
* @type {string}
|
|
22232
|
+
* @memberof VendorConnectorMappingDeletedBy
|
|
22233
|
+
*/
|
|
22234
|
+
'String'?: string;
|
|
22235
|
+
/**
|
|
22236
|
+
* A flag indicating if the \'String\' field is set and valid, i.e., if the mapping has been deleted.
|
|
22237
|
+
* @type {boolean}
|
|
22238
|
+
* @memberof VendorConnectorMappingDeletedBy
|
|
22239
|
+
*/
|
|
22240
|
+
'Valid'?: boolean;
|
|
22241
|
+
}
|
|
22242
|
+
/**
|
|
22243
|
+
* An object representing the nullable timestamp of the last update.
|
|
22244
|
+
* @export
|
|
22245
|
+
* @interface VendorConnectorMappingUpdatedAt
|
|
22246
|
+
*/
|
|
22247
|
+
export interface VendorConnectorMappingUpdatedAt {
|
|
22248
|
+
/**
|
|
22249
|
+
* The timestamp when the mapping was last updated, represented in ISO 8601 format.
|
|
22250
|
+
* @type {string}
|
|
22251
|
+
* @memberof VendorConnectorMappingUpdatedAt
|
|
22252
|
+
*/
|
|
22253
|
+
'Time'?: string;
|
|
22254
|
+
/**
|
|
22255
|
+
* A flag indicating if the \'Time\' field is set and valid.
|
|
22256
|
+
* @type {boolean}
|
|
22257
|
+
* @memberof VendorConnectorMappingUpdatedAt
|
|
22258
|
+
*/
|
|
22259
|
+
'Valid'?: boolean;
|
|
22260
|
+
}
|
|
22261
|
+
/**
|
|
22262
|
+
* An object representing the nullable identifier of the user who last updated the mapping.
|
|
22263
|
+
* @export
|
|
22264
|
+
* @interface VendorConnectorMappingUpdatedBy
|
|
22265
|
+
*/
|
|
22266
|
+
export interface VendorConnectorMappingUpdatedBy {
|
|
22267
|
+
/**
|
|
22268
|
+
* The identifier of the user who last updated the mapping, if available.
|
|
22269
|
+
* @type {string}
|
|
22270
|
+
* @memberof VendorConnectorMappingUpdatedBy
|
|
22271
|
+
*/
|
|
22272
|
+
'String'?: string;
|
|
22273
|
+
/**
|
|
22274
|
+
* A flag indicating if the \'String\' field is set and valid.
|
|
22275
|
+
* @type {boolean}
|
|
22276
|
+
* @memberof VendorConnectorMappingUpdatedBy
|
|
22277
|
+
*/
|
|
22278
|
+
'Valid'?: boolean;
|
|
22279
|
+
}
|
|
21600
22280
|
/**
|
|
21601
22281
|
*
|
|
21602
22282
|
* @export
|
|
@@ -21793,6 +22473,31 @@ export interface VisibilityCriteria {
|
|
|
21793
22473
|
*/
|
|
21794
22474
|
'expression'?: Expression;
|
|
21795
22475
|
}
|
|
22476
|
+
/**
|
|
22477
|
+
*
|
|
22478
|
+
* @export
|
|
22479
|
+
* @interface WorkItemForward
|
|
22480
|
+
*/
|
|
22481
|
+
export interface WorkItemForward {
|
|
22482
|
+
/**
|
|
22483
|
+
* The ID of the identity to forward this work item to.
|
|
22484
|
+
* @type {string}
|
|
22485
|
+
* @memberof WorkItemForward
|
|
22486
|
+
*/
|
|
22487
|
+
'targetOwnerId': string;
|
|
22488
|
+
/**
|
|
22489
|
+
* Comments to send to the target owner
|
|
22490
|
+
* @type {string}
|
|
22491
|
+
* @memberof WorkItemForward
|
|
22492
|
+
*/
|
|
22493
|
+
'comment': string;
|
|
22494
|
+
/**
|
|
22495
|
+
* If true, send a notification to the target owner.
|
|
22496
|
+
* @type {boolean}
|
|
22497
|
+
* @memberof WorkItemForward
|
|
22498
|
+
*/
|
|
22499
|
+
'sendNotifications'?: boolean;
|
|
22500
|
+
}
|
|
21796
22501
|
/**
|
|
21797
22502
|
* The state of a work item
|
|
21798
22503
|
* @export
|
|
@@ -22070,6 +22775,12 @@ export interface Workflow {
|
|
|
22070
22775
|
* @memberof Workflow
|
|
22071
22776
|
*/
|
|
22072
22777
|
'modified'?: string;
|
|
22778
|
+
/**
|
|
22779
|
+
*
|
|
22780
|
+
* @type {WorkflowModifiedBy}
|
|
22781
|
+
* @memberof Workflow
|
|
22782
|
+
*/
|
|
22783
|
+
'modifiedBy'?: WorkflowModifiedBy;
|
|
22073
22784
|
/**
|
|
22074
22785
|
*
|
|
22075
22786
|
* @type {WorkflowAllOfCreator}
|
|
@@ -22149,6 +22860,12 @@ export interface WorkflowAllOf {
|
|
|
22149
22860
|
* @memberof WorkflowAllOf
|
|
22150
22861
|
*/
|
|
22151
22862
|
'modified'?: string;
|
|
22863
|
+
/**
|
|
22864
|
+
*
|
|
22865
|
+
* @type {WorkflowModifiedBy}
|
|
22866
|
+
* @memberof WorkflowAllOf
|
|
22867
|
+
*/
|
|
22868
|
+
'modifiedBy'?: WorkflowModifiedBy;
|
|
22152
22869
|
/**
|
|
22153
22870
|
*
|
|
22154
22871
|
* @type {WorkflowAllOfCreator}
|
|
@@ -22403,7 +23120,37 @@ export interface WorkflowLibraryAction {
|
|
|
22403
23120
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
22404
23121
|
* @memberof WorkflowLibraryAction
|
|
22405
23122
|
*/
|
|
22406
|
-
'formFields'?: Array<WorkflowLibraryFormFields
|
|
23123
|
+
'formFields'?: Array<WorkflowLibraryFormFields> | null;
|
|
23124
|
+
/**
|
|
23125
|
+
*
|
|
23126
|
+
* @type {WorkflowLibraryActionExampleOutput}
|
|
23127
|
+
* @memberof WorkflowLibraryAction
|
|
23128
|
+
*/
|
|
23129
|
+
'exampleOutput'?: WorkflowLibraryActionExampleOutput;
|
|
23130
|
+
/**
|
|
23131
|
+
*
|
|
23132
|
+
* @type {boolean}
|
|
23133
|
+
* @memberof WorkflowLibraryAction
|
|
23134
|
+
*/
|
|
23135
|
+
'deprecated'?: boolean;
|
|
23136
|
+
/**
|
|
23137
|
+
*
|
|
23138
|
+
* @type {string}
|
|
23139
|
+
* @memberof WorkflowLibraryAction
|
|
23140
|
+
*/
|
|
23141
|
+
'deprecatedBy'?: string;
|
|
23142
|
+
/**
|
|
23143
|
+
* Version number
|
|
23144
|
+
* @type {number}
|
|
23145
|
+
* @memberof WorkflowLibraryAction
|
|
23146
|
+
*/
|
|
23147
|
+
'versionNumber'?: number;
|
|
23148
|
+
/**
|
|
23149
|
+
*
|
|
23150
|
+
* @type {boolean}
|
|
23151
|
+
* @memberof WorkflowLibraryAction
|
|
23152
|
+
*/
|
|
23153
|
+
'isSimulationEnabled'?: boolean;
|
|
22407
23154
|
/**
|
|
22408
23155
|
* Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
22409
23156
|
* @type {boolean}
|
|
@@ -22417,12 +23164,23 @@ export interface WorkflowLibraryAction {
|
|
|
22417
23164
|
*/
|
|
22418
23165
|
'outputSchema'?: object;
|
|
22419
23166
|
}
|
|
23167
|
+
/**
|
|
23168
|
+
* @type WorkflowLibraryActionExampleOutput
|
|
23169
|
+
* @export
|
|
23170
|
+
*/
|
|
23171
|
+
export type WorkflowLibraryActionExampleOutput = Array<object> | object;
|
|
22420
23172
|
/**
|
|
22421
23173
|
*
|
|
22422
23174
|
* @export
|
|
22423
23175
|
* @interface WorkflowLibraryFormFields
|
|
22424
23176
|
*/
|
|
22425
23177
|
export interface WorkflowLibraryFormFields {
|
|
23178
|
+
/**
|
|
23179
|
+
* Description of the form field
|
|
23180
|
+
* @type {string}
|
|
23181
|
+
* @memberof WorkflowLibraryFormFields
|
|
23182
|
+
*/
|
|
23183
|
+
'description'?: string;
|
|
22426
23184
|
/**
|
|
22427
23185
|
* Describes the form field in the UI
|
|
22428
23186
|
* @type {string}
|
|
@@ -22449,7 +23207,7 @@ export interface WorkflowLibraryFormFields {
|
|
|
22449
23207
|
'required'?: boolean;
|
|
22450
23208
|
/**
|
|
22451
23209
|
* The type of the form field
|
|
22452
|
-
* @type {
|
|
23210
|
+
* @type {string}
|
|
22453
23211
|
* @memberof WorkflowLibraryFormFields
|
|
22454
23212
|
*/
|
|
22455
23213
|
'type'?: WorkflowLibraryFormFieldsTypeEnum;
|
|
@@ -22468,6 +23226,7 @@ export declare const WorkflowLibraryFormFieldsTypeEnum: {
|
|
|
22468
23226
|
readonly MultiType: "multiType";
|
|
22469
23227
|
readonly Duration: "duration";
|
|
22470
23228
|
readonly Toggle: "toggle";
|
|
23229
|
+
readonly FormPicker: "formPicker";
|
|
22471
23230
|
readonly IdentityPicker: "identityPicker";
|
|
22472
23231
|
readonly GovernanceGroupPicker: "governanceGroupPicker";
|
|
22473
23232
|
readonly String: "string";
|
|
@@ -22477,6 +23236,8 @@ export declare const WorkflowLibraryFormFieldsTypeEnum: {
|
|
|
22477
23236
|
readonly KeyValuePairs: "keyValuePairs";
|
|
22478
23237
|
readonly EmailPicker: "emailPicker";
|
|
22479
23238
|
readonly AdvancedToggle: "advancedToggle";
|
|
23239
|
+
readonly VariableCreator: "variableCreator";
|
|
23240
|
+
readonly HtmlEditor: "htmlEditor";
|
|
22480
23241
|
};
|
|
22481
23242
|
export type WorkflowLibraryFormFieldsTypeEnum = typeof WorkflowLibraryFormFieldsTypeEnum[keyof typeof WorkflowLibraryFormFieldsTypeEnum];
|
|
22482
23243
|
/**
|
|
@@ -22509,12 +23270,36 @@ export interface WorkflowLibraryOperator {
|
|
|
22509
23270
|
* @memberof WorkflowLibraryOperator
|
|
22510
23271
|
*/
|
|
22511
23272
|
'description'?: string;
|
|
23273
|
+
/**
|
|
23274
|
+
* Determines whether the dynamic output schema is returned in place of the action\'s output schema. The dynamic schema lists non-static properties, like properties of a workflow form where each form has different fields. These will be provided dynamically based on available form fields.
|
|
23275
|
+
* @type {boolean}
|
|
23276
|
+
* @memberof WorkflowLibraryOperator
|
|
23277
|
+
*/
|
|
23278
|
+
'isDynamicSchema'?: boolean;
|
|
23279
|
+
/**
|
|
23280
|
+
*
|
|
23281
|
+
* @type {boolean}
|
|
23282
|
+
* @memberof WorkflowLibraryOperator
|
|
23283
|
+
*/
|
|
23284
|
+
'deprecated'?: boolean;
|
|
23285
|
+
/**
|
|
23286
|
+
*
|
|
23287
|
+
* @type {string}
|
|
23288
|
+
* @memberof WorkflowLibraryOperator
|
|
23289
|
+
*/
|
|
23290
|
+
'deprecatedBy'?: string;
|
|
23291
|
+
/**
|
|
23292
|
+
*
|
|
23293
|
+
* @type {boolean}
|
|
23294
|
+
* @memberof WorkflowLibraryOperator
|
|
23295
|
+
*/
|
|
23296
|
+
'isSimulationEnabled'?: boolean;
|
|
22512
23297
|
/**
|
|
22513
23298
|
* One or more inputs that the operator accepts
|
|
22514
23299
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
22515
23300
|
* @memberof WorkflowLibraryOperator
|
|
22516
23301
|
*/
|
|
22517
|
-
'formFields'?: Array<WorkflowLibraryFormFields
|
|
23302
|
+
'formFields'?: Array<WorkflowLibraryFormFields> | null;
|
|
22518
23303
|
}
|
|
22519
23304
|
/**
|
|
22520
23305
|
*
|
|
@@ -22530,10 +23315,34 @@ export interface WorkflowLibraryTrigger {
|
|
|
22530
23315
|
'id'?: string;
|
|
22531
23316
|
/**
|
|
22532
23317
|
* Trigger type
|
|
22533
|
-
* @type {
|
|
23318
|
+
* @type {string}
|
|
22534
23319
|
* @memberof WorkflowLibraryTrigger
|
|
22535
23320
|
*/
|
|
22536
23321
|
'type'?: WorkflowLibraryTriggerTypeEnum;
|
|
23322
|
+
/**
|
|
23323
|
+
*
|
|
23324
|
+
* @type {boolean}
|
|
23325
|
+
* @memberof WorkflowLibraryTrigger
|
|
23326
|
+
*/
|
|
23327
|
+
'deprecated'?: boolean;
|
|
23328
|
+
/**
|
|
23329
|
+
*
|
|
23330
|
+
* @type {string}
|
|
23331
|
+
* @memberof WorkflowLibraryTrigger
|
|
23332
|
+
*/
|
|
23333
|
+
'deprecatedBy'?: string;
|
|
23334
|
+
/**
|
|
23335
|
+
*
|
|
23336
|
+
* @type {boolean}
|
|
23337
|
+
* @memberof WorkflowLibraryTrigger
|
|
23338
|
+
*/
|
|
23339
|
+
'isSimulationEnabled'?: boolean;
|
|
23340
|
+
/**
|
|
23341
|
+
* Example output schema
|
|
23342
|
+
* @type {object}
|
|
23343
|
+
* @memberof WorkflowLibraryTrigger
|
|
23344
|
+
*/
|
|
23345
|
+
'outputSchema'?: object;
|
|
22537
23346
|
/**
|
|
22538
23347
|
* Trigger Name
|
|
22539
23348
|
* @type {string}
|
|
@@ -22571,6 +23380,35 @@ export declare const WorkflowLibraryTriggerTypeEnum: {
|
|
|
22571
23380
|
readonly External: "EXTERNAL";
|
|
22572
23381
|
};
|
|
22573
23382
|
export type WorkflowLibraryTriggerTypeEnum = typeof WorkflowLibraryTriggerTypeEnum[keyof typeof WorkflowLibraryTriggerTypeEnum];
|
|
23383
|
+
/**
|
|
23384
|
+
*
|
|
23385
|
+
* @export
|
|
23386
|
+
* @interface WorkflowModifiedBy
|
|
23387
|
+
*/
|
|
23388
|
+
export interface WorkflowModifiedBy {
|
|
23389
|
+
/**
|
|
23390
|
+
*
|
|
23391
|
+
* @type {string}
|
|
23392
|
+
* @memberof WorkflowModifiedBy
|
|
23393
|
+
*/
|
|
23394
|
+
'type'?: WorkflowModifiedByTypeEnum;
|
|
23395
|
+
/**
|
|
23396
|
+
* Identity ID
|
|
23397
|
+
* @type {string}
|
|
23398
|
+
* @memberof WorkflowModifiedBy
|
|
23399
|
+
*/
|
|
23400
|
+
'id'?: string;
|
|
23401
|
+
/**
|
|
23402
|
+
* Human-readable display name of identity.
|
|
23403
|
+
* @type {string}
|
|
23404
|
+
* @memberof WorkflowModifiedBy
|
|
23405
|
+
*/
|
|
23406
|
+
'name'?: string;
|
|
23407
|
+
}
|
|
23408
|
+
export declare const WorkflowModifiedByTypeEnum: {
|
|
23409
|
+
readonly Identity: "IDENTITY";
|
|
23410
|
+
};
|
|
23411
|
+
export type WorkflowModifiedByTypeEnum = typeof WorkflowModifiedByTypeEnum[keyof typeof WorkflowModifiedByTypeEnum];
|
|
22574
23412
|
/**
|
|
22575
23413
|
*
|
|
22576
23414
|
* @export
|
|
@@ -22671,28 +23509,28 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
22671
23509
|
*/
|
|
22672
23510
|
getAccessProfile: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22673
23511
|
/**
|
|
22674
|
-
*
|
|
23512
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22675
23513
|
* @summary List Access Profile\'s Entitlements
|
|
22676
|
-
* @param {string} id ID of the containing
|
|
23514
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22677
23515
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22678
23516
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22679
23517
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22680
|
-
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
23518
|
+
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22681
23519
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
|
|
22682
23520
|
* @param {*} [axiosOptions] Override http request option.
|
|
22683
23521
|
* @throws {RequiredError}
|
|
22684
23522
|
*/
|
|
22685
23523
|
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22686
23524
|
/**
|
|
22687
|
-
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23525
|
+
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22688
23526
|
* @summary List Access Profiles
|
|
22689
|
-
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN
|
|
23527
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
22690
23528
|
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22691
23529
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22692
23530
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22693
23531
|
* @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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22694
23532
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
22695
|
-
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the
|
|
23533
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
22696
23534
|
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
22697
23535
|
* @param {*} [axiosOptions] Override http request option.
|
|
22698
23536
|
* @throws {RequiredError}
|
|
@@ -22746,28 +23584,28 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
22746
23584
|
*/
|
|
22747
23585
|
getAccessProfile(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
22748
23586
|
/**
|
|
22749
|
-
*
|
|
23587
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22750
23588
|
* @summary List Access Profile\'s Entitlements
|
|
22751
|
-
* @param {string} id ID of the containing
|
|
23589
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22752
23590
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22753
23591
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22754
23592
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22755
|
-
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
23593
|
+
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22756
23594
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
|
|
22757
23595
|
* @param {*} [axiosOptions] Override http request option.
|
|
22758
23596
|
* @throws {RequiredError}
|
|
22759
23597
|
*/
|
|
22760
23598
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
22761
23599
|
/**
|
|
22762
|
-
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23600
|
+
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22763
23601
|
* @summary List Access Profiles
|
|
22764
|
-
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN
|
|
23602
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
22765
23603
|
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22766
23604
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22767
23605
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22768
23606
|
* @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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22769
23607
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
22770
|
-
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the
|
|
23608
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
22771
23609
|
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
22772
23610
|
* @param {*} [axiosOptions] Override http request option.
|
|
22773
23611
|
* @throws {RequiredError}
|
|
@@ -22821,28 +23659,28 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
22821
23659
|
*/
|
|
22822
23660
|
getAccessProfile(id: string, axiosOptions?: any): AxiosPromise<AccessProfile>;
|
|
22823
23661
|
/**
|
|
22824
|
-
*
|
|
23662
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22825
23663
|
* @summary List Access Profile\'s Entitlements
|
|
22826
|
-
* @param {string} id ID of the containing
|
|
23664
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22827
23665
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22828
23666
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22829
23667
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22830
|
-
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
23668
|
+
* @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: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22831
23669
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified**
|
|
22832
23670
|
* @param {*} [axiosOptions] Override http request option.
|
|
22833
23671
|
* @throws {RequiredError}
|
|
22834
23672
|
*/
|
|
22835
23673
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Entitlement>>;
|
|
22836
23674
|
/**
|
|
22837
|
-
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23675
|
+
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
22838
23676
|
* @summary List Access Profiles
|
|
22839
|
-
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN
|
|
23677
|
+
* @param {string} [forSubadmin] If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
22840
23678
|
* @param {number} [limit] Note that for this API the maximum value for limit is 50. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22841
23679
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22842
23680
|
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
22843
23681
|
* @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: **id**: *eq, in* **name**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* Composite operators supported: *and, or* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22844
23682
|
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified**
|
|
22845
|
-
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the
|
|
23683
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
22846
23684
|
* @param {boolean} [includeUnsegmented] Indicates whether the response list should contain unsegmented access profiles. If *for-segment-ids* is absent or empty, specifying *include-unsegmented* as false results in an error.
|
|
22847
23685
|
* @param {*} [axiosOptions] Override http request option.
|
|
22848
23686
|
* @throws {RequiredError}
|
|
@@ -22917,7 +23755,7 @@ export interface AccessProfilesApiGetAccessProfileRequest {
|
|
|
22917
23755
|
*/
|
|
22918
23756
|
export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
22919
23757
|
/**
|
|
22920
|
-
* ID of the containing
|
|
23758
|
+
* ID of the access profile containing the entitlements.
|
|
22921
23759
|
* @type {string}
|
|
22922
23760
|
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
22923
23761
|
*/
|
|
@@ -22941,7 +23779,7 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
22941
23779
|
*/
|
|
22942
23780
|
readonly count?: boolean;
|
|
22943
23781
|
/**
|
|
22944
|
-
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in*
|
|
23782
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, sw* **attribute**: *eq, sw* **value**: *eq, sw* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **source.id**: *eq, in* Filtering is not supported for access profiles and entitlements that have the \'+\' symbol in their names.
|
|
22945
23783
|
* @type {string}
|
|
22946
23784
|
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
22947
23785
|
*/
|
|
@@ -22960,7 +23798,7 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
22960
23798
|
*/
|
|
22961
23799
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
22962
23800
|
/**
|
|
22963
|
-
* If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN
|
|
23801
|
+
* If provided, filters the returned list according to what is visible to the indicated ROLE_SUBADMIN or SOURCE_SUBADMIN identity. The value of the parameter is either an identity ID, or the special value **me**, which is shorthand for the calling identity\'s ID. A 400 Bad Request error is returned if the **for-subadmin** parameter is specified for an identity that is not a subadmin.
|
|
22964
23802
|
* @type {string}
|
|
22965
23803
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
22966
23804
|
*/
|
|
@@ -22996,7 +23834,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
22996
23834
|
*/
|
|
22997
23835
|
readonly sorters?: string;
|
|
22998
23836
|
/**
|
|
22999
|
-
* If present and not empty, additionally filters access profiles to those which are assigned to the
|
|
23837
|
+
* If present and not empty, additionally filters access profiles to those which are assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
23000
23838
|
* @type {string}
|
|
23001
23839
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
23002
23840
|
*/
|
|
@@ -23071,7 +23909,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
23071
23909
|
*/
|
|
23072
23910
|
getAccessProfile(requestParameters: AccessProfilesApiGetAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
23073
23911
|
/**
|
|
23074
|
-
*
|
|
23912
|
+
* Use this API to get a list of an access profile\'s entitlements. A token with API, ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. In addition, a token with SOURCE_SUBADMIN authority must have access to the source associated with the specified access profile. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23075
23913
|
* @summary List Access Profile\'s Entitlements
|
|
23076
23914
|
* @param {AccessProfilesApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters.
|
|
23077
23915
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23080,7 +23918,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
23080
23918
|
*/
|
|
23081
23919
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
23082
23920
|
/**
|
|
23083
|
-
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
23921
|
+
* Use this API to get a list of access profiles. A token with API, ORG_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
23084
23922
|
* @summary List Access Profiles
|
|
23085
23923
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
23086
23924
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24197,7 +25035,7 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
24197
25035
|
*/
|
|
24198
25036
|
listAccounts: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24199
25037
|
/**
|
|
24200
|
-
* Use this API to update an account with a PUT request.
|
|
25038
|
+
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
24201
25039
|
* @summary Update Account
|
|
24202
25040
|
* @param {string} id Account ID.
|
|
24203
25041
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -24223,14 +25061,14 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
24223
25061
|
*/
|
|
24224
25062
|
unlockAccount: (id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24225
25063
|
/**
|
|
24226
|
-
*
|
|
25064
|
+
* Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts.
|
|
24227
25065
|
* @summary Update Account
|
|
24228
25066
|
* @param {string} id Account ID.
|
|
24229
|
-
* @param {Array<
|
|
25067
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
24230
25068
|
* @param {*} [axiosOptions] Override http request option.
|
|
24231
25069
|
* @throws {RequiredError}
|
|
24232
25070
|
*/
|
|
24233
|
-
updateAccount: (id: string,
|
|
25071
|
+
updateAccount: (id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24234
25072
|
};
|
|
24235
25073
|
/**
|
|
24236
25074
|
* AccountsApi - functional programming interface
|
|
@@ -24303,7 +25141,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
24303
25141
|
*/
|
|
24304
25142
|
listAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
24305
25143
|
/**
|
|
24306
|
-
* Use this API to update an account with a PUT request.
|
|
25144
|
+
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
24307
25145
|
* @summary Update Account
|
|
24308
25146
|
* @param {string} id Account ID.
|
|
24309
25147
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -24329,14 +25167,14 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
24329
25167
|
*/
|
|
24330
25168
|
unlockAccount(id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountsAsyncResult>>;
|
|
24331
25169
|
/**
|
|
24332
|
-
*
|
|
25170
|
+
* Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts.
|
|
24333
25171
|
* @summary Update Account
|
|
24334
25172
|
* @param {string} id Account ID.
|
|
24335
|
-
* @param {Array<
|
|
25173
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
24336
25174
|
* @param {*} [axiosOptions] Override http request option.
|
|
24337
25175
|
* @throws {RequiredError}
|
|
24338
25176
|
*/
|
|
24339
|
-
updateAccount(id: string,
|
|
25177
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
24340
25178
|
};
|
|
24341
25179
|
/**
|
|
24342
25180
|
* AccountsApi - factory interface
|
|
@@ -24409,7 +25247,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
24409
25247
|
*/
|
|
24410
25248
|
listAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Account>>;
|
|
24411
25249
|
/**
|
|
24412
|
-
* Use this API to update an account with a PUT request.
|
|
25250
|
+
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
24413
25251
|
* @summary Update Account
|
|
24414
25252
|
* @param {string} id Account ID.
|
|
24415
25253
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -24435,14 +25273,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
24435
25273
|
*/
|
|
24436
25274
|
unlockAccount(id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: any): AxiosPromise<AccountsAsyncResult>;
|
|
24437
25275
|
/**
|
|
24438
|
-
*
|
|
25276
|
+
* Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts.
|
|
24439
25277
|
* @summary Update Account
|
|
24440
25278
|
* @param {string} id Account ID.
|
|
24441
|
-
* @param {Array<
|
|
25279
|
+
* @param {Array<object>} requestBody A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
24442
25280
|
* @param {*} [axiosOptions] Override http request option.
|
|
24443
25281
|
* @throws {RequiredError}
|
|
24444
25282
|
*/
|
|
24445
|
-
updateAccount(id: string,
|
|
25283
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: any): AxiosPromise<object>;
|
|
24446
25284
|
};
|
|
24447
25285
|
/**
|
|
24448
25286
|
* Request parameters for createAccount operation in AccountsApi.
|
|
@@ -24654,10 +25492,10 @@ export interface AccountsApiUpdateAccountRequest {
|
|
|
24654
25492
|
readonly id: string;
|
|
24655
25493
|
/**
|
|
24656
25494
|
* A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
24657
|
-
* @type {Array<
|
|
25495
|
+
* @type {Array<object>}
|
|
24658
25496
|
* @memberof AccountsApiUpdateAccount
|
|
24659
25497
|
*/
|
|
24660
|
-
readonly
|
|
25498
|
+
readonly requestBody: Array<object>;
|
|
24661
25499
|
}
|
|
24662
25500
|
/**
|
|
24663
25501
|
* AccountsApi - object-oriented interface
|
|
@@ -24730,7 +25568,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24730
25568
|
*/
|
|
24731
25569
|
listAccounts(requestParameters?: AccountsApiListAccountsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
|
|
24732
25570
|
/**
|
|
24733
|
-
* Use this API to update an account with a PUT request.
|
|
25571
|
+
* Use this API to update an account with a PUT request. This endpoint submits an account update task and returns the task ID. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. >**Note: You can only use this PUT endpoint to update accounts from flat file sources.**
|
|
24734
25572
|
* @summary Update Account
|
|
24735
25573
|
* @param {AccountsApiPutAccountRequest} requestParameters Request parameters.
|
|
24736
25574
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24757,7 +25595,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24757
25595
|
*/
|
|
24758
25596
|
unlockAccount(requestParameters: AccountsApiUnlockAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountsAsyncResult, any>>;
|
|
24759
25597
|
/**
|
|
24760
|
-
*
|
|
25598
|
+
* Use this API to update account details. A token with ORG_ADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API. This API supports updating an account\'s correlation by modifying the `identityId` and `manuallyCorrelated` fields. To reassign an account from one identity to another, replace the current `identityId` with a new value. If the account you\'re assigning was provisioned by Identity Security Cloud (ISC), it\'s possible for ISC to create a new account for the previous identity as soon as the account is moved. If the account you\'re assigning is authoritative, this causes the previous identity to become uncorrelated and can even result in its deletion. All accounts that are reassigned will be set to `manuallyCorrelated: true` unless you specify otherwise. >**Note:** The `attributes` field can only be modified for flat file accounts.
|
|
24761
25599
|
* @summary Update Account
|
|
24762
25600
|
* @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters.
|
|
24763
25601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24766,6 +25604,209 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24766
25604
|
*/
|
|
24767
25605
|
updateAccount(requestParameters: AccountsApiUpdateAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
24768
25606
|
}
|
|
25607
|
+
/**
|
|
25608
|
+
* ApplicationDiscoveryApi - axios parameter creator
|
|
25609
|
+
* @export
|
|
25610
|
+
*/
|
|
25611
|
+
export declare const ApplicationDiscoveryApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25612
|
+
/**
|
|
25613
|
+
* Fetches a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
|
|
25614
|
+
* @summary Retrieve discovered applications for tenant
|
|
25615
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25616
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25617
|
+
* @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co*
|
|
25618
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
|
|
25619
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25620
|
+
* @throws {RequiredError}
|
|
25621
|
+
*/
|
|
25622
|
+
getDiscoveredApplications: (limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25623
|
+
/**
|
|
25624
|
+
* This endpoint allows the user to download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
|
|
25625
|
+
* @summary CSV template download for discovery
|
|
25626
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25627
|
+
* @throws {RequiredError}
|
|
25628
|
+
*/
|
|
25629
|
+
getManualDiscoverApplicationsCsvTemplate: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25630
|
+
/**
|
|
25631
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
25632
|
+
* @summary List vendor connector mappings
|
|
25633
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25634
|
+
* @throws {RequiredError}
|
|
25635
|
+
*/
|
|
25636
|
+
getVendorConnectorMappings: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25637
|
+
/**
|
|
25638
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
25639
|
+
* @summary CSV Upload to discover applications
|
|
25640
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
25641
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25642
|
+
* @throws {RequiredError}
|
|
25643
|
+
*/
|
|
25644
|
+
sendManualDiscoverApplicationsCsvTemplate: (file: any, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25645
|
+
};
|
|
25646
|
+
/**
|
|
25647
|
+
* ApplicationDiscoveryApi - functional programming interface
|
|
25648
|
+
* @export
|
|
25649
|
+
*/
|
|
25650
|
+
export declare const ApplicationDiscoveryApiFp: (configuration?: Configuration) => {
|
|
25651
|
+
/**
|
|
25652
|
+
* Fetches a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
|
|
25653
|
+
* @summary Retrieve discovered applications for tenant
|
|
25654
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25655
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25656
|
+
* @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co*
|
|
25657
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
|
|
25658
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25659
|
+
* @throws {RequiredError}
|
|
25660
|
+
*/
|
|
25661
|
+
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<DiscoveredApplicationsInner>>>>;
|
|
25662
|
+
/**
|
|
25663
|
+
* This endpoint allows the user to download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
|
|
25664
|
+
* @summary CSV template download for discovery
|
|
25665
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25666
|
+
* @throws {RequiredError}
|
|
25667
|
+
*/
|
|
25668
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ManualDiscoverApplicationsTemplate>>;
|
|
25669
|
+
/**
|
|
25670
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
25671
|
+
* @summary List vendor connector mappings
|
|
25672
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25673
|
+
* @throws {RequiredError}
|
|
25674
|
+
*/
|
|
25675
|
+
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<VendorConnectorMapping>>>;
|
|
25676
|
+
/**
|
|
25677
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
25678
|
+
* @summary CSV Upload to discover applications
|
|
25679
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
25680
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25681
|
+
* @throws {RequiredError}
|
|
25682
|
+
*/
|
|
25683
|
+
sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25684
|
+
};
|
|
25685
|
+
/**
|
|
25686
|
+
* ApplicationDiscoveryApi - factory interface
|
|
25687
|
+
* @export
|
|
25688
|
+
*/
|
|
25689
|
+
export declare const ApplicationDiscoveryApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25690
|
+
/**
|
|
25691
|
+
* Fetches a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
|
|
25692
|
+
* @summary Retrieve discovered applications for tenant
|
|
25693
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25694
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25695
|
+
* @param {string} [filter] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co*
|
|
25696
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
|
|
25697
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25698
|
+
* @throws {RequiredError}
|
|
25699
|
+
*/
|
|
25700
|
+
getDiscoveredApplications(limit?: number, offset?: number, filter?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Array<DiscoveredApplicationsInner>>>;
|
|
25701
|
+
/**
|
|
25702
|
+
* This endpoint allows the user to download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
|
|
25703
|
+
* @summary CSV template download for discovery
|
|
25704
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25705
|
+
* @throws {RequiredError}
|
|
25706
|
+
*/
|
|
25707
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: any): AxiosPromise<ManualDiscoverApplicationsTemplate>;
|
|
25708
|
+
/**
|
|
25709
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
25710
|
+
* @summary List vendor connector mappings
|
|
25711
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25712
|
+
* @throws {RequiredError}
|
|
25713
|
+
*/
|
|
25714
|
+
getVendorConnectorMappings(axiosOptions?: any): AxiosPromise<Array<VendorConnectorMapping>>;
|
|
25715
|
+
/**
|
|
25716
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
25717
|
+
* @summary CSV Upload to discover applications
|
|
25718
|
+
* @param {any} file The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
25719
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25720
|
+
* @throws {RequiredError}
|
|
25721
|
+
*/
|
|
25722
|
+
sendManualDiscoverApplicationsCsvTemplate(file: any, axiosOptions?: any): AxiosPromise<void>;
|
|
25723
|
+
};
|
|
25724
|
+
/**
|
|
25725
|
+
* Request parameters for getDiscoveredApplications operation in ApplicationDiscoveryApi.
|
|
25726
|
+
* @export
|
|
25727
|
+
* @interface ApplicationDiscoveryApiGetDiscoveredApplicationsRequest
|
|
25728
|
+
*/
|
|
25729
|
+
export interface ApplicationDiscoveryApiGetDiscoveredApplicationsRequest {
|
|
25730
|
+
/**
|
|
25731
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25732
|
+
* @type {number}
|
|
25733
|
+
* @memberof ApplicationDiscoveryApiGetDiscoveredApplications
|
|
25734
|
+
*/
|
|
25735
|
+
readonly limit?: number;
|
|
25736
|
+
/**
|
|
25737
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25738
|
+
* @type {number}
|
|
25739
|
+
* @memberof ApplicationDiscoveryApiGetDiscoveredApplications
|
|
25740
|
+
*/
|
|
25741
|
+
readonly offset?: number;
|
|
25742
|
+
/**
|
|
25743
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **name**: *eq, sw, co* **description**: *eq, sw, co*
|
|
25744
|
+
* @type {string}
|
|
25745
|
+
* @memberof ApplicationDiscoveryApiGetDiscoveredApplications
|
|
25746
|
+
*/
|
|
25747
|
+
readonly filter?: string;
|
|
25748
|
+
/**
|
|
25749
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, description, discoveredAt, discoverySource**
|
|
25750
|
+
* @type {string}
|
|
25751
|
+
* @memberof ApplicationDiscoveryApiGetDiscoveredApplications
|
|
25752
|
+
*/
|
|
25753
|
+
readonly sorters?: string;
|
|
25754
|
+
}
|
|
25755
|
+
/**
|
|
25756
|
+
* Request parameters for sendManualDiscoverApplicationsCsvTemplate operation in ApplicationDiscoveryApi.
|
|
25757
|
+
* @export
|
|
25758
|
+
* @interface ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest
|
|
25759
|
+
*/
|
|
25760
|
+
export interface ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest {
|
|
25761
|
+
/**
|
|
25762
|
+
* The CSV file to upload containing `application_name` and `description` columns. Each row represents an application to be discovered.
|
|
25763
|
+
* @type {any}
|
|
25764
|
+
* @memberof ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplate
|
|
25765
|
+
*/
|
|
25766
|
+
readonly file: any;
|
|
25767
|
+
}
|
|
25768
|
+
/**
|
|
25769
|
+
* ApplicationDiscoveryApi - object-oriented interface
|
|
25770
|
+
* @export
|
|
25771
|
+
* @class ApplicationDiscoveryApi
|
|
25772
|
+
* @extends {BaseAPI}
|
|
25773
|
+
*/
|
|
25774
|
+
export declare class ApplicationDiscoveryApi extends BaseAPI {
|
|
25775
|
+
/**
|
|
25776
|
+
* Fetches a list of applications that have been identified within the environment. This includes details such as application names, discovery dates, potential correlated saas_vendors and related suggested connectors.
|
|
25777
|
+
* @summary Retrieve discovered applications for tenant
|
|
25778
|
+
* @param {ApplicationDiscoveryApiGetDiscoveredApplicationsRequest} requestParameters Request parameters.
|
|
25779
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25780
|
+
* @throws {RequiredError}
|
|
25781
|
+
* @memberof ApplicationDiscoveryApi
|
|
25782
|
+
*/
|
|
25783
|
+
getDiscoveredApplications(requestParameters?: ApplicationDiscoveryApiGetDiscoveredApplicationsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DiscoveredApplicationsInner[][], any>>;
|
|
25784
|
+
/**
|
|
25785
|
+
* This endpoint allows the user to download an example CSV file with two columns `application_name` and `description`. The CSV file contains a single row with the values \'Example Application\' and \'Example Description\'. The downloaded template is specifically designed for use with the `/manual-discover-applications` endpoint.
|
|
25786
|
+
* @summary CSV template download for discovery
|
|
25787
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25788
|
+
* @throws {RequiredError}
|
|
25789
|
+
* @memberof ApplicationDiscoveryApi
|
|
25790
|
+
*/
|
|
25791
|
+
getManualDiscoverApplicationsCsvTemplate(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ManualDiscoverApplicationsTemplate, any>>;
|
|
25792
|
+
/**
|
|
25793
|
+
* Retrieves a list of mappings between SaaS vendors and IDN connectors, detailing the connections established for correlation.
|
|
25794
|
+
* @summary List vendor connector mappings
|
|
25795
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25796
|
+
* @throws {RequiredError}
|
|
25797
|
+
* @memberof ApplicationDiscoveryApi
|
|
25798
|
+
*/
|
|
25799
|
+
getVendorConnectorMappings(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMapping[], any>>;
|
|
25800
|
+
/**
|
|
25801
|
+
* This endpoint supports uploading a CSV file with application data for manual correlation to specific IDN connectors. If a suitable IDN connector is unavailable, the system will recommend generic connectors instead.
|
|
25802
|
+
* @summary CSV Upload to discover applications
|
|
25803
|
+
* @param {ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest} requestParameters Request parameters.
|
|
25804
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
25805
|
+
* @throws {RequiredError}
|
|
25806
|
+
* @memberof ApplicationDiscoveryApi
|
|
25807
|
+
*/
|
|
25808
|
+
sendManualDiscoverApplicationsCsvTemplate(requestParameters: ApplicationDiscoveryApiSendManualDiscoverApplicationsCsvTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
25809
|
+
}
|
|
24769
25810
|
/**
|
|
24770
25811
|
* AuthUsersApi - axios parameter creator
|
|
24771
25812
|
* @export
|
|
@@ -25556,7 +26597,7 @@ export declare class CertificationCampaignFiltersApi extends BaseAPI {
|
|
|
25556
26597
|
*/
|
|
25557
26598
|
export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25558
26599
|
/**
|
|
25559
|
-
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.
|
|
26600
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25560
26601
|
* @summary Complete a Campaign
|
|
25561
26602
|
* @param {string} id Campaign ID.
|
|
25562
26603
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25565,7 +26606,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25565
26606
|
*/
|
|
25566
26607
|
completeCampaign: (id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25567
26608
|
/**
|
|
25568
|
-
* Use this API to create a certification campaign with the information provided in the request body.
|
|
26609
|
+
* Use this API to create a certification campaign with the information provided in the request body. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25569
26610
|
* @summary Create a campaign
|
|
25570
26611
|
* @param {Campaign} campaign
|
|
25571
26612
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25573,7 +26614,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25573
26614
|
*/
|
|
25574
26615
|
createCampaign: (campaign: Campaign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25575
26616
|
/**
|
|
25576
|
-
* Use this API to create a certification campaign template based on campaign.
|
|
26617
|
+
* Use this API to create a certification campaign template based on campaign. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25577
26618
|
* @summary Create a Campaign Template
|
|
25578
26619
|
* @param {CampaignTemplate} campaignTemplate
|
|
25579
26620
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25581,7 +26622,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25581
26622
|
*/
|
|
25582
26623
|
createCampaignTemplate: (campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25583
26624
|
/**
|
|
25584
|
-
* Use this API to delete a certification campaign template by ID.
|
|
26625
|
+
* Use this API to delete a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25585
26626
|
* @summary Delete a Campaign Template
|
|
25586
26627
|
* @param {string} id ID of the campaign template being deleted.
|
|
25587
26628
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25589,7 +26630,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25589
26630
|
*/
|
|
25590
26631
|
deleteCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25591
26632
|
/**
|
|
25592
|
-
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
26633
|
+
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25593
26634
|
* @summary Delete Campaign Template Schedule
|
|
25594
26635
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25595
26636
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25597,7 +26638,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25597
26638
|
*/
|
|
25598
26639
|
deleteCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25599
26640
|
/**
|
|
25600
|
-
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
|
|
26641
|
+
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25601
26642
|
* @summary Delete Campaigns
|
|
25602
26643
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25603
26644
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25605,7 +26646,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25605
26646
|
*/
|
|
25606
26647
|
deleteCampaigns: (campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25607
26648
|
/**
|
|
25608
|
-
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
|
|
26649
|
+
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25609
26650
|
* @summary List Campaigns
|
|
25610
26651
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
25611
26652
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -25618,15 +26659,16 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25618
26659
|
*/
|
|
25619
26660
|
getActiveCampaigns: (detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25620
26661
|
/**
|
|
25621
|
-
* Use this API to get information for an existing certification campaign by the campaign\'s ID.
|
|
26662
|
+
* Use this API to get information for an existing certification campaign by the campaign\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25622
26663
|
* @summary Get Campaign
|
|
25623
26664
|
* @param {string} id ID of the campaign to be retrieved.
|
|
26665
|
+
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
25624
26666
|
* @param {*} [axiosOptions] Override http request option.
|
|
25625
26667
|
* @throws {RequiredError}
|
|
25626
26668
|
*/
|
|
25627
|
-
getCampaign: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26669
|
+
getCampaign: (id: string, detail?: 'SLIM' | 'FULL', axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25628
26670
|
/**
|
|
25629
|
-
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
26671
|
+
* Use this API to fetch all reports for a certification campaign by campaign ID. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25630
26672
|
* @summary Get Campaign Reports
|
|
25631
26673
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
25632
26674
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25634,14 +26676,14 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25634
26676
|
*/
|
|
25635
26677
|
getCampaignReports: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25636
26678
|
/**
|
|
25637
|
-
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
|
|
26679
|
+
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25638
26680
|
* @summary Get Campaign Reports Configuration
|
|
25639
26681
|
* @param {*} [axiosOptions] Override http request option.
|
|
25640
26682
|
* @throws {RequiredError}
|
|
25641
26683
|
*/
|
|
25642
26684
|
getCampaignReportsConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25643
26685
|
/**
|
|
25644
|
-
* Use this API to fetch a certification campaign template by ID.
|
|
26686
|
+
* Use this API to fetch a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25645
26687
|
* @summary Get a Campaign Template
|
|
25646
26688
|
* @param {string} id Requested campaign template\'s ID.
|
|
25647
26689
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25649,7 +26691,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25649
26691
|
*/
|
|
25650
26692
|
getCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25651
26693
|
/**
|
|
25652
|
-
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
26694
|
+
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25653
26695
|
* @summary Get Campaign Template Schedule
|
|
25654
26696
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
25655
26697
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25657,7 +26699,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25657
26699
|
*/
|
|
25658
26700
|
getCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25659
26701
|
/**
|
|
25660
|
-
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
|
|
26702
|
+
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25661
26703
|
* @summary List Campaign Templates
|
|
25662
26704
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25663
26705
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -25669,7 +26711,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25669
26711
|
*/
|
|
25670
26712
|
getCampaignTemplates: (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25671
26713
|
/**
|
|
25672
|
-
* This API reassigns the specified certifications from one identity to another.
|
|
26714
|
+
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25673
26715
|
* @summary Reassign Certifications
|
|
25674
26716
|
* @param {string} id The certification campaign ID
|
|
25675
26717
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -25678,7 +26720,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25678
26720
|
*/
|
|
25679
26721
|
move: (id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25680
26722
|
/**
|
|
25681
|
-
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
26723
|
+
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25682
26724
|
* @summary Update a Campaign Template
|
|
25683
26725
|
* @param {string} id ID of the campaign template being modified.
|
|
25684
26726
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
@@ -25687,7 +26729,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25687
26729
|
*/
|
|
25688
26730
|
patchCampaignTemplate: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25689
26731
|
/**
|
|
25690
|
-
* Use this API to overwrite the configuration for campaign reports.
|
|
26732
|
+
* Use this API to overwrite the configuration for campaign reports. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25691
26733
|
* @summary Set Campaign Reports Configuration
|
|
25692
26734
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
25693
26735
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25695,7 +26737,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25695
26737
|
*/
|
|
25696
26738
|
setCampaignReportsConfig: (campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25697
26739
|
/**
|
|
25698
|
-
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
|
|
26740
|
+
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25699
26741
|
* @summary Set Campaign Template Schedule
|
|
25700
26742
|
* @param {string} id ID of the campaign template being scheduled.
|
|
25701
26743
|
* @param {Schedule} [schedule]
|
|
@@ -25704,7 +26746,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25704
26746
|
*/
|
|
25705
26747
|
setCampaignTemplateSchedule: (id: string, schedule?: Schedule, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25706
26748
|
/**
|
|
25707
|
-
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
|
|
26749
|
+
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25708
26750
|
* @summary Activate a Campaign
|
|
25709
26751
|
* @param {string} id Campaign ID.
|
|
25710
26752
|
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
@@ -25713,7 +26755,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25713
26755
|
*/
|
|
25714
26756
|
startCampaign: (id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25715
26757
|
/**
|
|
25716
|
-
* Use this API to run a remediation scan task for a certification campaign.
|
|
26758
|
+
* Use this API to run a remediation scan task for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25717
26759
|
* @summary Run Campaign Remediation Scan
|
|
25718
26760
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
25719
26761
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25721,7 +26763,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25721
26763
|
*/
|
|
25722
26764
|
startCampaignRemediationScan: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25723
26765
|
/**
|
|
25724
|
-
* Use this API to run a report for a certification campaign.
|
|
26766
|
+
* Use this API to run a report for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25725
26767
|
* @summary Run Campaign Report
|
|
25726
26768
|
* @param {string} id ID of the campaign the report is being run for.
|
|
25727
26769
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -25730,7 +26772,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25730
26772
|
*/
|
|
25731
26773
|
startCampaignReport: (id: string, type: ReportType, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25732
26774
|
/**
|
|
25733
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
26775
|
+
* Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25734
26776
|
* @summary Generate a Campaign from Template
|
|
25735
26777
|
* @param {string} id ID of the campaign template to use for generation.
|
|
25736
26778
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25738,7 +26780,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25738
26780
|
*/
|
|
25739
26781
|
startGenerateCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25740
26782
|
/**
|
|
25741
|
-
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
26783
|
+
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25742
26784
|
* @summary Update a Campaign
|
|
25743
26785
|
* @param {string} id ID of the campaign template being modified.
|
|
25744
26786
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
|
|
@@ -25753,7 +26795,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25753
26795
|
*/
|
|
25754
26796
|
export declare const CertificationCampaignsApiFp: (configuration?: Configuration) => {
|
|
25755
26797
|
/**
|
|
25756
|
-
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.
|
|
26798
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25757
26799
|
* @summary Complete a Campaign
|
|
25758
26800
|
* @param {string} id Campaign ID.
|
|
25759
26801
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25762,7 +26804,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25762
26804
|
*/
|
|
25763
26805
|
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25764
26806
|
/**
|
|
25765
|
-
* Use this API to create a certification campaign with the information provided in the request body.
|
|
26807
|
+
* Use this API to create a certification campaign with the information provided in the request body. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25766
26808
|
* @summary Create a campaign
|
|
25767
26809
|
* @param {Campaign} campaign
|
|
25768
26810
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25770,7 +26812,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25770
26812
|
*/
|
|
25771
26813
|
createCampaign(campaign: Campaign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Campaign>>;
|
|
25772
26814
|
/**
|
|
25773
|
-
* Use this API to create a certification campaign template based on campaign.
|
|
26815
|
+
* Use this API to create a certification campaign template based on campaign. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25774
26816
|
* @summary Create a Campaign Template
|
|
25775
26817
|
* @param {CampaignTemplate} campaignTemplate
|
|
25776
26818
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25778,7 +26820,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25778
26820
|
*/
|
|
25779
26821
|
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25780
26822
|
/**
|
|
25781
|
-
* Use this API to delete a certification campaign template by ID.
|
|
26823
|
+
* Use this API to delete a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25782
26824
|
* @summary Delete a Campaign Template
|
|
25783
26825
|
* @param {string} id ID of the campaign template being deleted.
|
|
25784
26826
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25786,7 +26828,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25786
26828
|
*/
|
|
25787
26829
|
deleteCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25788
26830
|
/**
|
|
25789
|
-
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
26831
|
+
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25790
26832
|
* @summary Delete Campaign Template Schedule
|
|
25791
26833
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25792
26834
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25794,7 +26836,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25794
26836
|
*/
|
|
25795
26837
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25796
26838
|
/**
|
|
25797
|
-
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
|
|
26839
|
+
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25798
26840
|
* @summary Delete Campaigns
|
|
25799
26841
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25800
26842
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25802,7 +26844,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25802
26844
|
*/
|
|
25803
26845
|
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25804
26846
|
/**
|
|
25805
|
-
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
|
|
26847
|
+
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25806
26848
|
* @summary List Campaigns
|
|
25807
26849
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
25808
26850
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -25815,15 +26857,16 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25815
26857
|
*/
|
|
25816
26858
|
getActiveCampaigns(detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetActiveCampaigns200ResponseInner>>>;
|
|
25817
26859
|
/**
|
|
25818
|
-
* Use this API to get information for an existing certification campaign by the campaign\'s ID.
|
|
26860
|
+
* Use this API to get information for an existing certification campaign by the campaign\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25819
26861
|
* @summary Get Campaign
|
|
25820
26862
|
* @param {string} id ID of the campaign to be retrieved.
|
|
26863
|
+
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
25821
26864
|
* @param {*} [axiosOptions] Override http request option.
|
|
25822
26865
|
* @throws {RequiredError}
|
|
25823
26866
|
*/
|
|
25824
|
-
getCampaign(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<
|
|
26867
|
+
getCampaign(id: string, detail?: 'SLIM' | 'FULL', axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetActiveCampaigns200ResponseInner>>;
|
|
25825
26868
|
/**
|
|
25826
|
-
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
26869
|
+
* Use this API to fetch all reports for a certification campaign by campaign ID. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25827
26870
|
* @summary Get Campaign Reports
|
|
25828
26871
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
25829
26872
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25831,14 +26874,14 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25831
26874
|
*/
|
|
25832
26875
|
getCampaignReports(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignReport>>>;
|
|
25833
26876
|
/**
|
|
25834
|
-
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
|
|
26877
|
+
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25835
26878
|
* @summary Get Campaign Reports Configuration
|
|
25836
26879
|
* @param {*} [axiosOptions] Override http request option.
|
|
25837
26880
|
* @throws {RequiredError}
|
|
25838
26881
|
*/
|
|
25839
26882
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
25840
26883
|
/**
|
|
25841
|
-
* Use this API to fetch a certification campaign template by ID.
|
|
26884
|
+
* Use this API to fetch a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25842
26885
|
* @summary Get a Campaign Template
|
|
25843
26886
|
* @param {string} id Requested campaign template\'s ID.
|
|
25844
26887
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25846,7 +26889,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25846
26889
|
*/
|
|
25847
26890
|
getCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25848
26891
|
/**
|
|
25849
|
-
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
26892
|
+
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25850
26893
|
* @summary Get Campaign Template Schedule
|
|
25851
26894
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
25852
26895
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25854,7 +26897,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25854
26897
|
*/
|
|
25855
26898
|
getCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schedule>>;
|
|
25856
26899
|
/**
|
|
25857
|
-
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
|
|
26900
|
+
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25858
26901
|
* @summary List Campaign Templates
|
|
25859
26902
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
25860
26903
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -25866,7 +26909,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25866
26909
|
*/
|
|
25867
26910
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignTemplate>>>;
|
|
25868
26911
|
/**
|
|
25869
|
-
* This API reassigns the specified certifications from one identity to another.
|
|
26912
|
+
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25870
26913
|
* @summary Reassign Certifications
|
|
25871
26914
|
* @param {string} id The certification campaign ID
|
|
25872
26915
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -25875,7 +26918,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25875
26918
|
*/
|
|
25876
26919
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
25877
26920
|
/**
|
|
25878
|
-
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
26921
|
+
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25879
26922
|
* @summary Update a Campaign Template
|
|
25880
26923
|
* @param {string} id ID of the campaign template being modified.
|
|
25881
26924
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
@@ -25884,7 +26927,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25884
26927
|
*/
|
|
25885
26928
|
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25886
26929
|
/**
|
|
25887
|
-
* Use this API to overwrite the configuration for campaign reports.
|
|
26930
|
+
* Use this API to overwrite the configuration for campaign reports. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25888
26931
|
* @summary Set Campaign Reports Configuration
|
|
25889
26932
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
25890
26933
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25892,7 +26935,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25892
26935
|
*/
|
|
25893
26936
|
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
25894
26937
|
/**
|
|
25895
|
-
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
|
|
26938
|
+
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25896
26939
|
* @summary Set Campaign Template Schedule
|
|
25897
26940
|
* @param {string} id ID of the campaign template being scheduled.
|
|
25898
26941
|
* @param {Schedule} [schedule]
|
|
@@ -25901,7 +26944,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25901
26944
|
*/
|
|
25902
26945
|
setCampaignTemplateSchedule(id: string, schedule?: Schedule, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25903
26946
|
/**
|
|
25904
|
-
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
|
|
26947
|
+
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25905
26948
|
* @summary Activate a Campaign
|
|
25906
26949
|
* @param {string} id Campaign ID.
|
|
25907
26950
|
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
@@ -25910,7 +26953,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25910
26953
|
*/
|
|
25911
26954
|
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25912
26955
|
/**
|
|
25913
|
-
* Use this API to run a remediation scan task for a certification campaign.
|
|
26956
|
+
* Use this API to run a remediation scan task for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25914
26957
|
* @summary Run Campaign Remediation Scan
|
|
25915
26958
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
25916
26959
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25918,7 +26961,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25918
26961
|
*/
|
|
25919
26962
|
startCampaignRemediationScan(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25920
26963
|
/**
|
|
25921
|
-
* Use this API to run a report for a certification campaign.
|
|
26964
|
+
* Use this API to run a report for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
25922
26965
|
* @summary Run Campaign Report
|
|
25923
26966
|
* @param {string} id ID of the campaign the report is being run for.
|
|
25924
26967
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -25927,7 +26970,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25927
26970
|
*/
|
|
25928
26971
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25929
26972
|
/**
|
|
25930
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
26973
|
+
* Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25931
26974
|
* @summary Generate a Campaign from Template
|
|
25932
26975
|
* @param {string} id ID of the campaign template to use for generation.
|
|
25933
26976
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25935,7 +26978,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25935
26978
|
*/
|
|
25936
26979
|
startGenerateCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReference>>;
|
|
25937
26980
|
/**
|
|
25938
|
-
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
26981
|
+
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25939
26982
|
* @summary Update a Campaign
|
|
25940
26983
|
* @param {string} id ID of the campaign template being modified.
|
|
25941
26984
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
|
|
@@ -25950,7 +26993,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25950
26993
|
*/
|
|
25951
26994
|
export declare const CertificationCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25952
26995
|
/**
|
|
25953
|
-
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.
|
|
26996
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25954
26997
|
* @summary Complete a Campaign
|
|
25955
26998
|
* @param {string} id Campaign ID.
|
|
25956
26999
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25959,7 +27002,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25959
27002
|
*/
|
|
25960
27003
|
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
25961
27004
|
/**
|
|
25962
|
-
* Use this API to create a certification campaign with the information provided in the request body.
|
|
27005
|
+
* Use this API to create a certification campaign with the information provided in the request body. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25963
27006
|
* @summary Create a campaign
|
|
25964
27007
|
* @param {Campaign} campaign
|
|
25965
27008
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25967,7 +27010,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25967
27010
|
*/
|
|
25968
27011
|
createCampaign(campaign: Campaign, axiosOptions?: any): AxiosPromise<Campaign>;
|
|
25969
27012
|
/**
|
|
25970
|
-
* Use this API to create a certification campaign template based on campaign.
|
|
27013
|
+
* Use this API to create a certification campaign template based on campaign. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25971
27014
|
* @summary Create a Campaign Template
|
|
25972
27015
|
* @param {CampaignTemplate} campaignTemplate
|
|
25973
27016
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25975,7 +27018,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25975
27018
|
*/
|
|
25976
27019
|
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
25977
27020
|
/**
|
|
25978
|
-
* Use this API to delete a certification campaign template by ID.
|
|
27021
|
+
* Use this API to delete a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25979
27022
|
* @summary Delete a Campaign Template
|
|
25980
27023
|
* @param {string} id ID of the campaign template being deleted.
|
|
25981
27024
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25983,7 +27026,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25983
27026
|
*/
|
|
25984
27027
|
deleteCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
25985
27028
|
/**
|
|
25986
|
-
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
27029
|
+
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25987
27030
|
* @summary Delete Campaign Template Schedule
|
|
25988
27031
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25989
27032
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25991,7 +27034,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25991
27034
|
*/
|
|
25992
27035
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
25993
27036
|
/**
|
|
25994
|
-
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
|
|
27037
|
+
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
25995
27038
|
* @summary Delete Campaigns
|
|
25996
27039
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25997
27040
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25999,7 +27042,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25999
27042
|
*/
|
|
26000
27043
|
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
26001
27044
|
/**
|
|
26002
|
-
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
|
|
27045
|
+
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26003
27046
|
* @summary List Campaigns
|
|
26004
27047
|
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
26005
27048
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -26012,15 +27055,16 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26012
27055
|
*/
|
|
26013
27056
|
getActiveCampaigns(detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<GetActiveCampaigns200ResponseInner>>;
|
|
26014
27057
|
/**
|
|
26015
|
-
* Use this API to get information for an existing certification campaign by the campaign\'s ID.
|
|
27058
|
+
* Use this API to get information for an existing certification campaign by the campaign\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26016
27059
|
* @summary Get Campaign
|
|
26017
27060
|
* @param {string} id ID of the campaign to be retrieved.
|
|
27061
|
+
* @param {'SLIM' | 'FULL'} [detail] Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
26018
27062
|
* @param {*} [axiosOptions] Override http request option.
|
|
26019
27063
|
* @throws {RequiredError}
|
|
26020
27064
|
*/
|
|
26021
|
-
getCampaign(id: string, axiosOptions?: any): AxiosPromise<
|
|
27065
|
+
getCampaign(id: string, detail?: 'SLIM' | 'FULL', axiosOptions?: any): AxiosPromise<GetActiveCampaigns200ResponseInner>;
|
|
26022
27066
|
/**
|
|
26023
|
-
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
27067
|
+
* Use this API to fetch all reports for a certification campaign by campaign ID. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26024
27068
|
* @summary Get Campaign Reports
|
|
26025
27069
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
26026
27070
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26028,14 +27072,14 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26028
27072
|
*/
|
|
26029
27073
|
getCampaignReports(id: string, axiosOptions?: any): AxiosPromise<Array<CampaignReport>>;
|
|
26030
27074
|
/**
|
|
26031
|
-
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
|
|
27075
|
+
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26032
27076
|
* @summary Get Campaign Reports Configuration
|
|
26033
27077
|
* @param {*} [axiosOptions] Override http request option.
|
|
26034
27078
|
* @throws {RequiredError}
|
|
26035
27079
|
*/
|
|
26036
27080
|
getCampaignReportsConfig(axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
26037
27081
|
/**
|
|
26038
|
-
* Use this API to fetch a certification campaign template by ID.
|
|
27082
|
+
* Use this API to fetch a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26039
27083
|
* @summary Get a Campaign Template
|
|
26040
27084
|
* @param {string} id Requested campaign template\'s ID.
|
|
26041
27085
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26043,7 +27087,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26043
27087
|
*/
|
|
26044
27088
|
getCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
26045
27089
|
/**
|
|
26046
|
-
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
27090
|
+
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26047
27091
|
* @summary Get Campaign Template Schedule
|
|
26048
27092
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
26049
27093
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26051,7 +27095,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26051
27095
|
*/
|
|
26052
27096
|
getCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<Schedule>;
|
|
26053
27097
|
/**
|
|
26054
|
-
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
|
|
27098
|
+
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26055
27099
|
* @summary List Campaign Templates
|
|
26056
27100
|
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
26057
27101
|
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
@@ -26063,7 +27107,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26063
27107
|
*/
|
|
26064
27108
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<CampaignTemplate>>;
|
|
26065
27109
|
/**
|
|
26066
|
-
* This API reassigns the specified certifications from one identity to another.
|
|
27110
|
+
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26067
27111
|
* @summary Reassign Certifications
|
|
26068
27112
|
* @param {string} id The certification campaign ID
|
|
26069
27113
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -26072,7 +27116,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26072
27116
|
*/
|
|
26073
27117
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
26074
27118
|
/**
|
|
26075
|
-
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
27119
|
+
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26076
27120
|
* @summary Update a Campaign Template
|
|
26077
27121
|
* @param {string} id ID of the campaign template being modified.
|
|
26078
27122
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * description * deadlineDuration * campaign (all fields that are allowed during create)
|
|
@@ -26081,7 +27125,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26081
27125
|
*/
|
|
26082
27126
|
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
26083
27127
|
/**
|
|
26084
|
-
* Use this API to overwrite the configuration for campaign reports.
|
|
27128
|
+
* Use this API to overwrite the configuration for campaign reports. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26085
27129
|
* @summary Set Campaign Reports Configuration
|
|
26086
27130
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
26087
27131
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26089,7 +27133,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26089
27133
|
*/
|
|
26090
27134
|
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
26091
27135
|
/**
|
|
26092
|
-
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
|
|
27136
|
+
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26093
27137
|
* @summary Set Campaign Template Schedule
|
|
26094
27138
|
* @param {string} id ID of the campaign template being scheduled.
|
|
26095
27139
|
* @param {Schedule} [schedule]
|
|
@@ -26098,7 +27142,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26098
27142
|
*/
|
|
26099
27143
|
setCampaignTemplateSchedule(id: string, schedule?: Schedule, axiosOptions?: any): AxiosPromise<void>;
|
|
26100
27144
|
/**
|
|
26101
|
-
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
|
|
27145
|
+
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26102
27146
|
* @summary Activate a Campaign
|
|
26103
27147
|
* @param {string} id Campaign ID.
|
|
26104
27148
|
* @param {ActivateCampaignOptions} [activateCampaignOptions] Optional. If no timezone is specified, the standard UTC timezone is used (i.e. UTC+00:00). Although this can take any timezone, the intended value is the caller\'s timezone. The activation time calculated from the given timezone may cause the campaign deadline time to be modified, but it will remain within the original date. The timezone must be in a valid ISO 8601 format.
|
|
@@ -26107,7 +27151,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26107
27151
|
*/
|
|
26108
27152
|
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
26109
27153
|
/**
|
|
26110
|
-
* Use this API to run a remediation scan task for a certification campaign.
|
|
27154
|
+
* Use this API to run a remediation scan task for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26111
27155
|
* @summary Run Campaign Remediation Scan
|
|
26112
27156
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
26113
27157
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26115,7 +27159,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26115
27159
|
*/
|
|
26116
27160
|
startCampaignRemediationScan(id: string, axiosOptions?: any): AxiosPromise<object>;
|
|
26117
27161
|
/**
|
|
26118
|
-
* Use this API to run a report for a certification campaign.
|
|
27162
|
+
* Use this API to run a report for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26119
27163
|
* @summary Run Campaign Report
|
|
26120
27164
|
* @param {string} id ID of the campaign the report is being run for.
|
|
26121
27165
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -26124,7 +27168,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26124
27168
|
*/
|
|
26125
27169
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: any): AxiosPromise<object>;
|
|
26126
27170
|
/**
|
|
26127
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
27171
|
+
* Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26128
27172
|
* @summary Generate a Campaign from Template
|
|
26129
27173
|
* @param {string} id ID of the campaign template to use for generation.
|
|
26130
27174
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26132,7 +27176,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
26132
27176
|
*/
|
|
26133
27177
|
startGenerateCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignReference>;
|
|
26134
27178
|
/**
|
|
26135
|
-
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
27179
|
+
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26136
27180
|
* @summary Update a Campaign
|
|
26137
27181
|
* @param {string} id ID of the campaign template being modified.
|
|
26138
27182
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of campaign update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The fields that can be patched differ based on the status of the campaign. When the campaign is in the *STAGED* status, you can patch these fields: * name * description * recommendationsEnabled * deadline * emailNotificationEnabled * autoRevokeAllowed When the campaign is in the *ACTIVE* status, you can patch these fields: * deadline
|
|
@@ -26280,6 +27324,12 @@ export interface CertificationCampaignsApiGetCampaignRequest {
|
|
|
26280
27324
|
* @memberof CertificationCampaignsApiGetCampaign
|
|
26281
27325
|
*/
|
|
26282
27326
|
readonly id: string;
|
|
27327
|
+
/**
|
|
27328
|
+
* Determines whether slim, or increased level of detail is provided for each campaign in the returned list. Slim is the default behavior.
|
|
27329
|
+
* @type {'SLIM' | 'FULL'}
|
|
27330
|
+
* @memberof CertificationCampaignsApiGetCampaign
|
|
27331
|
+
*/
|
|
27332
|
+
readonly detail?: 'SLIM' | 'FULL';
|
|
26283
27333
|
}
|
|
26284
27334
|
/**
|
|
26285
27335
|
* Request parameters for getCampaignReports operation in CertificationCampaignsApi.
|
|
@@ -26518,7 +27568,7 @@ export interface CertificationCampaignsApiUpdateCampaignRequest {
|
|
|
26518
27568
|
*/
|
|
26519
27569
|
export declare class CertificationCampaignsApi extends BaseAPI {
|
|
26520
27570
|
/**
|
|
26521
|
-
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed.
|
|
27571
|
+
* :::caution This endpoint will run successfully for any campaigns that are **past due**. This endpoint will return a content error if the campaign is **not past due**. ::: Use this API to complete a certification campaign. This functionality is provided to admins so that they can complete a certification even if all items have not been completed. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26522
27572
|
* @summary Complete a Campaign
|
|
26523
27573
|
* @param {CertificationCampaignsApiCompleteCampaignRequest} requestParameters Request parameters.
|
|
26524
27574
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26527,7 +27577,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26527
27577
|
*/
|
|
26528
27578
|
completeCampaign(requestParameters: CertificationCampaignsApiCompleteCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26529
27579
|
/**
|
|
26530
|
-
* Use this API to create a certification campaign with the information provided in the request body.
|
|
27580
|
+
* Use this API to create a certification campaign with the information provided in the request body. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26531
27581
|
* @summary Create a campaign
|
|
26532
27582
|
* @param {CertificationCampaignsApiCreateCampaignRequest} requestParameters Request parameters.
|
|
26533
27583
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26536,7 +27586,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26536
27586
|
*/
|
|
26537
27587
|
createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Campaign, any>>;
|
|
26538
27588
|
/**
|
|
26539
|
-
* Use this API to create a certification campaign template based on campaign.
|
|
27589
|
+
* Use this API to create a certification campaign template based on campaign. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26540
27590
|
* @summary Create a Campaign Template
|
|
26541
27591
|
* @param {CertificationCampaignsApiCreateCampaignTemplateRequest} requestParameters Request parameters.
|
|
26542
27592
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26545,7 +27595,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26545
27595
|
*/
|
|
26546
27596
|
createCampaignTemplate(requestParameters: CertificationCampaignsApiCreateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26547
27597
|
/**
|
|
26548
|
-
* Use this API to delete a certification campaign template by ID.
|
|
27598
|
+
* Use this API to delete a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26549
27599
|
* @summary Delete a Campaign Template
|
|
26550
27600
|
* @param {CertificationCampaignsApiDeleteCampaignTemplateRequest} requestParameters Request parameters.
|
|
26551
27601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26554,7 +27604,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26554
27604
|
*/
|
|
26555
27605
|
deleteCampaignTemplate(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26556
27606
|
/**
|
|
26557
|
-
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
27607
|
+
* Use this API to delete the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26558
27608
|
* @summary Delete Campaign Template Schedule
|
|
26559
27609
|
* @param {CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26560
27610
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26563,7 +27613,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26563
27613
|
*/
|
|
26564
27614
|
deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26565
27615
|
/**
|
|
26566
|
-
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs.
|
|
27616
|
+
* Use this API to delete certification campaigns whose IDs are specified in the provided list of campaign IDs. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26567
27617
|
* @summary Delete Campaigns
|
|
26568
27618
|
* @param {CertificationCampaignsApiDeleteCampaignsRequest} requestParameters Request parameters.
|
|
26569
27619
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26572,7 +27622,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26572
27622
|
*/
|
|
26573
27623
|
deleteCampaigns(requestParameters: CertificationCampaignsApiDeleteCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26574
27624
|
/**
|
|
26575
|
-
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query.
|
|
27625
|
+
* Use this API to get a list of campaigns. This API can provide increased level of detail for each campaign for the correct provided query. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26576
27626
|
* @summary List Campaigns
|
|
26577
27627
|
* @param {CertificationCampaignsApiGetActiveCampaignsRequest} requestParameters Request parameters.
|
|
26578
27628
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26581,16 +27631,16 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26581
27631
|
*/
|
|
26582
27632
|
getActiveCampaigns(requestParameters?: CertificationCampaignsApiGetActiveCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInner[], any>>;
|
|
26583
27633
|
/**
|
|
26584
|
-
* Use this API to get information for an existing certification campaign by the campaign\'s ID.
|
|
27634
|
+
* Use this API to get information for an existing certification campaign by the campaign\'s ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26585
27635
|
* @summary Get Campaign
|
|
26586
27636
|
* @param {CertificationCampaignsApiGetCampaignRequest} requestParameters Request parameters.
|
|
26587
27637
|
* @param {*} [axiosOptions] Override http request option.
|
|
26588
27638
|
* @throws {RequiredError}
|
|
26589
27639
|
* @memberof CertificationCampaignsApi
|
|
26590
27640
|
*/
|
|
26591
|
-
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27641
|
+
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInner, any>>;
|
|
26592
27642
|
/**
|
|
26593
|
-
* Use this API to fetch all reports for a certification campaign by campaign ID.
|
|
27643
|
+
* Use this API to fetch all reports for a certification campaign by campaign ID. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26594
27644
|
* @summary Get Campaign Reports
|
|
26595
27645
|
* @param {CertificationCampaignsApiGetCampaignReportsRequest} requestParameters Request parameters.
|
|
26596
27646
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26599,7 +27649,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26599
27649
|
*/
|
|
26600
27650
|
getCampaignReports(requestParameters: CertificationCampaignsApiGetCampaignReportsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReport[], any>>;
|
|
26601
27651
|
/**
|
|
26602
|
-
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns.
|
|
27652
|
+
* Use this API to fetch the configuration for certification campaign reports. The configuration includes only one element - identity attributes defined as custom report columns. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26603
27653
|
* @summary Get Campaign Reports Configuration
|
|
26604
27654
|
* @param {*} [axiosOptions] Override http request option.
|
|
26605
27655
|
* @throws {RequiredError}
|
|
@@ -26607,7 +27657,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26607
27657
|
*/
|
|
26608
27658
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
26609
27659
|
/**
|
|
26610
|
-
* Use this API to fetch a certification campaign template by ID.
|
|
27660
|
+
* Use this API to fetch a certification campaign template by ID. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26611
27661
|
* @summary Get a Campaign Template
|
|
26612
27662
|
* @param {CertificationCampaignsApiGetCampaignTemplateRequest} requestParameters Request parameters.
|
|
26613
27663
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26616,7 +27666,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26616
27666
|
*/
|
|
26617
27667
|
getCampaignTemplate(requestParameters: CertificationCampaignsApiGetCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26618
27668
|
/**
|
|
26619
|
-
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set.
|
|
27669
|
+
* Use this API to get the schedule for a certification campaign template. The API returns a 404 if there is no schedule set. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26620
27670
|
* @summary Get Campaign Template Schedule
|
|
26621
27671
|
* @param {CertificationCampaignsApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26622
27672
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26625,7 +27675,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26625
27675
|
*/
|
|
26626
27676
|
getCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiGetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Schedule, any>>;
|
|
26627
27677
|
/**
|
|
26628
|
-
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params.
|
|
27678
|
+
* Use this API to get a list of all campaign templates. Scope can be reduced through standard V3 query params. The API returns all campaign templates matching the query parameters. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26629
27679
|
* @summary List Campaign Templates
|
|
26630
27680
|
* @param {CertificationCampaignsApiGetCampaignTemplatesRequest} requestParameters Request parameters.
|
|
26631
27681
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26634,7 +27684,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26634
27684
|
*/
|
|
26635
27685
|
getCampaignTemplates(requestParameters?: CertificationCampaignsApiGetCampaignTemplatesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate[], any>>;
|
|
26636
27686
|
/**
|
|
26637
|
-
* This API reassigns the specified certifications from one identity to another.
|
|
27687
|
+
* This API reassigns the specified certifications from one identity to another. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26638
27688
|
* @summary Reassign Certifications
|
|
26639
27689
|
* @param {CertificationCampaignsApiMoveRequest} requestParameters Request parameters.
|
|
26640
27690
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26643,7 +27693,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26643
27693
|
*/
|
|
26644
27694
|
move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
26645
27695
|
/**
|
|
26646
|
-
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
27696
|
+
* Use this API to update individual fields on a certification campaign template, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26647
27697
|
* @summary Update a Campaign Template
|
|
26648
27698
|
* @param {CertificationCampaignsApiPatchCampaignTemplateRequest} requestParameters Request parameters.
|
|
26649
27699
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26652,7 +27702,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26652
27702
|
*/
|
|
26653
27703
|
patchCampaignTemplate(requestParameters: CertificationCampaignsApiPatchCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26654
27704
|
/**
|
|
26655
|
-
* Use this API to overwrite the configuration for campaign reports.
|
|
27705
|
+
* Use this API to overwrite the configuration for campaign reports. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26656
27706
|
* @summary Set Campaign Reports Configuration
|
|
26657
27707
|
* @param {CertificationCampaignsApiSetCampaignReportsConfigRequest} requestParameters Request parameters.
|
|
26658
27708
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26661,7 +27711,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26661
27711
|
*/
|
|
26662
27712
|
setCampaignReportsConfig(requestParameters: CertificationCampaignsApiSetCampaignReportsConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
26663
27713
|
/**
|
|
26664
|
-
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one.
|
|
27714
|
+
* Use this API to set the schedule for a certification campaign template. If a schedule already exists, the API overwrites it with the new one. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26665
27715
|
* @summary Set Campaign Template Schedule
|
|
26666
27716
|
* @param {CertificationCampaignsApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26667
27717
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26670,7 +27720,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26670
27720
|
*/
|
|
26671
27721
|
setCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiSetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26672
27722
|
/**
|
|
26673
|
-
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged.
|
|
27723
|
+
* Use this API to submit a job to activate the certified campaign with the specified ID. The campaign must be staged. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26674
27724
|
* @summary Activate a Campaign
|
|
26675
27725
|
* @param {CertificationCampaignsApiStartCampaignRequest} requestParameters Request parameters.
|
|
26676
27726
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26679,7 +27729,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26679
27729
|
*/
|
|
26680
27730
|
startCampaign(requestParameters: CertificationCampaignsApiStartCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26681
27731
|
/**
|
|
26682
|
-
* Use this API to run a remediation scan task for a certification campaign.
|
|
27732
|
+
* Use this API to run a remediation scan task for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26683
27733
|
* @summary Run Campaign Remediation Scan
|
|
26684
27734
|
* @param {CertificationCampaignsApiStartCampaignRemediationScanRequest} requestParameters Request parameters.
|
|
26685
27735
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26688,7 +27738,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26688
27738
|
*/
|
|
26689
27739
|
startCampaignRemediationScan(requestParameters: CertificationCampaignsApiStartCampaignRemediationScanRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26690
27740
|
/**
|
|
26691
|
-
* Use this API to run a report for a certification campaign.
|
|
27741
|
+
* Use this API to run a report for a certification campaign. A token with ORG_ADMIN, CERT_ADMIN or REPORT_ADMIN authority is required to call this API.
|
|
26692
27742
|
* @summary Run Campaign Report
|
|
26693
27743
|
* @param {CertificationCampaignsApiStartCampaignReportRequest} requestParameters Request parameters.
|
|
26694
27744
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26697,7 +27747,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26697
27747
|
*/
|
|
26698
27748
|
startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26699
27749
|
/**
|
|
26700
|
-
* Use this API to generate a new certification campaign from a campaign template.
|
|
27750
|
+
* Use this API to generate a new certification campaign from a campaign template. The campaign object contained in the template has special formatting applied to its name and description fields that determine the generated campaign\'s name/description. Placeholders in those fields are formatted with the current date and time upon generation. Placeholders consist of a percent sign followed by a letter indicating what should be inserted. For example, \"%Y\" inserts the current year, and a campaign template named \"Campaign for %y\" generates a campaign called \"Campaign for 2020\" (assuming the year at generation time is 2020). Valid placeholders are the date/time conversion suffix characters supported by [java.util.Formatter](https://docs.oracle.com/javase/8/docs/api/java/util/Formatter.html). A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26701
27751
|
* @summary Generate a Campaign from Template
|
|
26702
27752
|
* @param {CertificationCampaignsApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters.
|
|
26703
27753
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26706,7 +27756,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26706
27756
|
*/
|
|
26707
27757
|
startGenerateCampaignTemplate(requestParameters: CertificationCampaignsApiStartGenerateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReference, any>>;
|
|
26708
27758
|
/**
|
|
26709
|
-
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
27759
|
+
* Use this API to update individual fields on a certification campaign, using the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. A token with ORG_ADMIN or CERT_ADMIN authority is required to call this API.
|
|
26710
27760
|
* @summary Update a Campaign
|
|
26711
27761
|
* @param {CertificationCampaignsApiUpdateCampaignRequest} requestParameters Request parameters.
|
|
26712
27762
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29397,6 +30447,14 @@ export declare class GlobalTenantSecuritySettingsApi extends BaseAPI {
|
|
|
29397
30447
|
* @export
|
|
29398
30448
|
*/
|
|
29399
30449
|
export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
30450
|
+
/**
|
|
30451
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
30452
|
+
* @summary Create an Identity Profile
|
|
30453
|
+
* @param {IdentityProfile} identityProfile
|
|
30454
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30455
|
+
* @throws {RequiredError}
|
|
30456
|
+
*/
|
|
30457
|
+
createIdentityProfile: (identityProfile: IdentityProfile, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29400
30458
|
/**
|
|
29401
30459
|
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
29402
30460
|
* @summary Delete an Identity Profile
|
|
@@ -29434,7 +30492,7 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
29434
30492
|
*/
|
|
29435
30493
|
getDefaultIdentityAttributeConfig: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29436
30494
|
/**
|
|
29437
|
-
* This returns a single Identity Profile based on ID.
|
|
30495
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
29438
30496
|
* @summary Get single Identity Profile
|
|
29439
30497
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
29440
30498
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29461,6 +30519,14 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
29461
30519
|
* @throws {RequiredError}
|
|
29462
30520
|
*/
|
|
29463
30521
|
listIdentityProfiles: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30522
|
+
/**
|
|
30523
|
+
* Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
30524
|
+
* @summary Generate Identity Profile Preview
|
|
30525
|
+
* @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body.
|
|
30526
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30527
|
+
* @throws {RequiredError}
|
|
30528
|
+
*/
|
|
30529
|
+
showIdentityPreview: (identityPreviewRequest: IdentityPreviewRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29464
30530
|
/**
|
|
29465
30531
|
* Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API.
|
|
29466
30532
|
* @summary Process identities under profile
|
|
@@ -29469,12 +30535,29 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
29469
30535
|
* @throws {RequiredError}
|
|
29470
30536
|
*/
|
|
29471
30537
|
syncIdentityProfile: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30538
|
+
/**
|
|
30539
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
30540
|
+
* @summary Update the Identity Profile
|
|
30541
|
+
* @param {string} identityProfileId The Identity Profile ID
|
|
30542
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
30543
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30544
|
+
* @throws {RequiredError}
|
|
30545
|
+
*/
|
|
30546
|
+
updateIdentityProfile: (identityProfileId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29472
30547
|
};
|
|
29473
30548
|
/**
|
|
29474
30549
|
* IdentityProfilesApi - functional programming interface
|
|
29475
30550
|
* @export
|
|
29476
30551
|
*/
|
|
29477
30552
|
export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
30553
|
+
/**
|
|
30554
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
30555
|
+
* @summary Create an Identity Profile
|
|
30556
|
+
* @param {IdentityProfile} identityProfile
|
|
30557
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30558
|
+
* @throws {RequiredError}
|
|
30559
|
+
*/
|
|
30560
|
+
createIdentityProfile(identityProfile: IdentityProfile, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityProfile>>;
|
|
29478
30561
|
/**
|
|
29479
30562
|
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
29480
30563
|
* @summary Delete an Identity Profile
|
|
@@ -29512,7 +30595,7 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
29512
30595
|
*/
|
|
29513
30596
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityAttributeConfig>>;
|
|
29514
30597
|
/**
|
|
29515
|
-
* This returns a single Identity Profile based on ID.
|
|
30598
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
29516
30599
|
* @summary Get single Identity Profile
|
|
29517
30600
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
29518
30601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29539,6 +30622,14 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
29539
30622
|
* @throws {RequiredError}
|
|
29540
30623
|
*/
|
|
29541
30624
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityProfile>>>;
|
|
30625
|
+
/**
|
|
30626
|
+
* Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
30627
|
+
* @summary Generate Identity Profile Preview
|
|
30628
|
+
* @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body.
|
|
30629
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30630
|
+
* @throws {RequiredError}
|
|
30631
|
+
*/
|
|
30632
|
+
showIdentityPreview(identityPreviewRequest: IdentityPreviewRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityPreviewResponse>>;
|
|
29542
30633
|
/**
|
|
29543
30634
|
* Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API.
|
|
29544
30635
|
* @summary Process identities under profile
|
|
@@ -29547,12 +30638,29 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
29547
30638
|
* @throws {RequiredError}
|
|
29548
30639
|
*/
|
|
29549
30640
|
syncIdentityProfile(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
30641
|
+
/**
|
|
30642
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
30643
|
+
* @summary Update the Identity Profile
|
|
30644
|
+
* @param {string} identityProfileId The Identity Profile ID
|
|
30645
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
30646
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30647
|
+
* @throws {RequiredError}
|
|
30648
|
+
*/
|
|
30649
|
+
updateIdentityProfile(identityProfileId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityProfile>>;
|
|
29550
30650
|
};
|
|
29551
30651
|
/**
|
|
29552
30652
|
* IdentityProfilesApi - factory interface
|
|
29553
30653
|
* @export
|
|
29554
30654
|
*/
|
|
29555
30655
|
export declare const IdentityProfilesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
30656
|
+
/**
|
|
30657
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
30658
|
+
* @summary Create an Identity Profile
|
|
30659
|
+
* @param {IdentityProfile} identityProfile
|
|
30660
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30661
|
+
* @throws {RequiredError}
|
|
30662
|
+
*/
|
|
30663
|
+
createIdentityProfile(identityProfile: IdentityProfile, axiosOptions?: any): AxiosPromise<IdentityProfile>;
|
|
29556
30664
|
/**
|
|
29557
30665
|
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
29558
30666
|
* @summary Delete an Identity Profile
|
|
@@ -29590,7 +30698,7 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
29590
30698
|
*/
|
|
29591
30699
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: any): AxiosPromise<IdentityAttributeConfig>;
|
|
29592
30700
|
/**
|
|
29593
|
-
* This returns a single Identity Profile based on ID.
|
|
30701
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
29594
30702
|
* @summary Get single Identity Profile
|
|
29595
30703
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
29596
30704
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29617,6 +30725,14 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
29617
30725
|
* @throws {RequiredError}
|
|
29618
30726
|
*/
|
|
29619
30727
|
listIdentityProfiles(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<IdentityProfile>>;
|
|
30728
|
+
/**
|
|
30729
|
+
* Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
30730
|
+
* @summary Generate Identity Profile Preview
|
|
30731
|
+
* @param {IdentityPreviewRequest} identityPreviewRequest Identity Preview request body.
|
|
30732
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30733
|
+
* @throws {RequiredError}
|
|
30734
|
+
*/
|
|
30735
|
+
showIdentityPreview(identityPreviewRequest: IdentityPreviewRequest, axiosOptions?: any): AxiosPromise<IdentityPreviewResponse>;
|
|
29620
30736
|
/**
|
|
29621
30737
|
* Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API.
|
|
29622
30738
|
* @summary Process identities under profile
|
|
@@ -29625,7 +30741,29 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
29625
30741
|
* @throws {RequiredError}
|
|
29626
30742
|
*/
|
|
29627
30743
|
syncIdentityProfile(identityProfileId: string, axiosOptions?: any): AxiosPromise<object>;
|
|
30744
|
+
/**
|
|
30745
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
30746
|
+
* @summary Update the Identity Profile
|
|
30747
|
+
* @param {string} identityProfileId The Identity Profile ID
|
|
30748
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
30749
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30750
|
+
* @throws {RequiredError}
|
|
30751
|
+
*/
|
|
30752
|
+
updateIdentityProfile(identityProfileId: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<IdentityProfile>;
|
|
29628
30753
|
};
|
|
30754
|
+
/**
|
|
30755
|
+
* Request parameters for createIdentityProfile operation in IdentityProfilesApi.
|
|
30756
|
+
* @export
|
|
30757
|
+
* @interface IdentityProfilesApiCreateIdentityProfileRequest
|
|
30758
|
+
*/
|
|
30759
|
+
export interface IdentityProfilesApiCreateIdentityProfileRequest {
|
|
30760
|
+
/**
|
|
30761
|
+
*
|
|
30762
|
+
* @type {IdentityProfile}
|
|
30763
|
+
* @memberof IdentityProfilesApiCreateIdentityProfile
|
|
30764
|
+
*/
|
|
30765
|
+
readonly identityProfile: IdentityProfile;
|
|
30766
|
+
}
|
|
29629
30767
|
/**
|
|
29630
30768
|
* Request parameters for deleteIdentityProfile operation in IdentityProfilesApi.
|
|
29631
30769
|
* @export
|
|
@@ -29765,6 +30903,19 @@ export interface IdentityProfilesApiListIdentityProfilesRequest {
|
|
|
29765
30903
|
*/
|
|
29766
30904
|
readonly sorters?: string;
|
|
29767
30905
|
}
|
|
30906
|
+
/**
|
|
30907
|
+
* Request parameters for showIdentityPreview operation in IdentityProfilesApi.
|
|
30908
|
+
* @export
|
|
30909
|
+
* @interface IdentityProfilesApiShowIdentityPreviewRequest
|
|
30910
|
+
*/
|
|
30911
|
+
export interface IdentityProfilesApiShowIdentityPreviewRequest {
|
|
30912
|
+
/**
|
|
30913
|
+
* Identity Preview request body.
|
|
30914
|
+
* @type {IdentityPreviewRequest}
|
|
30915
|
+
* @memberof IdentityProfilesApiShowIdentityPreview
|
|
30916
|
+
*/
|
|
30917
|
+
readonly identityPreviewRequest: IdentityPreviewRequest;
|
|
30918
|
+
}
|
|
29768
30919
|
/**
|
|
29769
30920
|
* Request parameters for syncIdentityProfile operation in IdentityProfilesApi.
|
|
29770
30921
|
* @export
|
|
@@ -29778,6 +30929,25 @@ export interface IdentityProfilesApiSyncIdentityProfileRequest {
|
|
|
29778
30929
|
*/
|
|
29779
30930
|
readonly identityProfileId: string;
|
|
29780
30931
|
}
|
|
30932
|
+
/**
|
|
30933
|
+
* Request parameters for updateIdentityProfile operation in IdentityProfilesApi.
|
|
30934
|
+
* @export
|
|
30935
|
+
* @interface IdentityProfilesApiUpdateIdentityProfileRequest
|
|
30936
|
+
*/
|
|
30937
|
+
export interface IdentityProfilesApiUpdateIdentityProfileRequest {
|
|
30938
|
+
/**
|
|
30939
|
+
* The Identity Profile ID
|
|
30940
|
+
* @type {string}
|
|
30941
|
+
* @memberof IdentityProfilesApiUpdateIdentityProfile
|
|
30942
|
+
*/
|
|
30943
|
+
readonly identityProfileId: string;
|
|
30944
|
+
/**
|
|
30945
|
+
* A list of Identity Profile update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
30946
|
+
* @type {Array<JsonPatchOperation>}
|
|
30947
|
+
* @memberof IdentityProfilesApiUpdateIdentityProfile
|
|
30948
|
+
*/
|
|
30949
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
30950
|
+
}
|
|
29781
30951
|
/**
|
|
29782
30952
|
* IdentityProfilesApi - object-oriented interface
|
|
29783
30953
|
* @export
|
|
@@ -29785,6 +30955,15 @@ export interface IdentityProfilesApiSyncIdentityProfileRequest {
|
|
|
29785
30955
|
* @extends {BaseAPI}
|
|
29786
30956
|
*/
|
|
29787
30957
|
export declare class IdentityProfilesApi extends BaseAPI {
|
|
30958
|
+
/**
|
|
30959
|
+
* This creates an Identity Profile. A token with ORG_ADMIN authority is required to call this API to create an Identity Profile.
|
|
30960
|
+
* @summary Create an Identity Profile
|
|
30961
|
+
* @param {IdentityProfilesApiCreateIdentityProfileRequest} requestParameters Request parameters.
|
|
30962
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30963
|
+
* @throws {RequiredError}
|
|
30964
|
+
* @memberof IdentityProfilesApi
|
|
30965
|
+
*/
|
|
30966
|
+
createIdentityProfile(requestParameters: IdentityProfilesApiCreateIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfile, any>>;
|
|
29788
30967
|
/**
|
|
29789
30968
|
* This deletes an Identity Profile based on ID. On success, this endpoint will return a reference to the bulk delete task result. A token with ORG_ADMIN authority is required to call this API. The following rights are required to access this endpoint: idn:identity-profile:delete
|
|
29790
30969
|
* @summary Delete an Identity Profile
|
|
@@ -29822,7 +31001,7 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29822
31001
|
*/
|
|
29823
31002
|
getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityAttributeConfig, any>>;
|
|
29824
31003
|
/**
|
|
29825
|
-
* This returns a single Identity Profile based on ID.
|
|
31004
|
+
* This returns a single Identity Profile based on ID. A token with ORG_ADMIN or API authority is required to call this API.
|
|
29826
31005
|
* @summary Get single Identity Profile
|
|
29827
31006
|
* @param {IdentityProfilesApiGetIdentityProfileRequest} requestParameters Request parameters.
|
|
29828
31007
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29848,6 +31027,15 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29848
31027
|
* @memberof IdentityProfilesApi
|
|
29849
31028
|
*/
|
|
29850
31029
|
listIdentityProfiles(requestParameters?: IdentityProfilesApiListIdentityProfilesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfile[], any>>;
|
|
31030
|
+
/**
|
|
31031
|
+
* Use this API to generate a non-persisted preview of the identity object after applying `IdentityAttributeConfig` sent in request body. This API only allows `accountAttribute`, `reference` and `rule` transform types in the `IdentityAttributeConfig` sent in the request body. A token with ORG_ADMIN authority is required to call this API to generate an identity preview.
|
|
31032
|
+
* @summary Generate Identity Profile Preview
|
|
31033
|
+
* @param {IdentityProfilesApiShowIdentityPreviewRequest} requestParameters Request parameters.
|
|
31034
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
31035
|
+
* @throws {RequiredError}
|
|
31036
|
+
* @memberof IdentityProfilesApi
|
|
31037
|
+
*/
|
|
31038
|
+
showIdentityPreview(requestParameters: IdentityProfilesApiShowIdentityPreviewRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityPreviewResponse, any>>;
|
|
29851
31039
|
/**
|
|
29852
31040
|
* Process identities under the profile This operation should not be used to schedule your own identity processing or to perform system wide identity refreshes. The system will use a combination of [event-based processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#event-based-processing) and [scheduled processing](https://documentation.sailpoint.com/saas/help/setup/identity_processing.html?h=process#scheduled-processing) that runs every day at 8:00 AM and 8:00 PM in the tenant\'s timezone to keep your identities synchronized. This should only be run on identity profiles that have the `identityRefreshRequired` attribute set to `true`. If `identityRefreshRequired` is false, then there is no benefit to running this operation. Typically, this operation is performed when a change is made to the identity profile or its related lifecycle states that requires a refresh. This operation will perform the following activities on all identities under the identity profile. 1. Updates identity attribute according to the identity profile mappings. 2. Determines the identity\'s correct manager through manager correlation. 3. Updates the identity\'s access according to their assigned lifecycle state. 4. Updates the identity\'s access based on role assignment criteria. A token with ORG_ADMIN authority is required to call this API.
|
|
29853
31041
|
* @summary Process identities under profile
|
|
@@ -29857,6 +31045,15 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29857
31045
|
* @memberof IdentityProfilesApi
|
|
29858
31046
|
*/
|
|
29859
31047
|
syncIdentityProfile(requestParameters: IdentityProfilesApiSyncIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
31048
|
+
/**
|
|
31049
|
+
* This updates the specified Identity Profile. A token with ORG_ADMIN authority is required to call this API to update the Identity Profile. Some fields of the Schema cannot be updated. These fields are listed below: * id * name * created * modified * identityCount * identityRefreshRequired * Authoritative Source and Identity Attribute Configuration cannot be modified at once.
|
|
31050
|
+
* @summary Update the Identity Profile
|
|
31051
|
+
* @param {IdentityProfilesApiUpdateIdentityProfileRequest} requestParameters Request parameters.
|
|
31052
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
31053
|
+
* @throws {RequiredError}
|
|
31054
|
+
* @memberof IdentityProfilesApi
|
|
31055
|
+
*/
|
|
31056
|
+
updateIdentityProfile(requestParameters: IdentityProfilesApiUpdateIdentityProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityProfile, any>>;
|
|
29860
31057
|
}
|
|
29861
31058
|
/**
|
|
29862
31059
|
* LifecycleStatesApi - axios parameter creator
|
|
@@ -34620,7 +35817,7 @@ export declare const PersonalAccessTokensApiAxiosParamCreator: (configuration?:
|
|
|
34620
35817
|
*/
|
|
34621
35818
|
listPersonalAccessTokens: (ownerId?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34622
35819
|
/**
|
|
34623
|
-
* This performs a targeted update to the field(s) of a Personal Access Token.
|
|
35820
|
+
* This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
|
|
34624
35821
|
* @summary Patch Personal Access Token
|
|
34625
35822
|
* @param {string} id The Personal Access Token id
|
|
34626
35823
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
|
|
@@ -34660,7 +35857,7 @@ export declare const PersonalAccessTokensApiFp: (configuration?: Configuration)
|
|
|
34660
35857
|
*/
|
|
34661
35858
|
listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetPersonalAccessTokenResponse>>>;
|
|
34662
35859
|
/**
|
|
34663
|
-
* This performs a targeted update to the field(s) of a Personal Access Token.
|
|
35860
|
+
* This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
|
|
34664
35861
|
* @summary Patch Personal Access Token
|
|
34665
35862
|
* @param {string} id The Personal Access Token id
|
|
34666
35863
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
|
|
@@ -34700,7 +35897,7 @@ export declare const PersonalAccessTokensApiFactory: (configuration?: Configurat
|
|
|
34700
35897
|
*/
|
|
34701
35898
|
listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<GetPersonalAccessTokenResponse>>;
|
|
34702
35899
|
/**
|
|
34703
|
-
* This performs a targeted update to the field(s) of a Personal Access Token.
|
|
35900
|
+
* This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
|
|
34704
35901
|
* @summary Patch Personal Access Token
|
|
34705
35902
|
* @param {string} id The Personal Access Token id
|
|
34706
35903
|
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of OAuth client update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. The following fields are patchable: * name * scope
|
|
@@ -34808,7 +36005,7 @@ export declare class PersonalAccessTokensApi extends BaseAPI {
|
|
|
34808
36005
|
*/
|
|
34809
36006
|
listPersonalAccessTokens(requestParameters?: PersonalAccessTokensApiListPersonalAccessTokensRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPersonalAccessTokenResponse[], any>>;
|
|
34810
36007
|
/**
|
|
34811
|
-
* This performs a targeted update to the field(s) of a Personal Access Token.
|
|
36008
|
+
* This performs a targeted update to the field(s) of a Personal Access Token. Changing scopes for a Personal Access Token does not impact existing bearer tokens. You will need to create a new bearer token to have the new scopes. Please note that it can take up to 20 minutes for scope changes to be seen on new bearer tokens.
|
|
34812
36009
|
* @summary Patch Personal Access Token
|
|
34813
36010
|
* @param {PersonalAccessTokensApiPatchPersonalAccessTokenRequest} requestParameters Request parameters.
|
|
34814
36011
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37847,6 +39044,254 @@ export declare class SearchApi extends BaseAPI {
|
|
|
37847
39044
|
*/
|
|
37848
39045
|
searchPost(requestParameters: SearchApiSearchPostRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchDocument[], any>>;
|
|
37849
39046
|
}
|
|
39047
|
+
/**
|
|
39048
|
+
* SearchAttributeConfigurationApi - axios parameter creator
|
|
39049
|
+
* @export
|
|
39050
|
+
*/
|
|
39051
|
+
export declare const SearchAttributeConfigurationApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
39052
|
+
/**
|
|
39053
|
+
* This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. A token with ORG_ADMIN authority is required to call this API.
|
|
39054
|
+
* @summary Configure/create search attributes in IdentityNow.
|
|
39055
|
+
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39056
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39057
|
+
* @throws {RequiredError}
|
|
39058
|
+
*/
|
|
39059
|
+
createSearchAttributeConfig: (searchAttributeConfig: SearchAttributeConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39060
|
+
/**
|
|
39061
|
+
* This API accepts an extended search attribute name and deletes the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39062
|
+
* @summary Delete search attribute in IdentityNow.
|
|
39063
|
+
* @param {string} name Name of the extended search attribute configuration to delete.
|
|
39064
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39065
|
+
* @throws {RequiredError}
|
|
39066
|
+
*/
|
|
39067
|
+
deleteSearchAttributeConfig: (name: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39068
|
+
/**
|
|
39069
|
+
* This API retrieves a list of extended search attribute/application associates currently configured in IdentityNow. A token with ORG_ADMIN authority is required to call this API.
|
|
39070
|
+
* @summary Retrieve attribute list in IdentityNow.
|
|
39071
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39072
|
+
* @throws {RequiredError}
|
|
39073
|
+
*/
|
|
39074
|
+
getSearchAttributeConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39075
|
+
/**
|
|
39076
|
+
* This API accepts an extended search attribute name and retrieves the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39077
|
+
* @summary Get specific attribute in IdentityNow.
|
|
39078
|
+
* @param {string} name Name of the extended search attribute configuration to retrieve.
|
|
39079
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39080
|
+
* @throws {RequiredError}
|
|
39081
|
+
*/
|
|
39082
|
+
getSingleSearchAttributeConfig: (name: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39083
|
+
/**
|
|
39084
|
+
* This API updates an existing Search Attribute Configuration. The following fields are patchable: **name**, **displayName**, **applicationAttributes** A token with ORG_ADMIN authority is required to call this API.
|
|
39085
|
+
* @summary Update search attribute in IdentityNow.
|
|
39086
|
+
* @param {string} name Name of the Search Attribute Configuration to patch.
|
|
39087
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
39088
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39089
|
+
* @throws {RequiredError}
|
|
39090
|
+
*/
|
|
39091
|
+
patchSearchAttributeConfig: (name: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39092
|
+
};
|
|
39093
|
+
/**
|
|
39094
|
+
* SearchAttributeConfigurationApi - functional programming interface
|
|
39095
|
+
* @export
|
|
39096
|
+
*/
|
|
39097
|
+
export declare const SearchAttributeConfigurationApiFp: (configuration?: Configuration) => {
|
|
39098
|
+
/**
|
|
39099
|
+
* This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. A token with ORG_ADMIN authority is required to call this API.
|
|
39100
|
+
* @summary Configure/create search attributes in IdentityNow.
|
|
39101
|
+
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39102
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39103
|
+
* @throws {RequiredError}
|
|
39104
|
+
*/
|
|
39105
|
+
createSearchAttributeConfig(searchAttributeConfig: SearchAttributeConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
39106
|
+
/**
|
|
39107
|
+
* This API accepts an extended search attribute name and deletes the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39108
|
+
* @summary Delete search attribute in IdentityNow.
|
|
39109
|
+
* @param {string} name Name of the extended search attribute configuration to delete.
|
|
39110
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39111
|
+
* @throws {RequiredError}
|
|
39112
|
+
*/
|
|
39113
|
+
deleteSearchAttributeConfig(name: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
39114
|
+
/**
|
|
39115
|
+
* This API retrieves a list of extended search attribute/application associates currently configured in IdentityNow. A token with ORG_ADMIN authority is required to call this API.
|
|
39116
|
+
* @summary Retrieve attribute list in IdentityNow.
|
|
39117
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39118
|
+
* @throws {RequiredError}
|
|
39119
|
+
*/
|
|
39120
|
+
getSearchAttributeConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39121
|
+
/**
|
|
39122
|
+
* This API accepts an extended search attribute name and retrieves the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39123
|
+
* @summary Get specific attribute in IdentityNow.
|
|
39124
|
+
* @param {string} name Name of the extended search attribute configuration to retrieve.
|
|
39125
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39126
|
+
* @throws {RequiredError}
|
|
39127
|
+
*/
|
|
39128
|
+
getSingleSearchAttributeConfig(name: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<SearchAttributeConfig>>>;
|
|
39129
|
+
/**
|
|
39130
|
+
* This API updates an existing Search Attribute Configuration. The following fields are patchable: **name**, **displayName**, **applicationAttributes** A token with ORG_ADMIN authority is required to call this API.
|
|
39131
|
+
* @summary Update search attribute in IdentityNow.
|
|
39132
|
+
* @param {string} name Name of the Search Attribute Configuration to patch.
|
|
39133
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
39134
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39135
|
+
* @throws {RequiredError}
|
|
39136
|
+
*/
|
|
39137
|
+
patchSearchAttributeConfig(name: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SearchAttributeConfig>>;
|
|
39138
|
+
};
|
|
39139
|
+
/**
|
|
39140
|
+
* SearchAttributeConfigurationApi - factory interface
|
|
39141
|
+
* @export
|
|
39142
|
+
*/
|
|
39143
|
+
export declare const SearchAttributeConfigurationApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
39144
|
+
/**
|
|
39145
|
+
* This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. A token with ORG_ADMIN authority is required to call this API.
|
|
39146
|
+
* @summary Configure/create search attributes in IdentityNow.
|
|
39147
|
+
* @param {SearchAttributeConfig} searchAttributeConfig
|
|
39148
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39149
|
+
* @throws {RequiredError}
|
|
39150
|
+
*/
|
|
39151
|
+
createSearchAttributeConfig(searchAttributeConfig: SearchAttributeConfig, axiosOptions?: any): AxiosPromise<object>;
|
|
39152
|
+
/**
|
|
39153
|
+
* This API accepts an extended search attribute name and deletes the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39154
|
+
* @summary Delete search attribute in IdentityNow.
|
|
39155
|
+
* @param {string} name Name of the extended search attribute configuration to delete.
|
|
39156
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39157
|
+
* @throws {RequiredError}
|
|
39158
|
+
*/
|
|
39159
|
+
deleteSearchAttributeConfig(name: string, axiosOptions?: any): AxiosPromise<void>;
|
|
39160
|
+
/**
|
|
39161
|
+
* This API retrieves a list of extended search attribute/application associates currently configured in IdentityNow. A token with ORG_ADMIN authority is required to call this API.
|
|
39162
|
+
* @summary Retrieve attribute list in IdentityNow.
|
|
39163
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39164
|
+
* @throws {RequiredError}
|
|
39165
|
+
*/
|
|
39166
|
+
getSearchAttributeConfig(axiosOptions?: any): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39167
|
+
/**
|
|
39168
|
+
* This API accepts an extended search attribute name and retrieves the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39169
|
+
* @summary Get specific attribute in IdentityNow.
|
|
39170
|
+
* @param {string} name Name of the extended search attribute configuration to retrieve.
|
|
39171
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39172
|
+
* @throws {RequiredError}
|
|
39173
|
+
*/
|
|
39174
|
+
getSingleSearchAttributeConfig(name: string, axiosOptions?: any): AxiosPromise<Array<SearchAttributeConfig>>;
|
|
39175
|
+
/**
|
|
39176
|
+
* This API updates an existing Search Attribute Configuration. The following fields are patchable: **name**, **displayName**, **applicationAttributes** A token with ORG_ADMIN authority is required to call this API.
|
|
39177
|
+
* @summary Update search attribute in IdentityNow.
|
|
39178
|
+
* @param {string} name Name of the Search Attribute Configuration to patch.
|
|
39179
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
39180
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39181
|
+
* @throws {RequiredError}
|
|
39182
|
+
*/
|
|
39183
|
+
patchSearchAttributeConfig(name: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<SearchAttributeConfig>;
|
|
39184
|
+
};
|
|
39185
|
+
/**
|
|
39186
|
+
* Request parameters for createSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39187
|
+
* @export
|
|
39188
|
+
* @interface SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest
|
|
39189
|
+
*/
|
|
39190
|
+
export interface SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest {
|
|
39191
|
+
/**
|
|
39192
|
+
*
|
|
39193
|
+
* @type {SearchAttributeConfig}
|
|
39194
|
+
* @memberof SearchAttributeConfigurationApiCreateSearchAttributeConfig
|
|
39195
|
+
*/
|
|
39196
|
+
readonly searchAttributeConfig: SearchAttributeConfig;
|
|
39197
|
+
}
|
|
39198
|
+
/**
|
|
39199
|
+
* Request parameters for deleteSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39200
|
+
* @export
|
|
39201
|
+
* @interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest
|
|
39202
|
+
*/
|
|
39203
|
+
export interface SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest {
|
|
39204
|
+
/**
|
|
39205
|
+
* Name of the extended search attribute configuration to delete.
|
|
39206
|
+
* @type {string}
|
|
39207
|
+
* @memberof SearchAttributeConfigurationApiDeleteSearchAttributeConfig
|
|
39208
|
+
*/
|
|
39209
|
+
readonly name: string;
|
|
39210
|
+
}
|
|
39211
|
+
/**
|
|
39212
|
+
* Request parameters for getSingleSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39213
|
+
* @export
|
|
39214
|
+
* @interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest
|
|
39215
|
+
*/
|
|
39216
|
+
export interface SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest {
|
|
39217
|
+
/**
|
|
39218
|
+
* Name of the extended search attribute configuration to retrieve.
|
|
39219
|
+
* @type {string}
|
|
39220
|
+
* @memberof SearchAttributeConfigurationApiGetSingleSearchAttributeConfig
|
|
39221
|
+
*/
|
|
39222
|
+
readonly name: string;
|
|
39223
|
+
}
|
|
39224
|
+
/**
|
|
39225
|
+
* Request parameters for patchSearchAttributeConfig operation in SearchAttributeConfigurationApi.
|
|
39226
|
+
* @export
|
|
39227
|
+
* @interface SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest
|
|
39228
|
+
*/
|
|
39229
|
+
export interface SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest {
|
|
39230
|
+
/**
|
|
39231
|
+
* Name of the Search Attribute Configuration to patch.
|
|
39232
|
+
* @type {string}
|
|
39233
|
+
* @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfig
|
|
39234
|
+
*/
|
|
39235
|
+
readonly name: string;
|
|
39236
|
+
/**
|
|
39237
|
+
*
|
|
39238
|
+
* @type {Array<JsonPatchOperation>}
|
|
39239
|
+
* @memberof SearchAttributeConfigurationApiPatchSearchAttributeConfig
|
|
39240
|
+
*/
|
|
39241
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
39242
|
+
}
|
|
39243
|
+
/**
|
|
39244
|
+
* SearchAttributeConfigurationApi - object-oriented interface
|
|
39245
|
+
* @export
|
|
39246
|
+
* @class SearchAttributeConfigurationApi
|
|
39247
|
+
* @extends {BaseAPI}
|
|
39248
|
+
*/
|
|
39249
|
+
export declare class SearchAttributeConfigurationApi extends BaseAPI {
|
|
39250
|
+
/**
|
|
39251
|
+
* This API accepts an attribute name, an attribute display name and a list of name/value pair associates of application IDs to attribute names. It will then validate the inputs and configure/create and attribute promotion configuration in the Link ObjectConfig. A token with ORG_ADMIN authority is required to call this API.
|
|
39252
|
+
* @summary Configure/create search attributes in IdentityNow.
|
|
39253
|
+
* @param {SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39254
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39255
|
+
* @throws {RequiredError}
|
|
39256
|
+
* @memberof SearchAttributeConfigurationApi
|
|
39257
|
+
*/
|
|
39258
|
+
createSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiCreateSearchAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
39259
|
+
/**
|
|
39260
|
+
* This API accepts an extended search attribute name and deletes the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39261
|
+
* @summary Delete search attribute in IdentityNow.
|
|
39262
|
+
* @param {SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39263
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39264
|
+
* @throws {RequiredError}
|
|
39265
|
+
* @memberof SearchAttributeConfigurationApi
|
|
39266
|
+
*/
|
|
39267
|
+
deleteSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiDeleteSearchAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
39268
|
+
/**
|
|
39269
|
+
* This API retrieves a list of extended search attribute/application associates currently configured in IdentityNow. A token with ORG_ADMIN authority is required to call this API.
|
|
39270
|
+
* @summary Retrieve attribute list in IdentityNow.
|
|
39271
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39272
|
+
* @throws {RequiredError}
|
|
39273
|
+
* @memberof SearchAttributeConfigurationApi
|
|
39274
|
+
*/
|
|
39275
|
+
getSearchAttributeConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39276
|
+
/**
|
|
39277
|
+
* This API accepts an extended search attribute name and retrieves the corresponding extended attribute configuration. A token with ORG_ADMIN authority is required to call this API.
|
|
39278
|
+
* @summary Get specific attribute in IdentityNow.
|
|
39279
|
+
* @param {SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39280
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39281
|
+
* @throws {RequiredError}
|
|
39282
|
+
* @memberof SearchAttributeConfigurationApi
|
|
39283
|
+
*/
|
|
39284
|
+
getSingleSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiGetSingleSearchAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig[], any>>;
|
|
39285
|
+
/**
|
|
39286
|
+
* This API updates an existing Search Attribute Configuration. The following fields are patchable: **name**, **displayName**, **applicationAttributes** A token with ORG_ADMIN authority is required to call this API.
|
|
39287
|
+
* @summary Update search attribute in IdentityNow.
|
|
39288
|
+
* @param {SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest} requestParameters Request parameters.
|
|
39289
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
39290
|
+
* @throws {RequiredError}
|
|
39291
|
+
* @memberof SearchAttributeConfigurationApi
|
|
39292
|
+
*/
|
|
39293
|
+
patchSearchAttributeConfig(requestParameters: SearchAttributeConfigurationApiPatchSearchAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchAttributeConfig, any>>;
|
|
39294
|
+
}
|
|
37850
39295
|
/**
|
|
37851
39296
|
* SegmentsApi - axios parameter creator
|
|
37852
39297
|
* @export
|
|
@@ -40244,11 +41689,11 @@ export declare const TaggedObjectsApiAxiosParamCreator: (configuration?: Configu
|
|
|
40244
41689
|
/**
|
|
40245
41690
|
* This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40246
41691
|
* @summary Remove Tags from Multiple Objects
|
|
40247
|
-
* @param {
|
|
41692
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40248
41693
|
* @param {*} [axiosOptions] Override http request option.
|
|
40249
41694
|
* @throws {RequiredError}
|
|
40250
41695
|
*/
|
|
40251
|
-
deleteTagsToManyObject: (
|
|
41696
|
+
deleteTagsToManyObject: (bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40252
41697
|
/**
|
|
40253
41698
|
* This gets a tagged object for the specified type.
|
|
40254
41699
|
* @summary Get Tagged Object
|
|
@@ -40302,11 +41747,11 @@ export declare const TaggedObjectsApiAxiosParamCreator: (configuration?: Configu
|
|
|
40302
41747
|
/**
|
|
40303
41748
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40304
41749
|
* @summary Tag Multiple Objects
|
|
40305
|
-
* @param {
|
|
41750
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40306
41751
|
* @param {*} [axiosOptions] Override http request option.
|
|
40307
41752
|
* @throws {RequiredError}
|
|
40308
41753
|
*/
|
|
40309
|
-
setTagsToManyObjects: (
|
|
41754
|
+
setTagsToManyObjects: (bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
40310
41755
|
};
|
|
40311
41756
|
/**
|
|
40312
41757
|
* TaggedObjectsApi - functional programming interface
|
|
@@ -40325,11 +41770,11 @@ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => {
|
|
|
40325
41770
|
/**
|
|
40326
41771
|
* This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40327
41772
|
* @summary Remove Tags from Multiple Objects
|
|
40328
|
-
* @param {
|
|
41773
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40329
41774
|
* @param {*} [axiosOptions] Override http request option.
|
|
40330
41775
|
* @throws {RequiredError}
|
|
40331
41776
|
*/
|
|
40332
|
-
deleteTagsToManyObject(
|
|
41777
|
+
deleteTagsToManyObject(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
40333
41778
|
/**
|
|
40334
41779
|
* This gets a tagged object for the specified type.
|
|
40335
41780
|
* @summary Get Tagged Object
|
|
@@ -40383,11 +41828,11 @@ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => {
|
|
|
40383
41828
|
/**
|
|
40384
41829
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40385
41830
|
* @summary Tag Multiple Objects
|
|
40386
|
-
* @param {
|
|
41831
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40387
41832
|
* @param {*} [axiosOptions] Override http request option.
|
|
40388
41833
|
* @throws {RequiredError}
|
|
40389
41834
|
*/
|
|
40390
|
-
setTagsToManyObjects(
|
|
41835
|
+
setTagsToManyObjects(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BulkTaggedObjectResponse>>>;
|
|
40391
41836
|
};
|
|
40392
41837
|
/**
|
|
40393
41838
|
* TaggedObjectsApi - factory interface
|
|
@@ -40406,11 +41851,11 @@ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, ba
|
|
|
40406
41851
|
/**
|
|
40407
41852
|
* This API removes tags from multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40408
41853
|
* @summary Remove Tags from Multiple Objects
|
|
40409
|
-
* @param {
|
|
41854
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40410
41855
|
* @param {*} [axiosOptions] Override http request option.
|
|
40411
41856
|
* @throws {RequiredError}
|
|
40412
41857
|
*/
|
|
40413
|
-
deleteTagsToManyObject(
|
|
41858
|
+
deleteTagsToManyObject(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: any): AxiosPromise<void>;
|
|
40414
41859
|
/**
|
|
40415
41860
|
* This gets a tagged object for the specified type.
|
|
40416
41861
|
* @summary Get Tagged Object
|
|
@@ -40464,11 +41909,11 @@ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, ba
|
|
|
40464
41909
|
/**
|
|
40465
41910
|
* This API adds tags to multiple objects. A token with API, CERT_ADMIN, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, or SOURCE_SUBADMIN authority is required to call this API.
|
|
40466
41911
|
* @summary Tag Multiple Objects
|
|
40467
|
-
* @param {
|
|
41912
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40468
41913
|
* @param {*} [axiosOptions] Override http request option.
|
|
40469
41914
|
* @throws {RequiredError}
|
|
40470
41915
|
*/
|
|
40471
|
-
setTagsToManyObjects(
|
|
41916
|
+
setTagsToManyObjects(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: any): AxiosPromise<Array<BulkTaggedObjectResponse>>;
|
|
40472
41917
|
};
|
|
40473
41918
|
/**
|
|
40474
41919
|
* Request parameters for deleteTaggedObject operation in TaggedObjectsApi.
|
|
@@ -40497,10 +41942,10 @@ export interface TaggedObjectsApiDeleteTaggedObjectRequest {
|
|
|
40497
41942
|
export interface TaggedObjectsApiDeleteTagsToManyObjectRequest {
|
|
40498
41943
|
/**
|
|
40499
41944
|
* Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40500
|
-
* @type {
|
|
41945
|
+
* @type {BulkRemoveTaggedObject}
|
|
40501
41946
|
* @memberof TaggedObjectsApiDeleteTagsToManyObject
|
|
40502
41947
|
*/
|
|
40503
|
-
readonly
|
|
41948
|
+
readonly bulkRemoveTaggedObject: BulkRemoveTaggedObject;
|
|
40504
41949
|
}
|
|
40505
41950
|
/**
|
|
40506
41951
|
* Request parameters for getTaggedObject operation in TaggedObjectsApi.
|
|
@@ -40635,10 +42080,10 @@ export interface TaggedObjectsApiSetTagToObjectRequest {
|
|
|
40635
42080
|
export interface TaggedObjectsApiSetTagsToManyObjectsRequest {
|
|
40636
42081
|
/**
|
|
40637
42082
|
* Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40638
|
-
* @type {
|
|
42083
|
+
* @type {BulkAddTaggedObject}
|
|
40639
42084
|
* @memberof TaggedObjectsApiSetTagsToManyObjects
|
|
40640
42085
|
*/
|
|
40641
|
-
readonly
|
|
42086
|
+
readonly bulkAddTaggedObject: BulkAddTaggedObject;
|
|
40642
42087
|
}
|
|
40643
42088
|
/**
|
|
40644
42089
|
* TaggedObjectsApi - object-oriented interface
|
|
@@ -41021,6 +42466,124 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
41021
42466
|
*/
|
|
41022
42467
|
updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead, any>>;
|
|
41023
42468
|
}
|
|
42469
|
+
/**
|
|
42470
|
+
* VendorConnectorMappingsApi - axios parameter creator
|
|
42471
|
+
* @export
|
|
42472
|
+
*/
|
|
42473
|
+
export declare const VendorConnectorMappingsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
42474
|
+
/**
|
|
42475
|
+
* Creates a new mapping between a SaaS vendor and an IDN connector to establish correlation paths.
|
|
42476
|
+
* @summary Create a vendor connector mapping
|
|
42477
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42478
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42479
|
+
* @throws {RequiredError}
|
|
42480
|
+
*/
|
|
42481
|
+
createVendorConnectorMapping: (vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42482
|
+
/**
|
|
42483
|
+
* Soft deletes a mapping between a SaaS vendor and an IDN connector, removing the established correlation.
|
|
42484
|
+
* @summary Delete a vendor connector mapping
|
|
42485
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42486
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42487
|
+
* @throws {RequiredError}
|
|
42488
|
+
*/
|
|
42489
|
+
deleteVendorConnectorMapping: (vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42490
|
+
};
|
|
42491
|
+
/**
|
|
42492
|
+
* VendorConnectorMappingsApi - functional programming interface
|
|
42493
|
+
* @export
|
|
42494
|
+
*/
|
|
42495
|
+
export declare const VendorConnectorMappingsApiFp: (configuration?: Configuration) => {
|
|
42496
|
+
/**
|
|
42497
|
+
* Creates a new mapping between a SaaS vendor and an IDN connector to establish correlation paths.
|
|
42498
|
+
* @summary Create a vendor connector mapping
|
|
42499
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42500
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42501
|
+
* @throws {RequiredError}
|
|
42502
|
+
*/
|
|
42503
|
+
createVendorConnectorMapping(vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VendorConnectorMapping>>;
|
|
42504
|
+
/**
|
|
42505
|
+
* Soft deletes a mapping between a SaaS vendor and an IDN connector, removing the established correlation.
|
|
42506
|
+
* @summary Delete a vendor connector mapping
|
|
42507
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42508
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42509
|
+
* @throws {RequiredError}
|
|
42510
|
+
*/
|
|
42511
|
+
deleteVendorConnectorMapping(vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DeleteVendorConnectorMapping200Response>>;
|
|
42512
|
+
};
|
|
42513
|
+
/**
|
|
42514
|
+
* VendorConnectorMappingsApi - factory interface
|
|
42515
|
+
* @export
|
|
42516
|
+
*/
|
|
42517
|
+
export declare const VendorConnectorMappingsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
42518
|
+
/**
|
|
42519
|
+
* Creates a new mapping between a SaaS vendor and an IDN connector to establish correlation paths.
|
|
42520
|
+
* @summary Create a vendor connector mapping
|
|
42521
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42522
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42523
|
+
* @throws {RequiredError}
|
|
42524
|
+
*/
|
|
42525
|
+
createVendorConnectorMapping(vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: any): AxiosPromise<VendorConnectorMapping>;
|
|
42526
|
+
/**
|
|
42527
|
+
* Soft deletes a mapping between a SaaS vendor and an IDN connector, removing the established correlation.
|
|
42528
|
+
* @summary Delete a vendor connector mapping
|
|
42529
|
+
* @param {VendorConnectorMapping} vendorConnectorMapping
|
|
42530
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42531
|
+
* @throws {RequiredError}
|
|
42532
|
+
*/
|
|
42533
|
+
deleteVendorConnectorMapping(vendorConnectorMapping: VendorConnectorMapping, axiosOptions?: any): AxiosPromise<DeleteVendorConnectorMapping200Response>;
|
|
42534
|
+
};
|
|
42535
|
+
/**
|
|
42536
|
+
* Request parameters for createVendorConnectorMapping operation in VendorConnectorMappingsApi.
|
|
42537
|
+
* @export
|
|
42538
|
+
* @interface VendorConnectorMappingsApiCreateVendorConnectorMappingRequest
|
|
42539
|
+
*/
|
|
42540
|
+
export interface VendorConnectorMappingsApiCreateVendorConnectorMappingRequest {
|
|
42541
|
+
/**
|
|
42542
|
+
*
|
|
42543
|
+
* @type {VendorConnectorMapping}
|
|
42544
|
+
* @memberof VendorConnectorMappingsApiCreateVendorConnectorMapping
|
|
42545
|
+
*/
|
|
42546
|
+
readonly vendorConnectorMapping: VendorConnectorMapping;
|
|
42547
|
+
}
|
|
42548
|
+
/**
|
|
42549
|
+
* Request parameters for deleteVendorConnectorMapping operation in VendorConnectorMappingsApi.
|
|
42550
|
+
* @export
|
|
42551
|
+
* @interface VendorConnectorMappingsApiDeleteVendorConnectorMappingRequest
|
|
42552
|
+
*/
|
|
42553
|
+
export interface VendorConnectorMappingsApiDeleteVendorConnectorMappingRequest {
|
|
42554
|
+
/**
|
|
42555
|
+
*
|
|
42556
|
+
* @type {VendorConnectorMapping}
|
|
42557
|
+
* @memberof VendorConnectorMappingsApiDeleteVendorConnectorMapping
|
|
42558
|
+
*/
|
|
42559
|
+
readonly vendorConnectorMapping: VendorConnectorMapping;
|
|
42560
|
+
}
|
|
42561
|
+
/**
|
|
42562
|
+
* VendorConnectorMappingsApi - object-oriented interface
|
|
42563
|
+
* @export
|
|
42564
|
+
* @class VendorConnectorMappingsApi
|
|
42565
|
+
* @extends {BaseAPI}
|
|
42566
|
+
*/
|
|
42567
|
+
export declare class VendorConnectorMappingsApi extends BaseAPI {
|
|
42568
|
+
/**
|
|
42569
|
+
* Creates a new mapping between a SaaS vendor and an IDN connector to establish correlation paths.
|
|
42570
|
+
* @summary Create a vendor connector mapping
|
|
42571
|
+
* @param {VendorConnectorMappingsApiCreateVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
42572
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42573
|
+
* @throws {RequiredError}
|
|
42574
|
+
* @memberof VendorConnectorMappingsApi
|
|
42575
|
+
*/
|
|
42576
|
+
createVendorConnectorMapping(requestParameters: VendorConnectorMappingsApiCreateVendorConnectorMappingRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VendorConnectorMapping, any>>;
|
|
42577
|
+
/**
|
|
42578
|
+
* Soft deletes a mapping between a SaaS vendor and an IDN connector, removing the established correlation.
|
|
42579
|
+
* @summary Delete a vendor connector mapping
|
|
42580
|
+
* @param {VendorConnectorMappingsApiDeleteVendorConnectorMappingRequest} requestParameters Request parameters.
|
|
42581
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42582
|
+
* @throws {RequiredError}
|
|
42583
|
+
* @memberof VendorConnectorMappingsApi
|
|
42584
|
+
*/
|
|
42585
|
+
deleteVendorConnectorMapping(requestParameters: VendorConnectorMappingsApiDeleteVendorConnectorMappingRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DeleteVendorConnectorMapping200Response, any>>;
|
|
42586
|
+
}
|
|
41024
42587
|
/**
|
|
41025
42588
|
* WorkItemsApi - axios parameter creator
|
|
41026
42589
|
* @export
|
|
@@ -41122,6 +42685,15 @@ export declare const WorkItemsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
41122
42685
|
* @throws {RequiredError}
|
|
41123
42686
|
*/
|
|
41124
42687
|
rejectApprovalItemsInBulk: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
42688
|
+
/**
|
|
42689
|
+
* This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
|
42690
|
+
* @summary Forward a Work Item
|
|
42691
|
+
* @param {string} id The ID of the work item
|
|
42692
|
+
* @param {WorkItemForward} workItemForward
|
|
42693
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42694
|
+
* @throws {RequiredError}
|
|
42695
|
+
*/
|
|
42696
|
+
sendWorkItemForward: (id: string, workItemForward: WorkItemForward, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41125
42697
|
/**
|
|
41126
42698
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
41127
42699
|
* @summary Submit Account Selections
|
|
@@ -41235,6 +42807,15 @@ export declare const WorkItemsApiFp: (configuration?: Configuration) => {
|
|
|
41235
42807
|
* @throws {RequiredError}
|
|
41236
42808
|
*/
|
|
41237
42809
|
rejectApprovalItemsInBulk(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<WorkItems>>;
|
|
42810
|
+
/**
|
|
42811
|
+
* This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
|
42812
|
+
* @summary Forward a Work Item
|
|
42813
|
+
* @param {string} id The ID of the work item
|
|
42814
|
+
* @param {WorkItemForward} workItemForward
|
|
42815
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42816
|
+
* @throws {RequiredError}
|
|
42817
|
+
*/
|
|
42818
|
+
sendWorkItemForward(id: string, workItemForward: WorkItemForward, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
41238
42819
|
/**
|
|
41239
42820
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
41240
42821
|
* @summary Submit Account Selections
|
|
@@ -41348,6 +42929,15 @@ export declare const WorkItemsApiFactory: (configuration?: Configuration, basePa
|
|
|
41348
42929
|
* @throws {RequiredError}
|
|
41349
42930
|
*/
|
|
41350
42931
|
rejectApprovalItemsInBulk(id: string, axiosOptions?: any): AxiosPromise<WorkItems>;
|
|
42932
|
+
/**
|
|
42933
|
+
* This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
|
42934
|
+
* @summary Forward a Work Item
|
|
42935
|
+
* @param {string} id The ID of the work item
|
|
42936
|
+
* @param {WorkItemForward} workItemForward
|
|
42937
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
42938
|
+
* @throws {RequiredError}
|
|
42939
|
+
*/
|
|
42940
|
+
sendWorkItemForward(id: string, workItemForward: WorkItemForward, axiosOptions?: any): AxiosPromise<void>;
|
|
41351
42941
|
/**
|
|
41352
42942
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
41353
42943
|
* @summary Submit Account Selections
|
|
@@ -41551,6 +43141,25 @@ export interface WorkItemsApiRejectApprovalItemsInBulkRequest {
|
|
|
41551
43141
|
*/
|
|
41552
43142
|
readonly id: string;
|
|
41553
43143
|
}
|
|
43144
|
+
/**
|
|
43145
|
+
* Request parameters for sendWorkItemForward operation in WorkItemsApi.
|
|
43146
|
+
* @export
|
|
43147
|
+
* @interface WorkItemsApiSendWorkItemForwardRequest
|
|
43148
|
+
*/
|
|
43149
|
+
export interface WorkItemsApiSendWorkItemForwardRequest {
|
|
43150
|
+
/**
|
|
43151
|
+
* The ID of the work item
|
|
43152
|
+
* @type {string}
|
|
43153
|
+
* @memberof WorkItemsApiSendWorkItemForward
|
|
43154
|
+
*/
|
|
43155
|
+
readonly id: string;
|
|
43156
|
+
/**
|
|
43157
|
+
*
|
|
43158
|
+
* @type {WorkItemForward}
|
|
43159
|
+
* @memberof WorkItemsApiSendWorkItemForward
|
|
43160
|
+
*/
|
|
43161
|
+
readonly workItemForward: WorkItemForward;
|
|
43162
|
+
}
|
|
41554
43163
|
/**
|
|
41555
43164
|
* Request parameters for submitAccountSelection operation in WorkItemsApi.
|
|
41556
43165
|
* @export
|
|
@@ -41678,6 +43287,15 @@ export declare class WorkItemsApi extends BaseAPI {
|
|
|
41678
43287
|
* @memberof WorkItemsApi
|
|
41679
43288
|
*/
|
|
41680
43289
|
rejectApprovalItemsInBulk(requestParameters: WorkItemsApiRejectApprovalItemsInBulkRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<WorkItems, any>>;
|
|
43290
|
+
/**
|
|
43291
|
+
* This API forwards a work item to a new owner. Either an admin, or the owning/current user must make this request. Accessible to work-item Owner, ORG_ADMIN, REPORT_ADMIN, ROLE_ADMIN, ROLE_SUBADMIN, SOURCE_ADMIN, SOURCE_SUBADMIN.
|
|
43292
|
+
* @summary Forward a Work Item
|
|
43293
|
+
* @param {WorkItemsApiSendWorkItemForwardRequest} requestParameters Request parameters.
|
|
43294
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
43295
|
+
* @throws {RequiredError}
|
|
43296
|
+
* @memberof WorkItemsApi
|
|
43297
|
+
*/
|
|
43298
|
+
sendWorkItemForward(requestParameters: WorkItemsApiSendWorkItemForwardRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
41681
43299
|
/**
|
|
41682
43300
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
41683
43301
|
* @summary Submit Account Selections
|