sailpoint-api-client 1.3.5 → 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 +1250 -1143
- package/beta/common.ts +9 -2
- package/beta/package.json +1 -1
- package/configuration.ts +1 -0
- package/dist/beta/api.d.ts +637 -566
- package/dist/beta/api.js +1160 -1132
- 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 +2490 -249
- package/dist/v3/api.js +3029 -833
- 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 +4264 -1007
- 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;
|
|
2068
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;
|
|
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,71 @@ 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
|
+
}
|
|
4260
|
+
/**
|
|
4261
|
+
*
|
|
4262
|
+
* @export
|
|
4263
|
+
* @interface BulkTaggedObjectResponse
|
|
4264
|
+
*/
|
|
4265
|
+
export interface BulkTaggedObjectResponse {
|
|
4266
|
+
/**
|
|
4267
|
+
*
|
|
4268
|
+
* @type {Array<TaggedObjectDto>}
|
|
4269
|
+
* @memberof BulkTaggedObjectResponse
|
|
4270
|
+
*/
|
|
4271
|
+
'objectRefs'?: Array<TaggedObjectDto>;
|
|
4272
|
+
/**
|
|
4273
|
+
* Label to be applied to an Object
|
|
4274
|
+
* @type {Array<string>}
|
|
4275
|
+
* @memberof BulkTaggedObjectResponse
|
|
4276
|
+
*/
|
|
4277
|
+
'tags'?: Array<string>;
|
|
4278
|
+
}
|
|
4058
4279
|
/**
|
|
4059
4280
|
*
|
|
4060
4281
|
* @export
|
|
@@ -4562,31 +4783,25 @@ export type CampaignCompleteOptionsAutoCompleteActionEnum = typeof CampaignCompl
|
|
|
4562
4783
|
*/
|
|
4563
4784
|
export interface CampaignFilterDetails {
|
|
4564
4785
|
/**
|
|
4565
|
-
*
|
|
4566
|
-
* @type {string}
|
|
4567
|
-
* @memberof CampaignFilterDetails
|
|
4568
|
-
*/
|
|
4569
|
-
'id'?: string;
|
|
4570
|
-
/**
|
|
4571
|
-
* This is campaign filter\'s name.
|
|
4786
|
+
* Campaign filter name.
|
|
4572
4787
|
* @type {string}
|
|
4573
4788
|
* @memberof CampaignFilterDetails
|
|
4574
4789
|
*/
|
|
4575
4790
|
'name': string;
|
|
4576
4791
|
/**
|
|
4577
|
-
*
|
|
4792
|
+
* Campaign filter description.
|
|
4578
4793
|
* @type {string}
|
|
4579
4794
|
* @memberof CampaignFilterDetails
|
|
4580
4795
|
*/
|
|
4581
|
-
'description'
|
|
4796
|
+
'description'?: string;
|
|
4582
4797
|
/**
|
|
4583
|
-
*
|
|
4798
|
+
* Owner of the filter. This field automatically populates at creation time with the current user.
|
|
4584
4799
|
* @type {string}
|
|
4585
4800
|
* @memberof CampaignFilterDetails
|
|
4586
4801
|
*/
|
|
4587
4802
|
'owner': string | null;
|
|
4588
4803
|
/**
|
|
4589
|
-
*
|
|
4804
|
+
* Mode/type of filter, either the INCLUSION or EXCLUSION type. The INCLUSION type includes the data in generated campaigns as per specified in the criteria, whereas the EXCLUSION type excludes the data in generated campaigns as per specified in criteria.
|
|
4590
4805
|
* @type {object}
|
|
4591
4806
|
* @memberof CampaignFilterDetails
|
|
4592
4807
|
*/
|
|
@@ -4622,13 +4837,13 @@ export interface CampaignFilterDetailsCriteriaListInner {
|
|
|
4622
4837
|
*/
|
|
4623
4838
|
'operation': Operation & object;
|
|
4624
4839
|
/**
|
|
4625
|
-
*
|
|
4840
|
+
* Specified key from the type of criteria.
|
|
4626
4841
|
* @type {string}
|
|
4627
4842
|
* @memberof CampaignFilterDetailsCriteriaListInner
|
|
4628
4843
|
*/
|
|
4629
4844
|
'property': string | null;
|
|
4630
4845
|
/**
|
|
4631
|
-
*
|
|
4846
|
+
* Value for the specified key from the type of criteria.
|
|
4632
4847
|
* @type {string}
|
|
4633
4848
|
* @memberof CampaignFilterDetailsCriteriaListInner
|
|
4634
4849
|
*/
|
|
@@ -5421,11 +5636,11 @@ export interface CompletedApproval {
|
|
|
5421
5636
|
*/
|
|
5422
5637
|
'requester'?: AccessItemRequester;
|
|
5423
5638
|
/**
|
|
5424
|
-
*
|
|
5425
|
-
* @type {
|
|
5639
|
+
*
|
|
5640
|
+
* @type {RequestedItemStatusRequestedFor}
|
|
5426
5641
|
* @memberof CompletedApproval
|
|
5427
5642
|
*/
|
|
5428
|
-
'requestedFor'?:
|
|
5643
|
+
'requestedFor'?: RequestedItemStatusRequestedFor;
|
|
5429
5644
|
/**
|
|
5430
5645
|
*
|
|
5431
5646
|
* @type {AccessItemReviewedBy}
|
|
@@ -5503,7 +5718,7 @@ export interface CompletedApproval {
|
|
|
5503
5718
|
* @type {SodViolationContextCheckCompleted}
|
|
5504
5719
|
* @memberof CompletedApproval
|
|
5505
5720
|
*/
|
|
5506
|
-
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
5721
|
+
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
5507
5722
|
/**
|
|
5508
5723
|
*
|
|
5509
5724
|
* @type {CompletedApprovalPreApprovalTriggerResult}
|
|
@@ -5518,12 +5733,6 @@ export interface CompletedApproval {
|
|
|
5518
5733
|
'clientMetadata'?: {
|
|
5519
5734
|
[key: string]: string;
|
|
5520
5735
|
};
|
|
5521
|
-
/**
|
|
5522
|
-
* Information about the requested accounts
|
|
5523
|
-
* @type {string}
|
|
5524
|
-
* @memberof CompletedApproval
|
|
5525
|
-
*/
|
|
5526
|
-
'requestedAccounts'?: string | null;
|
|
5527
5736
|
}
|
|
5528
5737
|
/**
|
|
5529
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.
|
|
@@ -6626,6 +6835,68 @@ export declare const DeleteSource202ResponseTypeEnum: {
|
|
|
6626
6835
|
readonly TaskResult: "TASK_RESULT";
|
|
6627
6836
|
};
|
|
6628
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
|
+
}
|
|
6629
6900
|
/**
|
|
6630
6901
|
*
|
|
6631
6902
|
* @export
|
|
@@ -7727,6 +7998,12 @@ export interface EventAttributes {
|
|
|
7727
7998
|
* @memberof EventAttributes
|
|
7728
7999
|
*/
|
|
7729
8000
|
'filter.$'?: string;
|
|
8001
|
+
/**
|
|
8002
|
+
* Description of the event trigger
|
|
8003
|
+
* @type {string}
|
|
8004
|
+
* @memberof EventAttributes
|
|
8005
|
+
*/
|
|
8006
|
+
'description'?: string;
|
|
7730
8007
|
}
|
|
7731
8008
|
/**
|
|
7732
8009
|
* Event
|
|
@@ -8075,14 +8352,50 @@ export interface ExternalAttributes {
|
|
|
8075
8352
|
* @type {string}
|
|
8076
8353
|
* @memberof ExternalAttributes
|
|
8077
8354
|
*/
|
|
8078
|
-
'name'
|
|
8355
|
+
'name'?: string;
|
|
8079
8356
|
/**
|
|
8080
8357
|
* Additonal context about the external trigger
|
|
8081
8358
|
* @type {string}
|
|
8082
8359
|
* @memberof ExternalAttributes
|
|
8083
8360
|
*/
|
|
8084
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;
|
|
8085
8374
|
}
|
|
8375
|
+
/**
|
|
8376
|
+
*
|
|
8377
|
+
* @export
|
|
8378
|
+
* @interface FederationProtocolDetails
|
|
8379
|
+
*/
|
|
8380
|
+
export interface FederationProtocolDetails {
|
|
8381
|
+
/**
|
|
8382
|
+
* Federation protocol role
|
|
8383
|
+
* @type {string}
|
|
8384
|
+
* @memberof FederationProtocolDetails
|
|
8385
|
+
*/
|
|
8386
|
+
'role'?: FederationProtocolDetailsRoleEnum;
|
|
8387
|
+
/**
|
|
8388
|
+
* An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP).
|
|
8389
|
+
* @type {string}
|
|
8390
|
+
* @memberof FederationProtocolDetails
|
|
8391
|
+
*/
|
|
8392
|
+
'entityId'?: string;
|
|
8393
|
+
}
|
|
8394
|
+
export declare const FederationProtocolDetailsRoleEnum: {
|
|
8395
|
+
readonly Idp: "SAML_IDP";
|
|
8396
|
+
readonly Sp: "SAML_SP";
|
|
8397
|
+
};
|
|
8398
|
+
export type FederationProtocolDetailsRoleEnum = typeof FederationProtocolDetailsRoleEnum[keyof typeof FederationProtocolDetailsRoleEnum];
|
|
8086
8399
|
/**
|
|
8087
8400
|
*
|
|
8088
8401
|
* @export
|
|
@@ -8342,25 +8655,6 @@ export interface GenerateRandomString {
|
|
|
8342
8655
|
*/
|
|
8343
8656
|
'requiresPeriodicRefresh'?: boolean;
|
|
8344
8657
|
}
|
|
8345
|
-
/**
|
|
8346
|
-
*
|
|
8347
|
-
* @export
|
|
8348
|
-
* @interface GenericRule
|
|
8349
|
-
*/
|
|
8350
|
-
export interface GenericRule {
|
|
8351
|
-
/**
|
|
8352
|
-
* This is the name of the Generic rule that needs to be invoked by the transform
|
|
8353
|
-
* @type {string}
|
|
8354
|
-
* @memberof GenericRule
|
|
8355
|
-
*/
|
|
8356
|
-
'name': string;
|
|
8357
|
-
/**
|
|
8358
|
-
* A value that indicates whether the transform logic should be re-evaluated every evening as part of the identity refresh process
|
|
8359
|
-
* @type {boolean}
|
|
8360
|
-
* @memberof GenericRule
|
|
8361
|
-
*/
|
|
8362
|
-
'requiresPeriodicRefresh'?: boolean;
|
|
8363
|
-
}
|
|
8364
8658
|
/**
|
|
8365
8659
|
* @type GetActiveCampaigns200ResponseInner
|
|
8366
8660
|
* @export
|
|
@@ -8474,6 +8768,18 @@ export interface GetOAuthClientResponse {
|
|
|
8474
8768
|
* @memberof GetOAuthClientResponse
|
|
8475
8769
|
*/
|
|
8476
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;
|
|
8477
8783
|
/**
|
|
8478
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.
|
|
8479
8785
|
* @type {string}
|
|
@@ -8567,6 +8873,31 @@ export interface GetReferenceIdentityAttribute {
|
|
|
8567
8873
|
*/
|
|
8568
8874
|
'requiresPeriodicRefresh'?: boolean;
|
|
8569
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
|
+
}
|
|
8570
8901
|
/**
|
|
8571
8902
|
* OAuth2 Grant Type
|
|
8572
8903
|
* @export
|
|
@@ -8707,6 +9038,37 @@ export interface IdentityAttributeConfig {
|
|
|
8707
9038
|
*/
|
|
8708
9039
|
'attributeTransforms'?: Array<IdentityAttributeTransform>;
|
|
8709
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
|
+
}
|
|
8710
9072
|
/**
|
|
8711
9073
|
* Defines a transformation definition for an identity attribute.
|
|
8712
9074
|
* @export
|
|
@@ -9428,6 +9790,73 @@ export interface IdentityExceptionReportReference {
|
|
|
9428
9790
|
*/
|
|
9429
9791
|
'reportName'?: string;
|
|
9430
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];
|
|
9431
9860
|
/**
|
|
9432
9861
|
*
|
|
9433
9862
|
* @export
|
|
@@ -9913,6 +10342,190 @@ export declare const IdentityWithNewAccessAccessRefsInnerTypeEnum: {
|
|
|
9913
10342
|
readonly Entitlement: "ENTITLEMENT";
|
|
9914
10343
|
};
|
|
9915
10344
|
export type IdentityWithNewAccessAccessRefsInnerTypeEnum = typeof IdentityWithNewAccessAccessRefsInnerTypeEnum[keyof typeof IdentityWithNewAccessAccessRefsInnerTypeEnum];
|
|
10345
|
+
/**
|
|
10346
|
+
*
|
|
10347
|
+
* @export
|
|
10348
|
+
* @interface IdpDetails
|
|
10349
|
+
*/
|
|
10350
|
+
export interface IdpDetails {
|
|
10351
|
+
/**
|
|
10352
|
+
* Federation protocol role
|
|
10353
|
+
* @type {string}
|
|
10354
|
+
* @memberof IdpDetails
|
|
10355
|
+
*/
|
|
10356
|
+
'role'?: IdpDetailsRoleEnum;
|
|
10357
|
+
/**
|
|
10358
|
+
* An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP).
|
|
10359
|
+
* @type {string}
|
|
10360
|
+
* @memberof IdpDetails
|
|
10361
|
+
*/
|
|
10362
|
+
'entityId'?: string;
|
|
10363
|
+
/**
|
|
10364
|
+
* Defines the binding used for the SAML flow. Used with IDP configurations.
|
|
10365
|
+
* @type {string}
|
|
10366
|
+
* @memberof IdpDetails
|
|
10367
|
+
*/
|
|
10368
|
+
'binding'?: string;
|
|
10369
|
+
/**
|
|
10370
|
+
* Specifies the SAML authentication method to use. Used with IDP configurations.
|
|
10371
|
+
* @type {string}
|
|
10372
|
+
* @memberof IdpDetails
|
|
10373
|
+
*/
|
|
10374
|
+
'authContext'?: string;
|
|
10375
|
+
/**
|
|
10376
|
+
* The IDP logout URL. Used with IDP configurations.
|
|
10377
|
+
* @type {string}
|
|
10378
|
+
* @memberof IdpDetails
|
|
10379
|
+
*/
|
|
10380
|
+
'logoutUrl'?: string;
|
|
10381
|
+
/**
|
|
10382
|
+
* Determines if the configured AuthnContext should be used or the default. Used with IDP configurations.
|
|
10383
|
+
* @type {boolean}
|
|
10384
|
+
* @memberof IdpDetails
|
|
10385
|
+
*/
|
|
10386
|
+
'includeAuthContext'?: boolean;
|
|
10387
|
+
/**
|
|
10388
|
+
* The name id format to use. Used with IDP configurations.
|
|
10389
|
+
* @type {string}
|
|
10390
|
+
* @memberof IdpDetails
|
|
10391
|
+
*/
|
|
10392
|
+
'nameId'?: string;
|
|
10393
|
+
/**
|
|
10394
|
+
*
|
|
10395
|
+
* @type {JITConfiguration}
|
|
10396
|
+
* @memberof IdpDetails
|
|
10397
|
+
*/
|
|
10398
|
+
'jitConfiguration'?: JITConfiguration;
|
|
10399
|
+
/**
|
|
10400
|
+
* The Base64-encoded certificate used by the IDP. Used with IDP configurations.
|
|
10401
|
+
* @type {string}
|
|
10402
|
+
* @memberof IdpDetails
|
|
10403
|
+
*/
|
|
10404
|
+
'cert'?: string;
|
|
10405
|
+
/**
|
|
10406
|
+
* The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations.
|
|
10407
|
+
* @type {string}
|
|
10408
|
+
* @memberof IdpDetails
|
|
10409
|
+
*/
|
|
10410
|
+
'loginUrlPost'?: string;
|
|
10411
|
+
/**
|
|
10412
|
+
* The IDP Redirect URL. Used with IDP configurations.
|
|
10413
|
+
* @type {string}
|
|
10414
|
+
* @memberof IdpDetails
|
|
10415
|
+
*/
|
|
10416
|
+
'loginUrlRedirect'?: string;
|
|
10417
|
+
/**
|
|
10418
|
+
* Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations.
|
|
10419
|
+
* @type {string}
|
|
10420
|
+
* @memberof IdpDetails
|
|
10421
|
+
*/
|
|
10422
|
+
'mappingAttribute'?: string;
|
|
10423
|
+
/**
|
|
10424
|
+
* The expiration date extracted from the certificate.
|
|
10425
|
+
* @type {string}
|
|
10426
|
+
* @memberof IdpDetails
|
|
10427
|
+
*/
|
|
10428
|
+
'certificateExpirationDate'?: string;
|
|
10429
|
+
/**
|
|
10430
|
+
* The name extracted from the certificate.
|
|
10431
|
+
* @type {string}
|
|
10432
|
+
* @memberof IdpDetails
|
|
10433
|
+
*/
|
|
10434
|
+
'certificateName'?: string;
|
|
10435
|
+
}
|
|
10436
|
+
export declare const IdpDetailsRoleEnum: {
|
|
10437
|
+
readonly SamlIdp: "SAML_IDP";
|
|
10438
|
+
};
|
|
10439
|
+
export type IdpDetailsRoleEnum = typeof IdpDetailsRoleEnum[keyof typeof IdpDetailsRoleEnum];
|
|
10440
|
+
/**
|
|
10441
|
+
* Specification of Identity Provider Details section of Service Provider Config
|
|
10442
|
+
* @export
|
|
10443
|
+
* @interface IdpDetailsAllOf
|
|
10444
|
+
*/
|
|
10445
|
+
export interface IdpDetailsAllOf {
|
|
10446
|
+
/**
|
|
10447
|
+
* Defines the binding used for the SAML flow. Used with IDP configurations.
|
|
10448
|
+
* @type {string}
|
|
10449
|
+
* @memberof IdpDetailsAllOf
|
|
10450
|
+
*/
|
|
10451
|
+
'binding'?: string;
|
|
10452
|
+
/**
|
|
10453
|
+
* Specifies the SAML authentication method to use. Used with IDP configurations.
|
|
10454
|
+
* @type {string}
|
|
10455
|
+
* @memberof IdpDetailsAllOf
|
|
10456
|
+
*/
|
|
10457
|
+
'authContext'?: string;
|
|
10458
|
+
/**
|
|
10459
|
+
* The IDP logout URL. Used with IDP configurations.
|
|
10460
|
+
* @type {string}
|
|
10461
|
+
* @memberof IdpDetailsAllOf
|
|
10462
|
+
*/
|
|
10463
|
+
'logoutUrl'?: string;
|
|
10464
|
+
/**
|
|
10465
|
+
* Determines if the configured AuthnContext should be used or the default. Used with IDP configurations.
|
|
10466
|
+
* @type {boolean}
|
|
10467
|
+
* @memberof IdpDetailsAllOf
|
|
10468
|
+
*/
|
|
10469
|
+
'includeAuthContext'?: boolean;
|
|
10470
|
+
/**
|
|
10471
|
+
* The name id format to use. Used with IDP configurations.
|
|
10472
|
+
* @type {string}
|
|
10473
|
+
* @memberof IdpDetailsAllOf
|
|
10474
|
+
*/
|
|
10475
|
+
'nameId'?: string;
|
|
10476
|
+
/**
|
|
10477
|
+
*
|
|
10478
|
+
* @type {JITConfiguration}
|
|
10479
|
+
* @memberof IdpDetailsAllOf
|
|
10480
|
+
*/
|
|
10481
|
+
'jitConfiguration'?: JITConfiguration;
|
|
10482
|
+
/**
|
|
10483
|
+
* The Base64-encoded certificate used by the IDP. Used with IDP configurations.
|
|
10484
|
+
* @type {string}
|
|
10485
|
+
* @memberof IdpDetailsAllOf
|
|
10486
|
+
*/
|
|
10487
|
+
'cert'?: string;
|
|
10488
|
+
/**
|
|
10489
|
+
* The IDP POST URL, used with IDP HTTP-POST bindings for IDP-initiated logins. Used with IDP configurations.
|
|
10490
|
+
* @type {string}
|
|
10491
|
+
* @memberof IdpDetailsAllOf
|
|
10492
|
+
*/
|
|
10493
|
+
'loginUrlPost'?: string;
|
|
10494
|
+
/**
|
|
10495
|
+
* The IDP Redirect URL. Used with IDP configurations.
|
|
10496
|
+
* @type {string}
|
|
10497
|
+
* @memberof IdpDetailsAllOf
|
|
10498
|
+
*/
|
|
10499
|
+
'loginUrlRedirect'?: string;
|
|
10500
|
+
/**
|
|
10501
|
+
* Return the saml Id for the given user, based on the IDN as SP settings of the org. Used with IDP configurations.
|
|
10502
|
+
* @type {string}
|
|
10503
|
+
* @memberof IdpDetailsAllOf
|
|
10504
|
+
*/
|
|
10505
|
+
'mappingAttribute'?: string;
|
|
10506
|
+
/**
|
|
10507
|
+
* Federation protocol role
|
|
10508
|
+
* @type {string}
|
|
10509
|
+
* @memberof IdpDetailsAllOf
|
|
10510
|
+
*/
|
|
10511
|
+
'role'?: IdpDetailsAllOfRoleEnum;
|
|
10512
|
+
/**
|
|
10513
|
+
* The expiration date extracted from the certificate.
|
|
10514
|
+
* @type {string}
|
|
10515
|
+
* @memberof IdpDetailsAllOf
|
|
10516
|
+
*/
|
|
10517
|
+
'certificateExpirationDate'?: string;
|
|
10518
|
+
/**
|
|
10519
|
+
* The name extracted from the certificate.
|
|
10520
|
+
* @type {string}
|
|
10521
|
+
* @memberof IdpDetailsAllOf
|
|
10522
|
+
*/
|
|
10523
|
+
'certificateName'?: string;
|
|
10524
|
+
}
|
|
10525
|
+
export declare const IdpDetailsAllOfRoleEnum: {
|
|
10526
|
+
readonly SamlIdp: "SAML_IDP";
|
|
10527
|
+
};
|
|
10528
|
+
export type IdpDetailsAllOfRoleEnum = typeof IdpDetailsAllOfRoleEnum[keyof typeof IdpDetailsAllOfRoleEnum];
|
|
9916
10529
|
/**
|
|
9917
10530
|
*
|
|
9918
10531
|
* @export
|
|
@@ -10040,6 +10653,33 @@ export interface InnerHit {
|
|
|
10040
10653
|
*/
|
|
10041
10654
|
'type': string;
|
|
10042
10655
|
}
|
|
10656
|
+
/**
|
|
10657
|
+
*
|
|
10658
|
+
* @export
|
|
10659
|
+
* @interface JITConfiguration
|
|
10660
|
+
*/
|
|
10661
|
+
export interface JITConfiguration {
|
|
10662
|
+
/**
|
|
10663
|
+
* The indicator for just-in-time provisioning enabled
|
|
10664
|
+
* @type {boolean}
|
|
10665
|
+
* @memberof JITConfiguration
|
|
10666
|
+
*/
|
|
10667
|
+
'enabled'?: boolean;
|
|
10668
|
+
/**
|
|
10669
|
+
* the sourceId that mapped to just-in-time provisioning configuration
|
|
10670
|
+
* @type {string}
|
|
10671
|
+
* @memberof JITConfiguration
|
|
10672
|
+
*/
|
|
10673
|
+
'sourceId'?: string;
|
|
10674
|
+
/**
|
|
10675
|
+
* A mapping of identity profile attribute names to SAML assertion attribute names
|
|
10676
|
+
* @type {{ [key: string]: string; }}
|
|
10677
|
+
* @memberof JITConfiguration
|
|
10678
|
+
*/
|
|
10679
|
+
'sourceAttributeMappings'?: {
|
|
10680
|
+
[key: string]: string;
|
|
10681
|
+
};
|
|
10682
|
+
}
|
|
10043
10683
|
/**
|
|
10044
10684
|
* A JSONPatch Operation as defined by [RFC 6902 - JSON Patch](https://tools.ietf.org/html/rfc6902)
|
|
10045
10685
|
* @export
|
|
@@ -10430,13 +11070,13 @@ export interface ListAccessProfiles429Response {
|
|
|
10430
11070
|
*/
|
|
10431
11071
|
export interface ListCampaignFilters200Response {
|
|
10432
11072
|
/**
|
|
10433
|
-
*
|
|
11073
|
+
* List of campaign filters.
|
|
10434
11074
|
* @type {Array<CampaignFilterDetails>}
|
|
10435
11075
|
* @memberof ListCampaignFilters200Response
|
|
10436
11076
|
*/
|
|
10437
11077
|
'items'?: Array<CampaignFilterDetails>;
|
|
10438
11078
|
/**
|
|
10439
|
-
*
|
|
11079
|
+
* Number of filters returned.
|
|
10440
11080
|
* @type {number}
|
|
10441
11081
|
* @memberof ListCampaignFilters200Response
|
|
10442
11082
|
*/
|
|
@@ -10477,7 +11117,37 @@ export interface ListCompleteWorkflowLibrary200ResponseInner {
|
|
|
10477
11117
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
10478
11118
|
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
10479
11119
|
*/
|
|
10480
|
-
'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;
|
|
10481
11151
|
/**
|
|
10482
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.
|
|
10483
11153
|
* @type {boolean}
|
|
@@ -10485,7 +11155,7 @@ export interface ListCompleteWorkflowLibrary200ResponseInner {
|
|
|
10485
11155
|
*/
|
|
10486
11156
|
'isDynamicSchema'?: boolean;
|
|
10487
11157
|
/**
|
|
10488
|
-
*
|
|
11158
|
+
* Example output schema
|
|
10489
11159
|
* @type {object}
|
|
10490
11160
|
* @memberof ListCompleteWorkflowLibrary200ResponseInner
|
|
10491
11161
|
*/
|
|
@@ -10508,6 +11178,31 @@ export declare const LocaleOrigin: {
|
|
|
10508
11178
|
readonly Null: "null";
|
|
10509
11179
|
};
|
|
10510
11180
|
export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
|
|
11181
|
+
/**
|
|
11182
|
+
*
|
|
11183
|
+
* @export
|
|
11184
|
+
* @interface LockoutConfiguration
|
|
11185
|
+
*/
|
|
11186
|
+
export interface LockoutConfiguration {
|
|
11187
|
+
/**
|
|
11188
|
+
* The maximum attempts allowed before lockout occurs.
|
|
11189
|
+
* @type {number}
|
|
11190
|
+
* @memberof LockoutConfiguration
|
|
11191
|
+
*/
|
|
11192
|
+
'maximumAttempts'?: number;
|
|
11193
|
+
/**
|
|
11194
|
+
* The total time in minutes a user will be locked out.
|
|
11195
|
+
* @type {number}
|
|
11196
|
+
* @memberof LockoutConfiguration
|
|
11197
|
+
*/
|
|
11198
|
+
'lockoutDuration'?: number;
|
|
11199
|
+
/**
|
|
11200
|
+
* A rolling window where authentication attempts in a series count towards the maximum before lockout occurs.
|
|
11201
|
+
* @type {number}
|
|
11202
|
+
* @memberof LockoutConfiguration
|
|
11203
|
+
*/
|
|
11204
|
+
'lockoutWindow'?: number;
|
|
11205
|
+
}
|
|
10511
11206
|
/**
|
|
10512
11207
|
*
|
|
10513
11208
|
* @export
|
|
@@ -10576,6 +11271,18 @@ export interface ManagedClient {
|
|
|
10576
11271
|
* @memberof ManagedClient
|
|
10577
11272
|
*/
|
|
10578
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;
|
|
10579
11286
|
/**
|
|
10580
11287
|
* Previous CC ID to be used in data migration. (This field will be deleted after CC migration!)
|
|
10581
11288
|
* @type {number}
|
|
@@ -11100,6 +11807,38 @@ export interface ManagerCorrelationMapping {
|
|
|
11100
11807
|
*/
|
|
11101
11808
|
'identityAttributeName'?: string;
|
|
11102
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
|
+
}
|
|
11103
11842
|
/**
|
|
11104
11843
|
*
|
|
11105
11844
|
* @export
|
|
@@ -14000,7 +14739,7 @@ export interface PendingApproval {
|
|
|
14000
14739
|
* @type {SodViolationContextCheckCompleted}
|
|
14001
14740
|
* @memberof PendingApproval
|
|
14002
14741
|
*/
|
|
14003
|
-
'sodViolationContext'?: SodViolationContextCheckCompleted;
|
|
14742
|
+
'sodViolationContext'?: SodViolationContextCheckCompleted | null;
|
|
14004
14743
|
}
|
|
14005
14744
|
/**
|
|
14006
14745
|
* Enum represents action that is being processed on an approval.
|
|
@@ -16899,7 +17638,7 @@ export interface RoleSummaryAllOf {
|
|
|
16899
17638
|
* @type Rule
|
|
16900
17639
|
* @export
|
|
16901
17640
|
*/
|
|
16902
|
-
export type Rule = GenerateRandomString |
|
|
17641
|
+
export type Rule = GenerateRandomString | GetReferenceIdentityAttribute | TransformRule;
|
|
16903
17642
|
/**
|
|
16904
17643
|
*
|
|
16905
17644
|
* @export
|
|
@@ -17429,8 +18168,40 @@ export interface ScheduledAttributes {
|
|
|
17429
18168
|
* @type {string}
|
|
17430
18169
|
* @memberof ScheduledAttributes
|
|
17431
18170
|
*/
|
|
17432
|
-
'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>;
|
|
17433
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];
|
|
17434
18205
|
/**
|
|
17435
18206
|
*
|
|
17436
18207
|
* @export
|
|
@@ -17897,6 +18668,31 @@ export interface SearchArgumentsOwner {
|
|
|
17897
18668
|
*/
|
|
17898
18669
|
'id': string;
|
|
17899
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
|
+
}
|
|
17900
18696
|
/**
|
|
17901
18697
|
* @type SearchDocument
|
|
17902
18698
|
* @export
|
|
@@ -18543,6 +19339,67 @@ export declare const ServiceDeskSourceTypeEnum: {
|
|
|
18543
19339
|
readonly Source: "SOURCE";
|
|
18544
19340
|
};
|
|
18545
19341
|
export type ServiceDeskSourceTypeEnum = typeof ServiceDeskSourceTypeEnum[keyof typeof ServiceDeskSourceTypeEnum];
|
|
19342
|
+
/**
|
|
19343
|
+
* Represents the IdentityNow as Service Provider Configuration allowing customers to log into IDN via an Identity Provider
|
|
19344
|
+
* @export
|
|
19345
|
+
* @interface ServiceProviderConfiguration
|
|
19346
|
+
*/
|
|
19347
|
+
export interface ServiceProviderConfiguration {
|
|
19348
|
+
/**
|
|
19349
|
+
* This determines whether or not the SAML authentication flow is enabled for an org
|
|
19350
|
+
* @type {boolean}
|
|
19351
|
+
* @memberof ServiceProviderConfiguration
|
|
19352
|
+
*/
|
|
19353
|
+
'enabled'?: boolean;
|
|
19354
|
+
/**
|
|
19355
|
+
* This allows basic login with the parameter prompt=true. This is often toggled on when debugging SAML authentication setup. When false, only org admins with MFA-enabled can bypass the IDP.
|
|
19356
|
+
* @type {boolean}
|
|
19357
|
+
* @memberof ServiceProviderConfiguration
|
|
19358
|
+
*/
|
|
19359
|
+
'bypassIdp'?: boolean;
|
|
19360
|
+
/**
|
|
19361
|
+
* This indicates whether or not the SAML configuration is valid.
|
|
19362
|
+
* @type {boolean}
|
|
19363
|
+
* @memberof ServiceProviderConfiguration
|
|
19364
|
+
*/
|
|
19365
|
+
'samlConfigurationValid'?: boolean;
|
|
19366
|
+
/**
|
|
19367
|
+
* A list of the abstract implementations of the Federation Protocol details. Typically, this will include on SpDetails object and one IdpDetails object used in tandem to define a SAML integration between a customer\'s identity provider and a customer\'s SailPoint instance (i.e., the service provider).
|
|
19368
|
+
* @type {Array<ServiceProviderConfigurationFederationProtocolDetailsInner>}
|
|
19369
|
+
* @memberof ServiceProviderConfiguration
|
|
19370
|
+
*/
|
|
19371
|
+
'federationProtocolDetails'?: Array<ServiceProviderConfigurationFederationProtocolDetailsInner>;
|
|
19372
|
+
}
|
|
19373
|
+
/**
|
|
19374
|
+
* @type ServiceProviderConfigurationFederationProtocolDetailsInner
|
|
19375
|
+
* @export
|
|
19376
|
+
*/
|
|
19377
|
+
export type ServiceProviderConfigurationFederationProtocolDetailsInner = IdpDetails | SpDetails;
|
|
19378
|
+
/**
|
|
19379
|
+
*
|
|
19380
|
+
* @export
|
|
19381
|
+
* @interface SessionConfiguration
|
|
19382
|
+
*/
|
|
19383
|
+
export interface SessionConfiguration {
|
|
19384
|
+
/**
|
|
19385
|
+
* The maximum time in minutes a session can be idle.
|
|
19386
|
+
* @type {number}
|
|
19387
|
+
* @memberof SessionConfiguration
|
|
19388
|
+
*/
|
|
19389
|
+
'maxIdleTime'?: number;
|
|
19390
|
+
/**
|
|
19391
|
+
* Denotes if \'remember me\' is enabled.
|
|
19392
|
+
* @type {boolean}
|
|
19393
|
+
* @memberof SessionConfiguration
|
|
19394
|
+
*/
|
|
19395
|
+
'rememberMe'?: boolean;
|
|
19396
|
+
/**
|
|
19397
|
+
* The maximum allowable session time in minutes.
|
|
19398
|
+
* @type {number}
|
|
19399
|
+
* @memberof SessionConfiguration
|
|
19400
|
+
*/
|
|
19401
|
+
'maxSessionTime'?: number;
|
|
19402
|
+
}
|
|
18546
19403
|
/**
|
|
18547
19404
|
*
|
|
18548
19405
|
* @export
|
|
@@ -18550,7 +19407,7 @@ export type ServiceDeskSourceTypeEnum = typeof ServiceDeskSourceTypeEnum[keyof t
|
|
|
18550
19407
|
*/
|
|
18551
19408
|
export interface SetLifecycleState200Response {
|
|
18552
19409
|
/**
|
|
18553
|
-
*
|
|
19410
|
+
* ID of the IdentityRequest object that is generated when the workflow launches. To follow the IdentityRequest, you can provide this ID with a [Get Account Activity request](https://developer.sailpoint.com/docs/api/v3/get-account-activity/). The response will contain relevant information about the IdentityRequest, such as its status.
|
|
18554
19411
|
* @type {string}
|
|
18555
19412
|
* @memberof SetLifecycleState200Response
|
|
18556
19413
|
*/
|
|
@@ -18563,7 +19420,7 @@ export interface SetLifecycleState200Response {
|
|
|
18563
19420
|
*/
|
|
18564
19421
|
export interface SetLifecycleStateRequest {
|
|
18565
19422
|
/**
|
|
18566
|
-
*
|
|
19423
|
+
* ID of the lifecycle state to set.
|
|
18567
19424
|
* @type {string}
|
|
18568
19425
|
* @memberof SetLifecycleStateRequest
|
|
18569
19426
|
*/
|
|
@@ -19399,6 +20256,7 @@ export declare const SourceFeaturesEnum: {
|
|
|
19399
20256
|
};
|
|
19400
20257
|
export type SourceFeaturesEnum = typeof SourceFeaturesEnum[keyof typeof SourceFeaturesEnum];
|
|
19401
20258
|
export declare const SourceStatusEnum: {
|
|
20259
|
+
readonly ErrorAccountFileImport: "SOURCE_STATE_ERROR_ACCOUNT_FILE_IMPORT";
|
|
19402
20260
|
readonly ErrorCluster: "SOURCE_STATE_ERROR_CLUSTER";
|
|
19403
20261
|
readonly ErrorSource: "SOURCE_STATE_ERROR_SOURCE";
|
|
19404
20262
|
readonly ErrorVa: "SOURCE_STATE_ERROR_VA";
|
|
@@ -19864,6 +20722,70 @@ export interface SpConfigMessage {
|
|
|
19864
20722
|
[key: string]: any;
|
|
19865
20723
|
};
|
|
19866
20724
|
}
|
|
20725
|
+
/**
|
|
20726
|
+
*
|
|
20727
|
+
* @export
|
|
20728
|
+
* @interface SpDetails
|
|
20729
|
+
*/
|
|
20730
|
+
export interface SpDetails {
|
|
20731
|
+
/**
|
|
20732
|
+
* Federation protocol role
|
|
20733
|
+
* @type {string}
|
|
20734
|
+
* @memberof SpDetails
|
|
20735
|
+
*/
|
|
20736
|
+
'role'?: SpDetailsRoleEnum;
|
|
20737
|
+
/**
|
|
20738
|
+
* An entity ID is a globally unique name for a SAML entity, either an Identity Provider (IDP) or a Service Provider (SP).
|
|
20739
|
+
* @type {string}
|
|
20740
|
+
* @memberof SpDetails
|
|
20741
|
+
*/
|
|
20742
|
+
'entityId'?: string;
|
|
20743
|
+
/**
|
|
20744
|
+
* Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations.
|
|
20745
|
+
* @type {string}
|
|
20746
|
+
* @memberof SpDetails
|
|
20747
|
+
*/
|
|
20748
|
+
'alias'?: string;
|
|
20749
|
+
/**
|
|
20750
|
+
* The allowed callback URL where users will be redirected to after authentication. Used with SP configurations.
|
|
20751
|
+
* @type {string}
|
|
20752
|
+
* @memberof SpDetails
|
|
20753
|
+
*/
|
|
20754
|
+
'callbackUrl'?: string;
|
|
20755
|
+
}
|
|
20756
|
+
export declare const SpDetailsRoleEnum: {
|
|
20757
|
+
readonly SamlSp: "SAML_SP";
|
|
20758
|
+
};
|
|
20759
|
+
export type SpDetailsRoleEnum = typeof SpDetailsRoleEnum[keyof typeof SpDetailsRoleEnum];
|
|
20760
|
+
/**
|
|
20761
|
+
* Specification of a Service Provider Details
|
|
20762
|
+
* @export
|
|
20763
|
+
* @interface SpDetailsAllOf
|
|
20764
|
+
*/
|
|
20765
|
+
export interface SpDetailsAllOf {
|
|
20766
|
+
/**
|
|
20767
|
+
* Federation protocol role
|
|
20768
|
+
* @type {string}
|
|
20769
|
+
* @memberof SpDetailsAllOf
|
|
20770
|
+
*/
|
|
20771
|
+
'role'?: SpDetailsAllOfRoleEnum;
|
|
20772
|
+
/**
|
|
20773
|
+
* Unique alias used to identify the selected local service provider based on used URL. Used with SP configurations.
|
|
20774
|
+
* @type {string}
|
|
20775
|
+
* @memberof SpDetailsAllOf
|
|
20776
|
+
*/
|
|
20777
|
+
'alias'?: string;
|
|
20778
|
+
/**
|
|
20779
|
+
* The allowed callback URL where users will be redirected to after authentication. Used with SP configurations.
|
|
20780
|
+
* @type {string}
|
|
20781
|
+
* @memberof SpDetailsAllOf
|
|
20782
|
+
*/
|
|
20783
|
+
'callbackUrl'?: string;
|
|
20784
|
+
}
|
|
20785
|
+
export declare const SpDetailsAllOfRoleEnum: {
|
|
20786
|
+
readonly SamlSp: "SAML_SP";
|
|
20787
|
+
};
|
|
20788
|
+
export type SpDetailsAllOfRoleEnum = typeof SpDetailsAllOfRoleEnum[keyof typeof SpDetailsAllOfRoleEnum];
|
|
19867
20789
|
/**
|
|
19868
20790
|
*
|
|
19869
20791
|
* @export
|
|
@@ -20682,6 +21604,25 @@ export interface TransformReadAllOf {
|
|
|
20682
21604
|
*/
|
|
20683
21605
|
'internal': boolean;
|
|
20684
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
|
+
}
|
|
20685
21626
|
/**
|
|
20686
21627
|
*
|
|
20687
21628
|
* @export
|
|
@@ -21199,6 +22140,143 @@ export interface Value {
|
|
|
21199
22140
|
*/
|
|
21200
22141
|
'value'?: string;
|
|
21201
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
|
+
}
|
|
21202
22280
|
/**
|
|
21203
22281
|
*
|
|
21204
22282
|
* @export
|
|
@@ -21395,6 +22473,31 @@ export interface VisibilityCriteria {
|
|
|
21395
22473
|
*/
|
|
21396
22474
|
'expression'?: Expression;
|
|
21397
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
|
+
}
|
|
21398
22501
|
/**
|
|
21399
22502
|
* The state of a work item
|
|
21400
22503
|
* @export
|
|
@@ -21672,6 +22775,12 @@ export interface Workflow {
|
|
|
21672
22775
|
* @memberof Workflow
|
|
21673
22776
|
*/
|
|
21674
22777
|
'modified'?: string;
|
|
22778
|
+
/**
|
|
22779
|
+
*
|
|
22780
|
+
* @type {WorkflowModifiedBy}
|
|
22781
|
+
* @memberof Workflow
|
|
22782
|
+
*/
|
|
22783
|
+
'modifiedBy'?: WorkflowModifiedBy;
|
|
21675
22784
|
/**
|
|
21676
22785
|
*
|
|
21677
22786
|
* @type {WorkflowAllOfCreator}
|
|
@@ -21751,6 +22860,12 @@ export interface WorkflowAllOf {
|
|
|
21751
22860
|
* @memberof WorkflowAllOf
|
|
21752
22861
|
*/
|
|
21753
22862
|
'modified'?: string;
|
|
22863
|
+
/**
|
|
22864
|
+
*
|
|
22865
|
+
* @type {WorkflowModifiedBy}
|
|
22866
|
+
* @memberof WorkflowAllOf
|
|
22867
|
+
*/
|
|
22868
|
+
'modifiedBy'?: WorkflowModifiedBy;
|
|
21754
22869
|
/**
|
|
21755
22870
|
*
|
|
21756
22871
|
* @type {WorkflowAllOfCreator}
|
|
@@ -22005,7 +23120,37 @@ export interface WorkflowLibraryAction {
|
|
|
22005
23120
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
22006
23121
|
* @memberof WorkflowLibraryAction
|
|
22007
23122
|
*/
|
|
22008
|
-
'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;
|
|
22009
23154
|
/**
|
|
22010
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.
|
|
22011
23156
|
* @type {boolean}
|
|
@@ -22019,12 +23164,23 @@ export interface WorkflowLibraryAction {
|
|
|
22019
23164
|
*/
|
|
22020
23165
|
'outputSchema'?: object;
|
|
22021
23166
|
}
|
|
23167
|
+
/**
|
|
23168
|
+
* @type WorkflowLibraryActionExampleOutput
|
|
23169
|
+
* @export
|
|
23170
|
+
*/
|
|
23171
|
+
export type WorkflowLibraryActionExampleOutput = Array<object> | object;
|
|
22022
23172
|
/**
|
|
22023
23173
|
*
|
|
22024
23174
|
* @export
|
|
22025
23175
|
* @interface WorkflowLibraryFormFields
|
|
22026
23176
|
*/
|
|
22027
23177
|
export interface WorkflowLibraryFormFields {
|
|
23178
|
+
/**
|
|
23179
|
+
* Description of the form field
|
|
23180
|
+
* @type {string}
|
|
23181
|
+
* @memberof WorkflowLibraryFormFields
|
|
23182
|
+
*/
|
|
23183
|
+
'description'?: string;
|
|
22028
23184
|
/**
|
|
22029
23185
|
* Describes the form field in the UI
|
|
22030
23186
|
* @type {string}
|
|
@@ -22051,7 +23207,7 @@ export interface WorkflowLibraryFormFields {
|
|
|
22051
23207
|
'required'?: boolean;
|
|
22052
23208
|
/**
|
|
22053
23209
|
* The type of the form field
|
|
22054
|
-
* @type {
|
|
23210
|
+
* @type {string}
|
|
22055
23211
|
* @memberof WorkflowLibraryFormFields
|
|
22056
23212
|
*/
|
|
22057
23213
|
'type'?: WorkflowLibraryFormFieldsTypeEnum;
|
|
@@ -22070,6 +23226,7 @@ export declare const WorkflowLibraryFormFieldsTypeEnum: {
|
|
|
22070
23226
|
readonly MultiType: "multiType";
|
|
22071
23227
|
readonly Duration: "duration";
|
|
22072
23228
|
readonly Toggle: "toggle";
|
|
23229
|
+
readonly FormPicker: "formPicker";
|
|
22073
23230
|
readonly IdentityPicker: "identityPicker";
|
|
22074
23231
|
readonly GovernanceGroupPicker: "governanceGroupPicker";
|
|
22075
23232
|
readonly String: "string";
|
|
@@ -22079,6 +23236,8 @@ export declare const WorkflowLibraryFormFieldsTypeEnum: {
|
|
|
22079
23236
|
readonly KeyValuePairs: "keyValuePairs";
|
|
22080
23237
|
readonly EmailPicker: "emailPicker";
|
|
22081
23238
|
readonly AdvancedToggle: "advancedToggle";
|
|
23239
|
+
readonly VariableCreator: "variableCreator";
|
|
23240
|
+
readonly HtmlEditor: "htmlEditor";
|
|
22082
23241
|
};
|
|
22083
23242
|
export type WorkflowLibraryFormFieldsTypeEnum = typeof WorkflowLibraryFormFieldsTypeEnum[keyof typeof WorkflowLibraryFormFieldsTypeEnum];
|
|
22084
23243
|
/**
|
|
@@ -22111,12 +23270,36 @@ export interface WorkflowLibraryOperator {
|
|
|
22111
23270
|
* @memberof WorkflowLibraryOperator
|
|
22112
23271
|
*/
|
|
22113
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;
|
|
22114
23297
|
/**
|
|
22115
23298
|
* One or more inputs that the operator accepts
|
|
22116
23299
|
* @type {Array<WorkflowLibraryFormFields>}
|
|
22117
23300
|
* @memberof WorkflowLibraryOperator
|
|
22118
23301
|
*/
|
|
22119
|
-
'formFields'?: Array<WorkflowLibraryFormFields
|
|
23302
|
+
'formFields'?: Array<WorkflowLibraryFormFields> | null;
|
|
22120
23303
|
}
|
|
22121
23304
|
/**
|
|
22122
23305
|
*
|
|
@@ -22132,10 +23315,34 @@ export interface WorkflowLibraryTrigger {
|
|
|
22132
23315
|
'id'?: string;
|
|
22133
23316
|
/**
|
|
22134
23317
|
* Trigger type
|
|
22135
|
-
* @type {
|
|
23318
|
+
* @type {string}
|
|
22136
23319
|
* @memberof WorkflowLibraryTrigger
|
|
22137
23320
|
*/
|
|
22138
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;
|
|
22139
23346
|
/**
|
|
22140
23347
|
* Trigger Name
|
|
22141
23348
|
* @type {string}
|
|
@@ -22173,6 +23380,35 @@ export declare const WorkflowLibraryTriggerTypeEnum: {
|
|
|
22173
23380
|
readonly External: "EXTERNAL";
|
|
22174
23381
|
};
|
|
22175
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];
|
|
22176
23412
|
/**
|
|
22177
23413
|
*
|
|
22178
23414
|
* @export
|
|
@@ -22273,28 +23509,28 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
22273
23509
|
*/
|
|
22274
23510
|
getAccessProfile: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22275
23511
|
/**
|
|
22276
|
-
*
|
|
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.
|
|
22277
23513
|
* @summary List Access Profile\'s Entitlements
|
|
22278
|
-
* @param {string} id ID of the containing
|
|
23514
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22279
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.
|
|
22280
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.
|
|
22281
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.
|
|
22282
|
-
* @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.
|
|
22283
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**
|
|
22284
23520
|
* @param {*} [axiosOptions] Override http request option.
|
|
22285
23521
|
* @throws {RequiredError}
|
|
22286
23522
|
*/
|
|
22287
23523
|
getAccessProfileEntitlements: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
22288
23524
|
/**
|
|
22289
|
-
* 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.
|
|
22290
23526
|
* @summary List Access Profiles
|
|
22291
|
-
* @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.
|
|
22292
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.
|
|
22293
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.
|
|
22294
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.
|
|
22295
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.
|
|
22296
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**
|
|
22297
|
-
* @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.
|
|
22298
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.
|
|
22299
23535
|
* @param {*} [axiosOptions] Override http request option.
|
|
22300
23536
|
* @throws {RequiredError}
|
|
@@ -22348,28 +23584,28 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
22348
23584
|
*/
|
|
22349
23585
|
getAccessProfile(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
22350
23586
|
/**
|
|
22351
|
-
*
|
|
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.
|
|
22352
23588
|
* @summary List Access Profile\'s Entitlements
|
|
22353
|
-
* @param {string} id ID of the containing
|
|
23589
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22354
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.
|
|
22355
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.
|
|
22356
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.
|
|
22357
|
-
* @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.
|
|
22358
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**
|
|
22359
23595
|
* @param {*} [axiosOptions] Override http request option.
|
|
22360
23596
|
* @throws {RequiredError}
|
|
22361
23597
|
*/
|
|
22362
23598
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
22363
23599
|
/**
|
|
22364
|
-
* 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.
|
|
22365
23601
|
* @summary List Access Profiles
|
|
22366
|
-
* @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.
|
|
22367
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.
|
|
22368
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.
|
|
22369
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.
|
|
22370
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.
|
|
22371
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**
|
|
22372
|
-
* @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.
|
|
22373
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.
|
|
22374
23610
|
* @param {*} [axiosOptions] Override http request option.
|
|
22375
23611
|
* @throws {RequiredError}
|
|
@@ -22423,28 +23659,28 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
22423
23659
|
*/
|
|
22424
23660
|
getAccessProfile(id: string, axiosOptions?: any): AxiosPromise<AccessProfile>;
|
|
22425
23661
|
/**
|
|
22426
|
-
*
|
|
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.
|
|
22427
23663
|
* @summary List Access Profile\'s Entitlements
|
|
22428
|
-
* @param {string} id ID of the containing
|
|
23664
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
22429
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.
|
|
22430
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.
|
|
22431
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.
|
|
22432
|
-
* @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.
|
|
22433
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**
|
|
22434
23670
|
* @param {*} [axiosOptions] Override http request option.
|
|
22435
23671
|
* @throws {RequiredError}
|
|
22436
23672
|
*/
|
|
22437
23673
|
getAccessProfileEntitlements(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Entitlement>>;
|
|
22438
23674
|
/**
|
|
22439
|
-
* 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.
|
|
22440
23676
|
* @summary List Access Profiles
|
|
22441
|
-
* @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.
|
|
22442
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.
|
|
22443
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.
|
|
22444
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.
|
|
22445
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.
|
|
22446
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**
|
|
22447
|
-
* @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.
|
|
22448
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.
|
|
22449
23685
|
* @param {*} [axiosOptions] Override http request option.
|
|
22450
23686
|
* @throws {RequiredError}
|
|
@@ -22519,7 +23755,7 @@ export interface AccessProfilesApiGetAccessProfileRequest {
|
|
|
22519
23755
|
*/
|
|
22520
23756
|
export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
22521
23757
|
/**
|
|
22522
|
-
* ID of the containing
|
|
23758
|
+
* ID of the access profile containing the entitlements.
|
|
22523
23759
|
* @type {string}
|
|
22524
23760
|
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
22525
23761
|
*/
|
|
@@ -22543,7 +23779,7 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
22543
23779
|
*/
|
|
22544
23780
|
readonly count?: boolean;
|
|
22545
23781
|
/**
|
|
22546
|
-
* 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.
|
|
22547
23783
|
* @type {string}
|
|
22548
23784
|
* @memberof AccessProfilesApiGetAccessProfileEntitlements
|
|
22549
23785
|
*/
|
|
@@ -22562,7 +23798,7 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsRequest {
|
|
|
22562
23798
|
*/
|
|
22563
23799
|
export interface AccessProfilesApiListAccessProfilesRequest {
|
|
22564
23800
|
/**
|
|
22565
|
-
* 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.
|
|
22566
23802
|
* @type {string}
|
|
22567
23803
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
22568
23804
|
*/
|
|
@@ -22598,7 +23834,7 @@ export interface AccessProfilesApiListAccessProfilesRequest {
|
|
|
22598
23834
|
*/
|
|
22599
23835
|
readonly sorters?: string;
|
|
22600
23836
|
/**
|
|
22601
|
-
* 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.
|
|
22602
23838
|
* @type {string}
|
|
22603
23839
|
* @memberof AccessProfilesApiListAccessProfiles
|
|
22604
23840
|
*/
|
|
@@ -22673,7 +23909,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
22673
23909
|
*/
|
|
22674
23910
|
getAccessProfile(requestParameters: AccessProfilesApiGetAccessProfileRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
22675
23911
|
/**
|
|
22676
|
-
*
|
|
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.
|
|
22677
23913
|
* @summary List Access Profile\'s Entitlements
|
|
22678
23914
|
* @param {AccessProfilesApiGetAccessProfileEntitlementsRequest} requestParameters Request parameters.
|
|
22679
23915
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -22682,7 +23918,7 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
22682
23918
|
*/
|
|
22683
23919
|
getAccessProfileEntitlements(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
22684
23920
|
/**
|
|
22685
|
-
* 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.
|
|
22686
23922
|
* @summary List Access Profiles
|
|
22687
23923
|
* @param {AccessProfilesApiListAccessProfilesRequest} requestParameters Request parameters.
|
|
22688
23924
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -23799,7 +25035,7 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
23799
25035
|
*/
|
|
23800
25036
|
listAccounts: (limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23801
25037
|
/**
|
|
23802
|
-
* 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.**
|
|
23803
25039
|
* @summary Update Account
|
|
23804
25040
|
* @param {string} id Account ID.
|
|
23805
25041
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -23825,14 +25061,14 @@ export declare const AccountsApiAxiosParamCreator: (configuration?: Configuratio
|
|
|
23825
25061
|
*/
|
|
23826
25062
|
unlockAccount: (id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23827
25063
|
/**
|
|
23828
|
-
*
|
|
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.
|
|
23829
25065
|
* @summary Update Account
|
|
23830
25066
|
* @param {string} id Account ID.
|
|
23831
|
-
* @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.
|
|
23832
25068
|
* @param {*} [axiosOptions] Override http request option.
|
|
23833
25069
|
* @throws {RequiredError}
|
|
23834
25070
|
*/
|
|
23835
|
-
updateAccount: (id: string,
|
|
25071
|
+
updateAccount: (id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
23836
25072
|
};
|
|
23837
25073
|
/**
|
|
23838
25074
|
* AccountsApi - functional programming interface
|
|
@@ -23905,7 +25141,7 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
23905
25141
|
*/
|
|
23906
25142
|
listAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Account>>>;
|
|
23907
25143
|
/**
|
|
23908
|
-
* 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.**
|
|
23909
25145
|
* @summary Update Account
|
|
23910
25146
|
* @param {string} id Account ID.
|
|
23911
25147
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -23931,14 +25167,14 @@ export declare const AccountsApiFp: (configuration?: Configuration) => {
|
|
|
23931
25167
|
*/
|
|
23932
25168
|
unlockAccount(id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccountsAsyncResult>>;
|
|
23933
25169
|
/**
|
|
23934
|
-
*
|
|
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.
|
|
23935
25171
|
* @summary Update Account
|
|
23936
25172
|
* @param {string} id Account ID.
|
|
23937
|
-
* @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.
|
|
23938
25174
|
* @param {*} [axiosOptions] Override http request option.
|
|
23939
25175
|
* @throws {RequiredError}
|
|
23940
25176
|
*/
|
|
23941
|
-
updateAccount(id: string,
|
|
25177
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
23942
25178
|
};
|
|
23943
25179
|
/**
|
|
23944
25180
|
* AccountsApi - factory interface
|
|
@@ -24011,7 +25247,7 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
24011
25247
|
*/
|
|
24012
25248
|
listAccounts(limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<Account>>;
|
|
24013
25249
|
/**
|
|
24014
|
-
* 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.**
|
|
24015
25251
|
* @summary Update Account
|
|
24016
25252
|
* @param {string} id Account ID.
|
|
24017
25253
|
* @param {AccountAttributes} accountAttributes
|
|
@@ -24037,14 +25273,14 @@ export declare const AccountsApiFactory: (configuration?: Configuration, basePat
|
|
|
24037
25273
|
*/
|
|
24038
25274
|
unlockAccount(id: string, accountUnlockRequest: AccountUnlockRequest, axiosOptions?: any): AxiosPromise<AccountsAsyncResult>;
|
|
24039
25275
|
/**
|
|
24040
|
-
*
|
|
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.
|
|
24041
25277
|
* @summary Update Account
|
|
24042
25278
|
* @param {string} id Account ID.
|
|
24043
|
-
* @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.
|
|
24044
25280
|
* @param {*} [axiosOptions] Override http request option.
|
|
24045
25281
|
* @throws {RequiredError}
|
|
24046
25282
|
*/
|
|
24047
|
-
updateAccount(id: string,
|
|
25283
|
+
updateAccount(id: string, requestBody: Array<object>, axiosOptions?: any): AxiosPromise<object>;
|
|
24048
25284
|
};
|
|
24049
25285
|
/**
|
|
24050
25286
|
* Request parameters for createAccount operation in AccountsApi.
|
|
@@ -24256,10 +25492,10 @@ export interface AccountsApiUpdateAccountRequest {
|
|
|
24256
25492
|
readonly id: string;
|
|
24257
25493
|
/**
|
|
24258
25494
|
* A list of account update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard.
|
|
24259
|
-
* @type {Array<
|
|
25495
|
+
* @type {Array<object>}
|
|
24260
25496
|
* @memberof AccountsApiUpdateAccount
|
|
24261
25497
|
*/
|
|
24262
|
-
readonly
|
|
25498
|
+
readonly requestBody: Array<object>;
|
|
24263
25499
|
}
|
|
24264
25500
|
/**
|
|
24265
25501
|
* AccountsApi - object-oriented interface
|
|
@@ -24332,7 +25568,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24332
25568
|
*/
|
|
24333
25569
|
listAccounts(requestParameters?: AccountsApiListAccountsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Account[], any>>;
|
|
24334
25570
|
/**
|
|
24335
|
-
* 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.**
|
|
24336
25572
|
* @summary Update Account
|
|
24337
25573
|
* @param {AccountsApiPutAccountRequest} requestParameters Request parameters.
|
|
24338
25574
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24359,7 +25595,7 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24359
25595
|
*/
|
|
24360
25596
|
unlockAccount(requestParameters: AccountsApiUnlockAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountsAsyncResult, any>>;
|
|
24361
25597
|
/**
|
|
24362
|
-
*
|
|
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.
|
|
24363
25599
|
* @summary Update Account
|
|
24364
25600
|
* @param {AccountsApiUpdateAccountRequest} requestParameters Request parameters.
|
|
24365
25601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -24368,6 +25604,209 @@ export declare class AccountsApi extends BaseAPI {
|
|
|
24368
25604
|
*/
|
|
24369
25605
|
updateAccount(requestParameters: AccountsApiUpdateAccountRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
24370
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
|
+
}
|
|
24371
25810
|
/**
|
|
24372
25811
|
* AuthUsersApi - axios parameter creator
|
|
24373
25812
|
* @export
|
|
@@ -24875,8 +26314,8 @@ export declare class BrandingApi extends BaseAPI {
|
|
|
24875
26314
|
*/
|
|
24876
26315
|
export declare const CertificationCampaignFiltersApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
24877
26316
|
/**
|
|
24878
|
-
*
|
|
24879
|
-
* @summary Create
|
|
26317
|
+
* Use this API to create a campaign filter based on filter details and criteria.
|
|
26318
|
+
* @summary Create Campaign Filter
|
|
24880
26319
|
* @param {CampaignFilterDetails} campaignFilterDetails
|
|
24881
26320
|
* @param {*} [axiosOptions] Override http request option.
|
|
24882
26321
|
* @throws {RequiredError}
|
|
@@ -24899,11 +26338,11 @@ export declare const CertificationCampaignFiltersApiAxiosParamCreator: (configur
|
|
|
24899
26338
|
*/
|
|
24900
26339
|
getCampaignFilterById: (filterId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
24901
26340
|
/**
|
|
24902
|
-
*
|
|
26341
|
+
* Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
|
|
24903
26342
|
* @summary List Campaign Filters
|
|
24904
26343
|
* @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.
|
|
24905
26344
|
* @param {number} [start] Start/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.
|
|
24906
|
-
* @param {boolean} [includeSystemFilters] If true,
|
|
26345
|
+
* @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
|
|
24907
26346
|
* @param {*} [axiosOptions] Override http request option.
|
|
24908
26347
|
* @throws {RequiredError}
|
|
24909
26348
|
*/
|
|
@@ -24924,8 +26363,8 @@ export declare const CertificationCampaignFiltersApiAxiosParamCreator: (configur
|
|
|
24924
26363
|
*/
|
|
24925
26364
|
export declare const CertificationCampaignFiltersApiFp: (configuration?: Configuration) => {
|
|
24926
26365
|
/**
|
|
24927
|
-
*
|
|
24928
|
-
* @summary Create
|
|
26366
|
+
* Use this API to create a campaign filter based on filter details and criteria.
|
|
26367
|
+
* @summary Create Campaign Filter
|
|
24929
26368
|
* @param {CampaignFilterDetails} campaignFilterDetails
|
|
24930
26369
|
* @param {*} [axiosOptions] Override http request option.
|
|
24931
26370
|
* @throws {RequiredError}
|
|
@@ -24948,11 +26387,11 @@ export declare const CertificationCampaignFiltersApiFp: (configuration?: Configu
|
|
|
24948
26387
|
*/
|
|
24949
26388
|
getCampaignFilterById(filterId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignFilterDetails>>>;
|
|
24950
26389
|
/**
|
|
24951
|
-
*
|
|
26390
|
+
* Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
|
|
24952
26391
|
* @summary List Campaign Filters
|
|
24953
26392
|
* @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.
|
|
24954
26393
|
* @param {number} [start] Start/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.
|
|
24955
|
-
* @param {boolean} [includeSystemFilters] If true,
|
|
26394
|
+
* @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
|
|
24956
26395
|
* @param {*} [axiosOptions] Override http request option.
|
|
24957
26396
|
* @throws {RequiredError}
|
|
24958
26397
|
*/
|
|
@@ -24973,8 +26412,8 @@ export declare const CertificationCampaignFiltersApiFp: (configuration?: Configu
|
|
|
24973
26412
|
*/
|
|
24974
26413
|
export declare const CertificationCampaignFiltersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
24975
26414
|
/**
|
|
24976
|
-
*
|
|
24977
|
-
* @summary Create
|
|
26415
|
+
* Use this API to create a campaign filter based on filter details and criteria.
|
|
26416
|
+
* @summary Create Campaign Filter
|
|
24978
26417
|
* @param {CampaignFilterDetails} campaignFilterDetails
|
|
24979
26418
|
* @param {*} [axiosOptions] Override http request option.
|
|
24980
26419
|
* @throws {RequiredError}
|
|
@@ -24997,11 +26436,11 @@ export declare const CertificationCampaignFiltersApiFactory: (configuration?: Co
|
|
|
24997
26436
|
*/
|
|
24998
26437
|
getCampaignFilterById(filterId: string, axiosOptions?: any): AxiosPromise<Array<CampaignFilterDetails>>;
|
|
24999
26438
|
/**
|
|
25000
|
-
*
|
|
26439
|
+
* Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
|
|
25001
26440
|
* @summary List Campaign Filters
|
|
25002
26441
|
* @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.
|
|
25003
26442
|
* @param {number} [start] Start/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.
|
|
25004
|
-
* @param {boolean} [includeSystemFilters] If true,
|
|
26443
|
+
* @param {boolean} [includeSystemFilters] If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
|
|
25005
26444
|
* @param {*} [axiosOptions] Override http request option.
|
|
25006
26445
|
* @throws {RequiredError}
|
|
25007
26446
|
*/
|
|
@@ -25074,7 +26513,7 @@ export interface CertificationCampaignFiltersApiListCampaignFiltersRequest {
|
|
|
25074
26513
|
*/
|
|
25075
26514
|
readonly start?: number;
|
|
25076
26515
|
/**
|
|
25077
|
-
* If true,
|
|
26516
|
+
* If this is true, the API includes system filters in the count and results. Otherwise it excludes them. If no value is provided, the default is true.
|
|
25078
26517
|
* @type {boolean}
|
|
25079
26518
|
* @memberof CertificationCampaignFiltersApiListCampaignFilters
|
|
25080
26519
|
*/
|
|
@@ -25107,8 +26546,8 @@ export interface CertificationCampaignFiltersApiUpdateCampaignFilterRequest {
|
|
|
25107
26546
|
*/
|
|
25108
26547
|
export declare class CertificationCampaignFiltersApi extends BaseAPI {
|
|
25109
26548
|
/**
|
|
25110
|
-
*
|
|
25111
|
-
* @summary Create
|
|
26549
|
+
* Use this API to create a campaign filter based on filter details and criteria.
|
|
26550
|
+
* @summary Create Campaign Filter
|
|
25112
26551
|
* @param {CertificationCampaignFiltersApiCreateCampaignFilterRequest} requestParameters Request parameters.
|
|
25113
26552
|
* @param {*} [axiosOptions] Override http request option.
|
|
25114
26553
|
* @throws {RequiredError}
|
|
@@ -25134,7 +26573,7 @@ export declare class CertificationCampaignFiltersApi extends BaseAPI {
|
|
|
25134
26573
|
*/
|
|
25135
26574
|
getCampaignFilterById(requestParameters: CertificationCampaignFiltersApiGetCampaignFilterByIdRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignFilterDetails[], any>>;
|
|
25136
26575
|
/**
|
|
25137
|
-
*
|
|
26576
|
+
* Use this API to list all campaign filters. You can reduce scope with standard V3 query parameters.
|
|
25138
26577
|
* @summary List Campaign Filters
|
|
25139
26578
|
* @param {CertificationCampaignFiltersApiListCampaignFiltersRequest} requestParameters Request parameters.
|
|
25140
26579
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25158,7 +26597,7 @@ export declare class CertificationCampaignFiltersApi extends BaseAPI {
|
|
|
25158
26597
|
*/
|
|
25159
26598
|
export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
25160
26599
|
/**
|
|
25161
|
-
* :::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.
|
|
25162
26601
|
* @summary Complete a Campaign
|
|
25163
26602
|
* @param {string} id Campaign ID.
|
|
25164
26603
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25167,7 +26606,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25167
26606
|
*/
|
|
25168
26607
|
completeCampaign: (id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25169
26608
|
/**
|
|
25170
|
-
* 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.
|
|
25171
26610
|
* @summary Create a campaign
|
|
25172
26611
|
* @param {Campaign} campaign
|
|
25173
26612
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25175,7 +26614,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25175
26614
|
*/
|
|
25176
26615
|
createCampaign: (campaign: Campaign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25177
26616
|
/**
|
|
25178
|
-
* 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.
|
|
25179
26618
|
* @summary Create a Campaign Template
|
|
25180
26619
|
* @param {CampaignTemplate} campaignTemplate
|
|
25181
26620
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25183,7 +26622,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25183
26622
|
*/
|
|
25184
26623
|
createCampaignTemplate: (campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25185
26624
|
/**
|
|
25186
|
-
* 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.
|
|
25187
26626
|
* @summary Delete a Campaign Template
|
|
25188
26627
|
* @param {string} id ID of the campaign template being deleted.
|
|
25189
26628
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25191,7 +26630,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25191
26630
|
*/
|
|
25192
26631
|
deleteCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25193
26632
|
/**
|
|
25194
|
-
* 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.
|
|
25195
26634
|
* @summary Delete Campaign Template Schedule
|
|
25196
26635
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25197
26636
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25199,7 +26638,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25199
26638
|
*/
|
|
25200
26639
|
deleteCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25201
26640
|
/**
|
|
25202
|
-
* 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.
|
|
25203
26642
|
* @summary Delete Campaigns
|
|
25204
26643
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25205
26644
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25207,7 +26646,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25207
26646
|
*/
|
|
25208
26647
|
deleteCampaigns: (campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25209
26648
|
/**
|
|
25210
|
-
* 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.
|
|
25211
26650
|
* @summary List Campaigns
|
|
25212
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.
|
|
25213
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.
|
|
@@ -25220,15 +26659,16 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25220
26659
|
*/
|
|
25221
26660
|
getActiveCampaigns: (detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25222
26661
|
/**
|
|
25223
|
-
* 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.
|
|
25224
26663
|
* @summary Get Campaign
|
|
25225
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.
|
|
25226
26666
|
* @param {*} [axiosOptions] Override http request option.
|
|
25227
26667
|
* @throws {RequiredError}
|
|
25228
26668
|
*/
|
|
25229
|
-
getCampaign: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
26669
|
+
getCampaign: (id: string, detail?: 'SLIM' | 'FULL', axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25230
26670
|
/**
|
|
25231
|
-
* 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.
|
|
25232
26672
|
* @summary Get Campaign Reports
|
|
25233
26673
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
25234
26674
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25236,14 +26676,14 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25236
26676
|
*/
|
|
25237
26677
|
getCampaignReports: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25238
26678
|
/**
|
|
25239
|
-
* 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.
|
|
25240
26680
|
* @summary Get Campaign Reports Configuration
|
|
25241
26681
|
* @param {*} [axiosOptions] Override http request option.
|
|
25242
26682
|
* @throws {RequiredError}
|
|
25243
26683
|
*/
|
|
25244
26684
|
getCampaignReportsConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25245
26685
|
/**
|
|
25246
|
-
* 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.
|
|
25247
26687
|
* @summary Get a Campaign Template
|
|
25248
26688
|
* @param {string} id Requested campaign template\'s ID.
|
|
25249
26689
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25251,7 +26691,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25251
26691
|
*/
|
|
25252
26692
|
getCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25253
26693
|
/**
|
|
25254
|
-
* 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.
|
|
25255
26695
|
* @summary Get Campaign Template Schedule
|
|
25256
26696
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
25257
26697
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25259,7 +26699,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25259
26699
|
*/
|
|
25260
26700
|
getCampaignTemplateSchedule: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25261
26701
|
/**
|
|
25262
|
-
* 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.
|
|
25263
26703
|
* @summary List Campaign Templates
|
|
25264
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.
|
|
25265
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.
|
|
@@ -25271,7 +26711,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25271
26711
|
*/
|
|
25272
26712
|
getCampaignTemplates: (limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25273
26713
|
/**
|
|
25274
|
-
* 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.
|
|
25275
26715
|
* @summary Reassign Certifications
|
|
25276
26716
|
* @param {string} id The certification campaign ID
|
|
25277
26717
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -25280,7 +26720,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25280
26720
|
*/
|
|
25281
26721
|
move: (id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25282
26722
|
/**
|
|
25283
|
-
* 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.
|
|
25284
26724
|
* @summary Update a Campaign Template
|
|
25285
26725
|
* @param {string} id ID of the campaign template being modified.
|
|
25286
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)
|
|
@@ -25289,7 +26729,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25289
26729
|
*/
|
|
25290
26730
|
patchCampaignTemplate: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25291
26731
|
/**
|
|
25292
|
-
* 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.
|
|
25293
26733
|
* @summary Set Campaign Reports Configuration
|
|
25294
26734
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
25295
26735
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25297,7 +26737,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25297
26737
|
*/
|
|
25298
26738
|
setCampaignReportsConfig: (campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25299
26739
|
/**
|
|
25300
|
-
* 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.
|
|
25301
26741
|
* @summary Set Campaign Template Schedule
|
|
25302
26742
|
* @param {string} id ID of the campaign template being scheduled.
|
|
25303
26743
|
* @param {Schedule} [schedule]
|
|
@@ -25306,7 +26746,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25306
26746
|
*/
|
|
25307
26747
|
setCampaignTemplateSchedule: (id: string, schedule?: Schedule, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25308
26748
|
/**
|
|
25309
|
-
* 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.
|
|
25310
26750
|
* @summary Activate a Campaign
|
|
25311
26751
|
* @param {string} id Campaign ID.
|
|
25312
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.
|
|
@@ -25315,7 +26755,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25315
26755
|
*/
|
|
25316
26756
|
startCampaign: (id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25317
26757
|
/**
|
|
25318
|
-
* 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.
|
|
25319
26759
|
* @summary Run Campaign Remediation Scan
|
|
25320
26760
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
25321
26761
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25323,7 +26763,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25323
26763
|
*/
|
|
25324
26764
|
startCampaignRemediationScan: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25325
26765
|
/**
|
|
25326
|
-
* 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.
|
|
25327
26767
|
* @summary Run Campaign Report
|
|
25328
26768
|
* @param {string} id ID of the campaign the report is being run for.
|
|
25329
26769
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -25332,7 +26772,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25332
26772
|
*/
|
|
25333
26773
|
startCampaignReport: (id: string, type: ReportType, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25334
26774
|
/**
|
|
25335
|
-
* 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.
|
|
25336
26776
|
* @summary Generate a Campaign from Template
|
|
25337
26777
|
* @param {string} id ID of the campaign template to use for generation.
|
|
25338
26778
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25340,7 +26780,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25340
26780
|
*/
|
|
25341
26781
|
startGenerateCampaignTemplate: (id: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
25342
26782
|
/**
|
|
25343
|
-
* 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.
|
|
25344
26784
|
* @summary Update a Campaign
|
|
25345
26785
|
* @param {string} id ID of the campaign template being modified.
|
|
25346
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
|
|
@@ -25355,7 +26795,7 @@ export declare const CertificationCampaignsApiAxiosParamCreator: (configuration?
|
|
|
25355
26795
|
*/
|
|
25356
26796
|
export declare const CertificationCampaignsApiFp: (configuration?: Configuration) => {
|
|
25357
26797
|
/**
|
|
25358
|
-
* :::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.
|
|
25359
26799
|
* @summary Complete a Campaign
|
|
25360
26800
|
* @param {string} id Campaign ID.
|
|
25361
26801
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25364,7 +26804,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25364
26804
|
*/
|
|
25365
26805
|
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25366
26806
|
/**
|
|
25367
|
-
* 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.
|
|
25368
26808
|
* @summary Create a campaign
|
|
25369
26809
|
* @param {Campaign} campaign
|
|
25370
26810
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25372,7 +26812,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25372
26812
|
*/
|
|
25373
26813
|
createCampaign(campaign: Campaign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Campaign>>;
|
|
25374
26814
|
/**
|
|
25375
|
-
* 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.
|
|
25376
26816
|
* @summary Create a Campaign Template
|
|
25377
26817
|
* @param {CampaignTemplate} campaignTemplate
|
|
25378
26818
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25380,7 +26820,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25380
26820
|
*/
|
|
25381
26821
|
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25382
26822
|
/**
|
|
25383
|
-
* 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.
|
|
25384
26824
|
* @summary Delete a Campaign Template
|
|
25385
26825
|
* @param {string} id ID of the campaign template being deleted.
|
|
25386
26826
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25388,7 +26828,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25388
26828
|
*/
|
|
25389
26829
|
deleteCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25390
26830
|
/**
|
|
25391
|
-
* 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.
|
|
25392
26832
|
* @summary Delete Campaign Template Schedule
|
|
25393
26833
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25394
26834
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25396,7 +26836,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25396
26836
|
*/
|
|
25397
26837
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25398
26838
|
/**
|
|
25399
|
-
* 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.
|
|
25400
26840
|
* @summary Delete Campaigns
|
|
25401
26841
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25402
26842
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25404,7 +26844,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25404
26844
|
*/
|
|
25405
26845
|
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25406
26846
|
/**
|
|
25407
|
-
* 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.
|
|
25408
26848
|
* @summary List Campaigns
|
|
25409
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.
|
|
25410
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.
|
|
@@ -25417,15 +26857,16 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25417
26857
|
*/
|
|
25418
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>>>;
|
|
25419
26859
|
/**
|
|
25420
|
-
* 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.
|
|
25421
26861
|
* @summary Get Campaign
|
|
25422
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.
|
|
25423
26864
|
* @param {*} [axiosOptions] Override http request option.
|
|
25424
26865
|
* @throws {RequiredError}
|
|
25425
26866
|
*/
|
|
25426
|
-
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>>;
|
|
25427
26868
|
/**
|
|
25428
|
-
* 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.
|
|
25429
26870
|
* @summary Get Campaign Reports
|
|
25430
26871
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
25431
26872
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25433,14 +26874,14 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25433
26874
|
*/
|
|
25434
26875
|
getCampaignReports(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignReport>>>;
|
|
25435
26876
|
/**
|
|
25436
|
-
* 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.
|
|
25437
26878
|
* @summary Get Campaign Reports Configuration
|
|
25438
26879
|
* @param {*} [axiosOptions] Override http request option.
|
|
25439
26880
|
* @throws {RequiredError}
|
|
25440
26881
|
*/
|
|
25441
26882
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
25442
26883
|
/**
|
|
25443
|
-
* 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.
|
|
25444
26885
|
* @summary Get a Campaign Template
|
|
25445
26886
|
* @param {string} id Requested campaign template\'s ID.
|
|
25446
26887
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25448,7 +26889,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25448
26889
|
*/
|
|
25449
26890
|
getCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25450
26891
|
/**
|
|
25451
|
-
* 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.
|
|
25452
26893
|
* @summary Get Campaign Template Schedule
|
|
25453
26894
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
25454
26895
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25456,7 +26897,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25456
26897
|
*/
|
|
25457
26898
|
getCampaignTemplateSchedule(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Schedule>>;
|
|
25458
26899
|
/**
|
|
25459
|
-
* 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.
|
|
25460
26901
|
* @summary List Campaign Templates
|
|
25461
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.
|
|
25462
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.
|
|
@@ -25468,7 +26909,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25468
26909
|
*/
|
|
25469
26910
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<CampaignTemplate>>>;
|
|
25470
26911
|
/**
|
|
25471
|
-
* 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.
|
|
25472
26913
|
* @summary Reassign Certifications
|
|
25473
26914
|
* @param {string} id The certification campaign ID
|
|
25474
26915
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -25477,7 +26918,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25477
26918
|
*/
|
|
25478
26919
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CertificationTask>>;
|
|
25479
26920
|
/**
|
|
25480
|
-
* 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.
|
|
25481
26922
|
* @summary Update a Campaign Template
|
|
25482
26923
|
* @param {string} id ID of the campaign template being modified.
|
|
25483
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)
|
|
@@ -25486,7 +26927,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25486
26927
|
*/
|
|
25487
26928
|
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignTemplate>>;
|
|
25488
26929
|
/**
|
|
25489
|
-
* 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.
|
|
25490
26931
|
* @summary Set Campaign Reports Configuration
|
|
25491
26932
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
25492
26933
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25494,7 +26935,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25494
26935
|
*/
|
|
25495
26936
|
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReportsConfig>>;
|
|
25496
26937
|
/**
|
|
25497
|
-
* 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.
|
|
25498
26939
|
* @summary Set Campaign Template Schedule
|
|
25499
26940
|
* @param {string} id ID of the campaign template being scheduled.
|
|
25500
26941
|
* @param {Schedule} [schedule]
|
|
@@ -25503,7 +26944,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25503
26944
|
*/
|
|
25504
26945
|
setCampaignTemplateSchedule(id: string, schedule?: Schedule, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
25505
26946
|
/**
|
|
25506
|
-
* 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.
|
|
25507
26948
|
* @summary Activate a Campaign
|
|
25508
26949
|
* @param {string} id Campaign ID.
|
|
25509
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.
|
|
@@ -25512,7 +26953,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25512
26953
|
*/
|
|
25513
26954
|
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25514
26955
|
/**
|
|
25515
|
-
* 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.
|
|
25516
26957
|
* @summary Run Campaign Remediation Scan
|
|
25517
26958
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
25518
26959
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25520,7 +26961,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25520
26961
|
*/
|
|
25521
26962
|
startCampaignRemediationScan(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25522
26963
|
/**
|
|
25523
|
-
* 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.
|
|
25524
26965
|
* @summary Run Campaign Report
|
|
25525
26966
|
* @param {string} id ID of the campaign the report is being run for.
|
|
25526
26967
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -25529,7 +26970,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25529
26970
|
*/
|
|
25530
26971
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
|
|
25531
26972
|
/**
|
|
25532
|
-
* 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.
|
|
25533
26974
|
* @summary Generate a Campaign from Template
|
|
25534
26975
|
* @param {string} id ID of the campaign template to use for generation.
|
|
25535
26976
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25537,7 +26978,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25537
26978
|
*/
|
|
25538
26979
|
startGenerateCampaignTemplate(id: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CampaignReference>>;
|
|
25539
26980
|
/**
|
|
25540
|
-
* 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.
|
|
25541
26982
|
* @summary Update a Campaign
|
|
25542
26983
|
* @param {string} id ID of the campaign template being modified.
|
|
25543
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
|
|
@@ -25552,7 +26993,7 @@ export declare const CertificationCampaignsApiFp: (configuration?: Configuration
|
|
|
25552
26993
|
*/
|
|
25553
26994
|
export declare const CertificationCampaignsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
25554
26995
|
/**
|
|
25555
|
-
* :::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.
|
|
25556
26997
|
* @summary Complete a Campaign
|
|
25557
26998
|
* @param {string} id Campaign ID.
|
|
25558
26999
|
* @param {CampaignCompleteOptions} [campaignCompleteOptions] Optional. Default behavior is for the campaign to auto-approve upon completion, unless autoCompleteAction=REVOKE
|
|
@@ -25561,7 +27002,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25561
27002
|
*/
|
|
25562
27003
|
completeCampaign(id: string, campaignCompleteOptions?: CampaignCompleteOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
25563
27004
|
/**
|
|
25564
|
-
* 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.
|
|
25565
27006
|
* @summary Create a campaign
|
|
25566
27007
|
* @param {Campaign} campaign
|
|
25567
27008
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25569,7 +27010,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25569
27010
|
*/
|
|
25570
27011
|
createCampaign(campaign: Campaign, axiosOptions?: any): AxiosPromise<Campaign>;
|
|
25571
27012
|
/**
|
|
25572
|
-
* 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.
|
|
25573
27014
|
* @summary Create a Campaign Template
|
|
25574
27015
|
* @param {CampaignTemplate} campaignTemplate
|
|
25575
27016
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25577,7 +27018,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25577
27018
|
*/
|
|
25578
27019
|
createCampaignTemplate(campaignTemplate: CampaignTemplate, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
25579
27020
|
/**
|
|
25580
|
-
* 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.
|
|
25581
27022
|
* @summary Delete a Campaign Template
|
|
25582
27023
|
* @param {string} id ID of the campaign template being deleted.
|
|
25583
27024
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25585,7 +27026,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25585
27026
|
*/
|
|
25586
27027
|
deleteCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
25587
27028
|
/**
|
|
25588
|
-
* 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.
|
|
25589
27030
|
* @summary Delete Campaign Template Schedule
|
|
25590
27031
|
* @param {string} id ID of the campaign template whose schedule is being deleted.
|
|
25591
27032
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25593,7 +27034,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25593
27034
|
*/
|
|
25594
27035
|
deleteCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<void>;
|
|
25595
27036
|
/**
|
|
25596
|
-
* 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.
|
|
25597
27038
|
* @summary Delete Campaigns
|
|
25598
27039
|
* @param {CampaignsDeleteRequest} campaignsDeleteRequest IDs of the campaigns to delete.
|
|
25599
27040
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25601,7 +27042,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25601
27042
|
*/
|
|
25602
27043
|
deleteCampaigns(campaignsDeleteRequest: CampaignsDeleteRequest, axiosOptions?: any): AxiosPromise<object>;
|
|
25603
27044
|
/**
|
|
25604
|
-
* 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.
|
|
25605
27046
|
* @summary List Campaigns
|
|
25606
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.
|
|
25607
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.
|
|
@@ -25614,15 +27055,16 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25614
27055
|
*/
|
|
25615
27056
|
getActiveCampaigns(detail?: 'SLIM' | 'FULL', limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: any): AxiosPromise<Array<GetActiveCampaigns200ResponseInner>>;
|
|
25616
27057
|
/**
|
|
25617
|
-
* 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.
|
|
25618
27059
|
* @summary Get Campaign
|
|
25619
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.
|
|
25620
27062
|
* @param {*} [axiosOptions] Override http request option.
|
|
25621
27063
|
* @throws {RequiredError}
|
|
25622
27064
|
*/
|
|
25623
|
-
getCampaign(id: string, axiosOptions?: any): AxiosPromise<
|
|
27065
|
+
getCampaign(id: string, detail?: 'SLIM' | 'FULL', axiosOptions?: any): AxiosPromise<GetActiveCampaigns200ResponseInner>;
|
|
25624
27066
|
/**
|
|
25625
|
-
* 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.
|
|
25626
27068
|
* @summary Get Campaign Reports
|
|
25627
27069
|
* @param {string} id ID of the campaign whose reports are being fetched.
|
|
25628
27070
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25630,14 +27072,14 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25630
27072
|
*/
|
|
25631
27073
|
getCampaignReports(id: string, axiosOptions?: any): AxiosPromise<Array<CampaignReport>>;
|
|
25632
27074
|
/**
|
|
25633
|
-
* 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.
|
|
25634
27076
|
* @summary Get Campaign Reports Configuration
|
|
25635
27077
|
* @param {*} [axiosOptions] Override http request option.
|
|
25636
27078
|
* @throws {RequiredError}
|
|
25637
27079
|
*/
|
|
25638
27080
|
getCampaignReportsConfig(axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
25639
27081
|
/**
|
|
25640
|
-
* 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.
|
|
25641
27083
|
* @summary Get a Campaign Template
|
|
25642
27084
|
* @param {string} id Requested campaign template\'s ID.
|
|
25643
27085
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25645,7 +27087,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25645
27087
|
*/
|
|
25646
27088
|
getCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
25647
27089
|
/**
|
|
25648
|
-
* 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.
|
|
25649
27091
|
* @summary Get Campaign Template Schedule
|
|
25650
27092
|
* @param {string} id ID of the campaign template whose schedule is being fetched.
|
|
25651
27093
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25653,7 +27095,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25653
27095
|
*/
|
|
25654
27096
|
getCampaignTemplateSchedule(id: string, axiosOptions?: any): AxiosPromise<Schedule>;
|
|
25655
27097
|
/**
|
|
25656
|
-
* 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.
|
|
25657
27099
|
* @summary List Campaign Templates
|
|
25658
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.
|
|
25659
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.
|
|
@@ -25665,7 +27107,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25665
27107
|
*/
|
|
25666
27108
|
getCampaignTemplates(limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<CampaignTemplate>>;
|
|
25667
27109
|
/**
|
|
25668
|
-
* 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.
|
|
25669
27111
|
* @summary Reassign Certifications
|
|
25670
27112
|
* @param {string} id The certification campaign ID
|
|
25671
27113
|
* @param {AdminReviewReassign} adminReviewReassign
|
|
@@ -25674,7 +27116,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25674
27116
|
*/
|
|
25675
27117
|
move(id: string, adminReviewReassign: AdminReviewReassign, axiosOptions?: any): AxiosPromise<CertificationTask>;
|
|
25676
27118
|
/**
|
|
25677
|
-
* 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.
|
|
25678
27120
|
* @summary Update a Campaign Template
|
|
25679
27121
|
* @param {string} id ID of the campaign template being modified.
|
|
25680
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)
|
|
@@ -25683,7 +27125,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25683
27125
|
*/
|
|
25684
27126
|
patchCampaignTemplate(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<CampaignTemplate>;
|
|
25685
27127
|
/**
|
|
25686
|
-
* 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.
|
|
25687
27129
|
* @summary Set Campaign Reports Configuration
|
|
25688
27130
|
* @param {CampaignReportsConfig} campaignReportsConfig Campaign report configuration.
|
|
25689
27131
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25691,7 +27133,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25691
27133
|
*/
|
|
25692
27134
|
setCampaignReportsConfig(campaignReportsConfig: CampaignReportsConfig, axiosOptions?: any): AxiosPromise<CampaignReportsConfig>;
|
|
25693
27135
|
/**
|
|
25694
|
-
* 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.
|
|
25695
27137
|
* @summary Set Campaign Template Schedule
|
|
25696
27138
|
* @param {string} id ID of the campaign template being scheduled.
|
|
25697
27139
|
* @param {Schedule} [schedule]
|
|
@@ -25700,7 +27142,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25700
27142
|
*/
|
|
25701
27143
|
setCampaignTemplateSchedule(id: string, schedule?: Schedule, axiosOptions?: any): AxiosPromise<void>;
|
|
25702
27144
|
/**
|
|
25703
|
-
* 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.
|
|
25704
27146
|
* @summary Activate a Campaign
|
|
25705
27147
|
* @param {string} id Campaign ID.
|
|
25706
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.
|
|
@@ -25709,7 +27151,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25709
27151
|
*/
|
|
25710
27152
|
startCampaign(id: string, activateCampaignOptions?: ActivateCampaignOptions, axiosOptions?: any): AxiosPromise<object>;
|
|
25711
27153
|
/**
|
|
25712
|
-
* 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.
|
|
25713
27155
|
* @summary Run Campaign Remediation Scan
|
|
25714
27156
|
* @param {string} id ID of the campaign the remediation scan is being run for.
|
|
25715
27157
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25717,7 +27159,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25717
27159
|
*/
|
|
25718
27160
|
startCampaignRemediationScan(id: string, axiosOptions?: any): AxiosPromise<object>;
|
|
25719
27161
|
/**
|
|
25720
|
-
* 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.
|
|
25721
27163
|
* @summary Run Campaign Report
|
|
25722
27164
|
* @param {string} id ID of the campaign the report is being run for.
|
|
25723
27165
|
* @param {ReportType} type Type of the report to run.
|
|
@@ -25726,7 +27168,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25726
27168
|
*/
|
|
25727
27169
|
startCampaignReport(id: string, type: ReportType, axiosOptions?: any): AxiosPromise<object>;
|
|
25728
27170
|
/**
|
|
25729
|
-
* 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.
|
|
25730
27172
|
* @summary Generate a Campaign from Template
|
|
25731
27173
|
* @param {string} id ID of the campaign template to use for generation.
|
|
25732
27174
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -25734,7 +27176,7 @@ export declare const CertificationCampaignsApiFactory: (configuration?: Configur
|
|
|
25734
27176
|
*/
|
|
25735
27177
|
startGenerateCampaignTemplate(id: string, axiosOptions?: any): AxiosPromise<CampaignReference>;
|
|
25736
27178
|
/**
|
|
25737
|
-
* 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.
|
|
25738
27180
|
* @summary Update a Campaign
|
|
25739
27181
|
* @param {string} id ID of the campaign template being modified.
|
|
25740
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
|
|
@@ -25882,6 +27324,12 @@ export interface CertificationCampaignsApiGetCampaignRequest {
|
|
|
25882
27324
|
* @memberof CertificationCampaignsApiGetCampaign
|
|
25883
27325
|
*/
|
|
25884
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';
|
|
25885
27333
|
}
|
|
25886
27334
|
/**
|
|
25887
27335
|
* Request parameters for getCampaignReports operation in CertificationCampaignsApi.
|
|
@@ -26120,7 +27568,7 @@ export interface CertificationCampaignsApiUpdateCampaignRequest {
|
|
|
26120
27568
|
*/
|
|
26121
27569
|
export declare class CertificationCampaignsApi extends BaseAPI {
|
|
26122
27570
|
/**
|
|
26123
|
-
* :::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.
|
|
26124
27572
|
* @summary Complete a Campaign
|
|
26125
27573
|
* @param {CertificationCampaignsApiCompleteCampaignRequest} requestParameters Request parameters.
|
|
26126
27574
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26129,7 +27577,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26129
27577
|
*/
|
|
26130
27578
|
completeCampaign(requestParameters: CertificationCampaignsApiCompleteCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26131
27579
|
/**
|
|
26132
|
-
* 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.
|
|
26133
27581
|
* @summary Create a campaign
|
|
26134
27582
|
* @param {CertificationCampaignsApiCreateCampaignRequest} requestParameters Request parameters.
|
|
26135
27583
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26138,7 +27586,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26138
27586
|
*/
|
|
26139
27587
|
createCampaign(requestParameters: CertificationCampaignsApiCreateCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Campaign, any>>;
|
|
26140
27588
|
/**
|
|
26141
|
-
* 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.
|
|
26142
27590
|
* @summary Create a Campaign Template
|
|
26143
27591
|
* @param {CertificationCampaignsApiCreateCampaignTemplateRequest} requestParameters Request parameters.
|
|
26144
27592
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26147,7 +27595,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26147
27595
|
*/
|
|
26148
27596
|
createCampaignTemplate(requestParameters: CertificationCampaignsApiCreateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26149
27597
|
/**
|
|
26150
|
-
* 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.
|
|
26151
27599
|
* @summary Delete a Campaign Template
|
|
26152
27600
|
* @param {CertificationCampaignsApiDeleteCampaignTemplateRequest} requestParameters Request parameters.
|
|
26153
27601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26156,7 +27604,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26156
27604
|
*/
|
|
26157
27605
|
deleteCampaignTemplate(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26158
27606
|
/**
|
|
26159
|
-
* 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.
|
|
26160
27608
|
* @summary Delete Campaign Template Schedule
|
|
26161
27609
|
* @param {CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26162
27610
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26165,7 +27613,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26165
27613
|
*/
|
|
26166
27614
|
deleteCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiDeleteCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26167
27615
|
/**
|
|
26168
|
-
* 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.
|
|
26169
27617
|
* @summary Delete Campaigns
|
|
26170
27618
|
* @param {CertificationCampaignsApiDeleteCampaignsRequest} requestParameters Request parameters.
|
|
26171
27619
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26174,7 +27622,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26174
27622
|
*/
|
|
26175
27623
|
deleteCampaigns(requestParameters: CertificationCampaignsApiDeleteCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26176
27624
|
/**
|
|
26177
|
-
* 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.
|
|
26178
27626
|
* @summary List Campaigns
|
|
26179
27627
|
* @param {CertificationCampaignsApiGetActiveCampaignsRequest} requestParameters Request parameters.
|
|
26180
27628
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26183,16 +27631,16 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26183
27631
|
*/
|
|
26184
27632
|
getActiveCampaigns(requestParameters?: CertificationCampaignsApiGetActiveCampaignsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInner[], any>>;
|
|
26185
27633
|
/**
|
|
26186
|
-
* 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.
|
|
26187
27635
|
* @summary Get Campaign
|
|
26188
27636
|
* @param {CertificationCampaignsApiGetCampaignRequest} requestParameters Request parameters.
|
|
26189
27637
|
* @param {*} [axiosOptions] Override http request option.
|
|
26190
27638
|
* @throws {RequiredError}
|
|
26191
27639
|
* @memberof CertificationCampaignsApi
|
|
26192
27640
|
*/
|
|
26193
|
-
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
27641
|
+
getCampaign(requestParameters: CertificationCampaignsApiGetCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetActiveCampaigns200ResponseInner, any>>;
|
|
26194
27642
|
/**
|
|
26195
|
-
* 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.
|
|
26196
27644
|
* @summary Get Campaign Reports
|
|
26197
27645
|
* @param {CertificationCampaignsApiGetCampaignReportsRequest} requestParameters Request parameters.
|
|
26198
27646
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26201,7 +27649,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26201
27649
|
*/
|
|
26202
27650
|
getCampaignReports(requestParameters: CertificationCampaignsApiGetCampaignReportsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReport[], any>>;
|
|
26203
27651
|
/**
|
|
26204
|
-
* 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.
|
|
26205
27653
|
* @summary Get Campaign Reports Configuration
|
|
26206
27654
|
* @param {*} [axiosOptions] Override http request option.
|
|
26207
27655
|
* @throws {RequiredError}
|
|
@@ -26209,7 +27657,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26209
27657
|
*/
|
|
26210
27658
|
getCampaignReportsConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
26211
27659
|
/**
|
|
26212
|
-
* 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.
|
|
26213
27661
|
* @summary Get a Campaign Template
|
|
26214
27662
|
* @param {CertificationCampaignsApiGetCampaignTemplateRequest} requestParameters Request parameters.
|
|
26215
27663
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26218,7 +27666,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26218
27666
|
*/
|
|
26219
27667
|
getCampaignTemplate(requestParameters: CertificationCampaignsApiGetCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26220
27668
|
/**
|
|
26221
|
-
* 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.
|
|
26222
27670
|
* @summary Get Campaign Template Schedule
|
|
26223
27671
|
* @param {CertificationCampaignsApiGetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26224
27672
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26227,7 +27675,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26227
27675
|
*/
|
|
26228
27676
|
getCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiGetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<Schedule, any>>;
|
|
26229
27677
|
/**
|
|
26230
|
-
* 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.
|
|
26231
27679
|
* @summary List Campaign Templates
|
|
26232
27680
|
* @param {CertificationCampaignsApiGetCampaignTemplatesRequest} requestParameters Request parameters.
|
|
26233
27681
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26236,7 +27684,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26236
27684
|
*/
|
|
26237
27685
|
getCampaignTemplates(requestParameters?: CertificationCampaignsApiGetCampaignTemplatesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate[], any>>;
|
|
26238
27686
|
/**
|
|
26239
|
-
* 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.
|
|
26240
27688
|
* @summary Reassign Certifications
|
|
26241
27689
|
* @param {CertificationCampaignsApiMoveRequest} requestParameters Request parameters.
|
|
26242
27690
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26245,7 +27693,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26245
27693
|
*/
|
|
26246
27694
|
move(requestParameters: CertificationCampaignsApiMoveRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CertificationTask, any>>;
|
|
26247
27695
|
/**
|
|
26248
|
-
* 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.
|
|
26249
27697
|
* @summary Update a Campaign Template
|
|
26250
27698
|
* @param {CertificationCampaignsApiPatchCampaignTemplateRequest} requestParameters Request parameters.
|
|
26251
27699
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26254,7 +27702,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26254
27702
|
*/
|
|
26255
27703
|
patchCampaignTemplate(requestParameters: CertificationCampaignsApiPatchCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignTemplate, any>>;
|
|
26256
27704
|
/**
|
|
26257
|
-
* 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.
|
|
26258
27706
|
* @summary Set Campaign Reports Configuration
|
|
26259
27707
|
* @param {CertificationCampaignsApiSetCampaignReportsConfigRequest} requestParameters Request parameters.
|
|
26260
27708
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26263,7 +27711,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26263
27711
|
*/
|
|
26264
27712
|
setCampaignReportsConfig(requestParameters: CertificationCampaignsApiSetCampaignReportsConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReportsConfig, any>>;
|
|
26265
27713
|
/**
|
|
26266
|
-
* 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.
|
|
26267
27715
|
* @summary Set Campaign Template Schedule
|
|
26268
27716
|
* @param {CertificationCampaignsApiSetCampaignTemplateScheduleRequest} requestParameters Request parameters.
|
|
26269
27717
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26272,7 +27720,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26272
27720
|
*/
|
|
26273
27721
|
setCampaignTemplateSchedule(requestParameters: CertificationCampaignsApiSetCampaignTemplateScheduleRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
26274
27722
|
/**
|
|
26275
|
-
* 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.
|
|
26276
27724
|
* @summary Activate a Campaign
|
|
26277
27725
|
* @param {CertificationCampaignsApiStartCampaignRequest} requestParameters Request parameters.
|
|
26278
27726
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26281,7 +27729,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26281
27729
|
*/
|
|
26282
27730
|
startCampaign(requestParameters: CertificationCampaignsApiStartCampaignRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26283
27731
|
/**
|
|
26284
|
-
* 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.
|
|
26285
27733
|
* @summary Run Campaign Remediation Scan
|
|
26286
27734
|
* @param {CertificationCampaignsApiStartCampaignRemediationScanRequest} requestParameters Request parameters.
|
|
26287
27735
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26290,7 +27738,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26290
27738
|
*/
|
|
26291
27739
|
startCampaignRemediationScan(requestParameters: CertificationCampaignsApiStartCampaignRemediationScanRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26292
27740
|
/**
|
|
26293
|
-
* 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.
|
|
26294
27742
|
* @summary Run Campaign Report
|
|
26295
27743
|
* @param {CertificationCampaignsApiStartCampaignReportRequest} requestParameters Request parameters.
|
|
26296
27744
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26299,7 +27747,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26299
27747
|
*/
|
|
26300
27748
|
startCampaignReport(requestParameters: CertificationCampaignsApiStartCampaignReportRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
|
|
26301
27749
|
/**
|
|
26302
|
-
* 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.
|
|
26303
27751
|
* @summary Generate a Campaign from Template
|
|
26304
27752
|
* @param {CertificationCampaignsApiStartGenerateCampaignTemplateRequest} requestParameters Request parameters.
|
|
26305
27753
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -26308,7 +27756,7 @@ export declare class CertificationCampaignsApi extends BaseAPI {
|
|
|
26308
27756
|
*/
|
|
26309
27757
|
startGenerateCampaignTemplate(requestParameters: CertificationCampaignsApiStartGenerateCampaignTemplateRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CampaignReference, any>>;
|
|
26310
27758
|
/**
|
|
26311
|
-
* 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.
|
|
26312
27760
|
* @summary Update a Campaign
|
|
26313
27761
|
* @param {CertificationCampaignsApiUpdateCampaignRequest} requestParameters Request parameters.
|
|
26314
27762
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -28635,6 +30083,13 @@ export declare const GlobalTenantSecuritySettingsApiAxiosParamCreator: (configur
|
|
|
28635
30083
|
* @throws {RequiredError}
|
|
28636
30084
|
*/
|
|
28637
30085
|
createAuthOrgNetworkConfig: (networkConfiguration: NetworkConfiguration, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30086
|
+
/**
|
|
30087
|
+
* This API returns the details of an org\'s lockout auth configuration.
|
|
30088
|
+
* @summary Get Auth Org Lockout Configuration.
|
|
30089
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30090
|
+
* @throws {RequiredError}
|
|
30091
|
+
*/
|
|
30092
|
+
getAuthOrgLockoutConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28638
30093
|
/**
|
|
28639
30094
|
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
28640
30095
|
* @summary Get security network configuration.
|
|
@@ -28642,6 +30097,28 @@ export declare const GlobalTenantSecuritySettingsApiAxiosParamCreator: (configur
|
|
|
28642
30097
|
* @throws {RequiredError}
|
|
28643
30098
|
*/
|
|
28644
30099
|
getAuthOrgNetworkConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30100
|
+
/**
|
|
30101
|
+
* This API returns the details of an org\'s service provider auth configuration.
|
|
30102
|
+
* @summary Get Service Provider Configuration.
|
|
30103
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30104
|
+
* @throws {RequiredError}
|
|
30105
|
+
*/
|
|
30106
|
+
getAuthOrgServiceProviderConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30107
|
+
/**
|
|
30108
|
+
* This API returns the details of an org\'s session auth configuration.
|
|
30109
|
+
* @summary Get Auth Org Session Configuration.
|
|
30110
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30111
|
+
* @throws {RequiredError}
|
|
30112
|
+
*/
|
|
30113
|
+
getAuthOrgSessionConfig: (axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30114
|
+
/**
|
|
30115
|
+
* This API updates an existing lockout configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
30116
|
+
* @summary Update Auth Org Lockout Configuration
|
|
30117
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: 1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60
|
|
30118
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30119
|
+
* @throws {RequiredError}
|
|
30120
|
+
*/
|
|
30121
|
+
patchAuthOrgLockoutConfig: (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28645
30122
|
/**
|
|
28646
30123
|
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
28647
30124
|
* @summary Update security network configuration.
|
|
@@ -28650,6 +30127,22 @@ export declare const GlobalTenantSecuritySettingsApiAxiosParamCreator: (configur
|
|
|
28650
30127
|
* @throws {RequiredError}
|
|
28651
30128
|
*/
|
|
28652
30129
|
patchAuthOrgNetworkConfig: (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30130
|
+
/**
|
|
30131
|
+
* This API updates an existing service provider configuration for an org using PATCH.
|
|
30132
|
+
* @summary Update Service Provider Configuration
|
|
30133
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
|
|
30134
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30135
|
+
* @throws {RequiredError}
|
|
30136
|
+
*/
|
|
30137
|
+
patchAuthOrgServiceProviderConfig: (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
30138
|
+
/**
|
|
30139
|
+
* This API updates an existing session configuration for an org using PATCH.
|
|
30140
|
+
* @summary Update Auth Org Session Configuration
|
|
30141
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: 1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.
|
|
30142
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30143
|
+
* @throws {RequiredError}
|
|
30144
|
+
*/
|
|
30145
|
+
patchAuthOrgSessionConfig: (jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28653
30146
|
};
|
|
28654
30147
|
/**
|
|
28655
30148
|
* GlobalTenantSecuritySettingsApi - functional programming interface
|
|
@@ -28664,6 +30157,13 @@ export declare const GlobalTenantSecuritySettingsApiFp: (configuration?: Configu
|
|
|
28664
30157
|
* @throws {RequiredError}
|
|
28665
30158
|
*/
|
|
28666
30159
|
createAuthOrgNetworkConfig(networkConfiguration: NetworkConfiguration, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
30160
|
+
/**
|
|
30161
|
+
* This API returns the details of an org\'s lockout auth configuration.
|
|
30162
|
+
* @summary Get Auth Org Lockout Configuration.
|
|
30163
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30164
|
+
* @throws {RequiredError}
|
|
30165
|
+
*/
|
|
30166
|
+
getAuthOrgLockoutConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LockoutConfiguration>>;
|
|
28667
30167
|
/**
|
|
28668
30168
|
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
28669
30169
|
* @summary Get security network configuration.
|
|
@@ -28671,6 +30171,28 @@ export declare const GlobalTenantSecuritySettingsApiFp: (configuration?: Configu
|
|
|
28671
30171
|
* @throws {RequiredError}
|
|
28672
30172
|
*/
|
|
28673
30173
|
getAuthOrgNetworkConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
30174
|
+
/**
|
|
30175
|
+
* This API returns the details of an org\'s service provider auth configuration.
|
|
30176
|
+
* @summary Get Service Provider Configuration.
|
|
30177
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30178
|
+
* @throws {RequiredError}
|
|
30179
|
+
*/
|
|
30180
|
+
getAuthOrgServiceProviderConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceProviderConfiguration>>;
|
|
30181
|
+
/**
|
|
30182
|
+
* This API returns the details of an org\'s session auth configuration.
|
|
30183
|
+
* @summary Get Auth Org Session Configuration.
|
|
30184
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30185
|
+
* @throws {RequiredError}
|
|
30186
|
+
*/
|
|
30187
|
+
getAuthOrgSessionConfig(axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionConfiguration>>;
|
|
30188
|
+
/**
|
|
30189
|
+
* This API updates an existing lockout configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
30190
|
+
* @summary Update Auth Org Lockout Configuration
|
|
30191
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: 1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60
|
|
30192
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30193
|
+
* @throws {RequiredError}
|
|
30194
|
+
*/
|
|
30195
|
+
patchAuthOrgLockoutConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LockoutConfiguration>>;
|
|
28674
30196
|
/**
|
|
28675
30197
|
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
28676
30198
|
* @summary Update security network configuration.
|
|
@@ -28679,6 +30201,22 @@ export declare const GlobalTenantSecuritySettingsApiFp: (configuration?: Configu
|
|
|
28679
30201
|
* @throws {RequiredError}
|
|
28680
30202
|
*/
|
|
28681
30203
|
patchAuthOrgNetworkConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<NetworkConfiguration>>;
|
|
30204
|
+
/**
|
|
30205
|
+
* This API updates an existing service provider configuration for an org using PATCH.
|
|
30206
|
+
* @summary Update Service Provider Configuration
|
|
30207
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
|
|
30208
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30209
|
+
* @throws {RequiredError}
|
|
30210
|
+
*/
|
|
30211
|
+
patchAuthOrgServiceProviderConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ServiceProviderConfiguration>>;
|
|
30212
|
+
/**
|
|
30213
|
+
* This API updates an existing session configuration for an org using PATCH.
|
|
30214
|
+
* @summary Update Auth Org Session Configuration
|
|
30215
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: 1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.
|
|
30216
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30217
|
+
* @throws {RequiredError}
|
|
30218
|
+
*/
|
|
30219
|
+
patchAuthOrgSessionConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SessionConfiguration>>;
|
|
28682
30220
|
};
|
|
28683
30221
|
/**
|
|
28684
30222
|
* GlobalTenantSecuritySettingsApi - factory interface
|
|
@@ -28693,6 +30231,13 @@ export declare const GlobalTenantSecuritySettingsApiFactory: (configuration?: Co
|
|
|
28693
30231
|
* @throws {RequiredError}
|
|
28694
30232
|
*/
|
|
28695
30233
|
createAuthOrgNetworkConfig(networkConfiguration: NetworkConfiguration, axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
30234
|
+
/**
|
|
30235
|
+
* This API returns the details of an org\'s lockout auth configuration.
|
|
30236
|
+
* @summary Get Auth Org Lockout Configuration.
|
|
30237
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30238
|
+
* @throws {RequiredError}
|
|
30239
|
+
*/
|
|
30240
|
+
getAuthOrgLockoutConfig(axiosOptions?: any): AxiosPromise<LockoutConfiguration>;
|
|
28696
30241
|
/**
|
|
28697
30242
|
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
28698
30243
|
* @summary Get security network configuration.
|
|
@@ -28700,6 +30245,28 @@ export declare const GlobalTenantSecuritySettingsApiFactory: (configuration?: Co
|
|
|
28700
30245
|
* @throws {RequiredError}
|
|
28701
30246
|
*/
|
|
28702
30247
|
getAuthOrgNetworkConfig(axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
30248
|
+
/**
|
|
30249
|
+
* This API returns the details of an org\'s service provider auth configuration.
|
|
30250
|
+
* @summary Get Service Provider Configuration.
|
|
30251
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30252
|
+
* @throws {RequiredError}
|
|
30253
|
+
*/
|
|
30254
|
+
getAuthOrgServiceProviderConfig(axiosOptions?: any): AxiosPromise<ServiceProviderConfiguration>;
|
|
30255
|
+
/**
|
|
30256
|
+
* This API returns the details of an org\'s session auth configuration.
|
|
30257
|
+
* @summary Get Auth Org Session Configuration.
|
|
30258
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30259
|
+
* @throws {RequiredError}
|
|
30260
|
+
*/
|
|
30261
|
+
getAuthOrgSessionConfig(axiosOptions?: any): AxiosPromise<SessionConfiguration>;
|
|
30262
|
+
/**
|
|
30263
|
+
* This API updates an existing lockout configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
30264
|
+
* @summary Update Auth Org Lockout Configuration
|
|
30265
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: 1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60
|
|
30266
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30267
|
+
* @throws {RequiredError}
|
|
30268
|
+
*/
|
|
30269
|
+
patchAuthOrgLockoutConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<LockoutConfiguration>;
|
|
28703
30270
|
/**
|
|
28704
30271
|
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
28705
30272
|
* @summary Update security network configuration.
|
|
@@ -28708,6 +30275,22 @@ export declare const GlobalTenantSecuritySettingsApiFactory: (configuration?: Co
|
|
|
28708
30275
|
* @throws {RequiredError}
|
|
28709
30276
|
*/
|
|
28710
30277
|
patchAuthOrgNetworkConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<NetworkConfiguration>;
|
|
30278
|
+
/**
|
|
30279
|
+
* This API updates an existing service provider configuration for an org using PATCH.
|
|
30280
|
+
* @summary Update Service Provider Configuration
|
|
30281
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
|
|
30282
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30283
|
+
* @throws {RequiredError}
|
|
30284
|
+
*/
|
|
30285
|
+
patchAuthOrgServiceProviderConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<ServiceProviderConfiguration>;
|
|
30286
|
+
/**
|
|
30287
|
+
* This API updates an existing session configuration for an org using PATCH.
|
|
30288
|
+
* @summary Update Auth Org Session Configuration
|
|
30289
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: 1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.
|
|
30290
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30291
|
+
* @throws {RequiredError}
|
|
30292
|
+
*/
|
|
30293
|
+
patchAuthOrgSessionConfig(jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: any): AxiosPromise<SessionConfiguration>;
|
|
28711
30294
|
};
|
|
28712
30295
|
/**
|
|
28713
30296
|
* Request parameters for createAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi.
|
|
@@ -28722,6 +30305,19 @@ export interface GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigReques
|
|
|
28722
30305
|
*/
|
|
28723
30306
|
readonly networkConfiguration: NetworkConfiguration;
|
|
28724
30307
|
}
|
|
30308
|
+
/**
|
|
30309
|
+
* Request parameters for patchAuthOrgLockoutConfig operation in GlobalTenantSecuritySettingsApi.
|
|
30310
|
+
* @export
|
|
30311
|
+
* @interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest
|
|
30312
|
+
*/
|
|
30313
|
+
export interface GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest {
|
|
30314
|
+
/**
|
|
30315
|
+
* A list of auth org lockout configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Lockout Config conforms to certain logical guidelines, which are: 1. maximumAttempts >= 1 && maximumAttempts <= 15 2. lockoutDuration >= 5 && lockoutDuration <= 60 3. lockoutWindow >= 5 && lockoutDuration <= 60
|
|
30316
|
+
* @type {Array<JsonPatchOperation>}
|
|
30317
|
+
* @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfig
|
|
30318
|
+
*/
|
|
30319
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
30320
|
+
}
|
|
28725
30321
|
/**
|
|
28726
30322
|
* Request parameters for patchAuthOrgNetworkConfig operation in GlobalTenantSecuritySettingsApi.
|
|
28727
30323
|
* @export
|
|
@@ -28735,6 +30331,32 @@ export interface GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest
|
|
|
28735
30331
|
*/
|
|
28736
30332
|
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
28737
30333
|
}
|
|
30334
|
+
/**
|
|
30335
|
+
* Request parameters for patchAuthOrgServiceProviderConfig operation in GlobalTenantSecuritySettingsApi.
|
|
30336
|
+
* @export
|
|
30337
|
+
* @interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest
|
|
30338
|
+
*/
|
|
30339
|
+
export interface GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest {
|
|
30340
|
+
/**
|
|
30341
|
+
* A list of auth org service provider configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Note: /federationProtocolDetails/0 is IdpDetails /federationProtocolDetails/1 is SpDetails Ensures that the patched ServiceProviderConfig conforms to certain logical guidelines, which are: 1. Do not add or remove any elements in the federation protocol details in the service provider configuration. 2. Do not modify, add, or delete the service provider details element in the federation protocol details. 3. If this is the first time the patched ServiceProviderConfig enables Remote IDP sign-in, it must also include IDPDetails. 4. If the patch enables Remote IDP sign in, the entityID in the IDPDetails cannot be null. IDPDetails must include an entityID. 5. Any JIT configuration update must be valid. Just in time configuration update must be valid when enabled. This includes: - A Source ID - Source attribute mappings - Source attribute maps have all the required key values (firstName, lastName, email)
|
|
30342
|
+
* @type {Array<JsonPatchOperation>}
|
|
30343
|
+
* @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfig
|
|
30344
|
+
*/
|
|
30345
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
30346
|
+
}
|
|
30347
|
+
/**
|
|
30348
|
+
* Request parameters for patchAuthOrgSessionConfig operation in GlobalTenantSecuritySettingsApi.
|
|
30349
|
+
* @export
|
|
30350
|
+
* @interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest
|
|
30351
|
+
*/
|
|
30352
|
+
export interface GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest {
|
|
30353
|
+
/**
|
|
30354
|
+
* A list of auth org session configuration update operations according to the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. Ensures that the patched Session Config conforms to certain logical guidelines, which are: 1. maxSessionTime >= 1 && maxSessionTime <= 10080 (1 week) 2. maxIdleTime >= 1 && maxIdleTime <= 1440 (1 day) 3. maxSessionTime must have a greater duration than maxIdleTime.
|
|
30355
|
+
* @type {Array<JsonPatchOperation>}
|
|
30356
|
+
* @memberof GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfig
|
|
30357
|
+
*/
|
|
30358
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
30359
|
+
}
|
|
28738
30360
|
/**
|
|
28739
30361
|
* GlobalTenantSecuritySettingsApi - object-oriented interface
|
|
28740
30362
|
* @export
|
|
@@ -28751,6 +30373,14 @@ export declare class GlobalTenantSecuritySettingsApi extends BaseAPI {
|
|
|
28751
30373
|
* @memberof GlobalTenantSecuritySettingsApi
|
|
28752
30374
|
*/
|
|
28753
30375
|
createAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiCreateAuthOrgNetworkConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
30376
|
+
/**
|
|
30377
|
+
* This API returns the details of an org\'s lockout auth configuration.
|
|
30378
|
+
* @summary Get Auth Org Lockout Configuration.
|
|
30379
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30380
|
+
* @throws {RequiredError}
|
|
30381
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30382
|
+
*/
|
|
30383
|
+
getAuthOrgLockoutConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LockoutConfiguration, any>>;
|
|
28754
30384
|
/**
|
|
28755
30385
|
* This API returns the details of an org\'s network auth configuration. Requires security scope of: \'sp:auth-org:read\'
|
|
28756
30386
|
* @summary Get security network configuration.
|
|
@@ -28759,6 +30389,31 @@ export declare class GlobalTenantSecuritySettingsApi extends BaseAPI {
|
|
|
28759
30389
|
* @memberof GlobalTenantSecuritySettingsApi
|
|
28760
30390
|
*/
|
|
28761
30391
|
getAuthOrgNetworkConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
30392
|
+
/**
|
|
30393
|
+
* This API returns the details of an org\'s service provider auth configuration.
|
|
30394
|
+
* @summary Get Service Provider Configuration.
|
|
30395
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30396
|
+
* @throws {RequiredError}
|
|
30397
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30398
|
+
*/
|
|
30399
|
+
getAuthOrgServiceProviderConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceProviderConfiguration, any>>;
|
|
30400
|
+
/**
|
|
30401
|
+
* This API returns the details of an org\'s session auth configuration.
|
|
30402
|
+
* @summary Get Auth Org Session Configuration.
|
|
30403
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30404
|
+
* @throws {RequiredError}
|
|
30405
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30406
|
+
*/
|
|
30407
|
+
getAuthOrgSessionConfig(axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SessionConfiguration, any>>;
|
|
30408
|
+
/**
|
|
30409
|
+
* This API updates an existing lockout configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
30410
|
+
* @summary Update Auth Org Lockout Configuration
|
|
30411
|
+
* @param {GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest} requestParameters Request parameters.
|
|
30412
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30413
|
+
* @throws {RequiredError}
|
|
30414
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30415
|
+
*/
|
|
30416
|
+
patchAuthOrgLockoutConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgLockoutConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LockoutConfiguration, any>>;
|
|
28762
30417
|
/**
|
|
28763
30418
|
* This API updates an existing network configuration for an org using PATCH Requires security scope of: \'sp:auth-org:update\'
|
|
28764
30419
|
* @summary Update security network configuration.
|
|
@@ -28768,12 +30423,38 @@ export declare class GlobalTenantSecuritySettingsApi extends BaseAPI {
|
|
|
28768
30423
|
* @memberof GlobalTenantSecuritySettingsApi
|
|
28769
30424
|
*/
|
|
28770
30425
|
patchAuthOrgNetworkConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgNetworkConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<NetworkConfiguration, any>>;
|
|
30426
|
+
/**
|
|
30427
|
+
* This API updates an existing service provider configuration for an org using PATCH.
|
|
30428
|
+
* @summary Update Service Provider Configuration
|
|
30429
|
+
* @param {GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest} requestParameters Request parameters.
|
|
30430
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30431
|
+
* @throws {RequiredError}
|
|
30432
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30433
|
+
*/
|
|
30434
|
+
patchAuthOrgServiceProviderConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgServiceProviderConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ServiceProviderConfiguration, any>>;
|
|
30435
|
+
/**
|
|
30436
|
+
* This API updates an existing session configuration for an org using PATCH.
|
|
30437
|
+
* @summary Update Auth Org Session Configuration
|
|
30438
|
+
* @param {GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest} requestParameters Request parameters.
|
|
30439
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
30440
|
+
* @throws {RequiredError}
|
|
30441
|
+
* @memberof GlobalTenantSecuritySettingsApi
|
|
30442
|
+
*/
|
|
30443
|
+
patchAuthOrgSessionConfig(requestParameters: GlobalTenantSecuritySettingsApiPatchAuthOrgSessionConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SessionConfiguration, any>>;
|
|
28771
30444
|
}
|
|
28772
30445
|
/**
|
|
28773
30446
|
* IdentityProfilesApi - axios parameter creator
|
|
28774
30447
|
* @export
|
|
28775
30448
|
*/
|
|
28776
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>;
|
|
28777
30458
|
/**
|
|
28778
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
|
|
28779
30460
|
* @summary Delete an Identity Profile
|
|
@@ -28811,7 +30492,7 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
28811
30492
|
*/
|
|
28812
30493
|
getDefaultIdentityAttributeConfig: (identityProfileId: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
28813
30494
|
/**
|
|
28814
|
-
* 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.
|
|
28815
30496
|
* @summary Get single Identity Profile
|
|
28816
30497
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
28817
30498
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -28838,6 +30519,14 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
28838
30519
|
* @throws {RequiredError}
|
|
28839
30520
|
*/
|
|
28840
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>;
|
|
28841
30530
|
/**
|
|
28842
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.
|
|
28843
30532
|
* @summary Process identities under profile
|
|
@@ -28846,12 +30535,29 @@ export declare const IdentityProfilesApiAxiosParamCreator: (configuration?: Conf
|
|
|
28846
30535
|
* @throws {RequiredError}
|
|
28847
30536
|
*/
|
|
28848
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>;
|
|
28849
30547
|
};
|
|
28850
30548
|
/**
|
|
28851
30549
|
* IdentityProfilesApi - functional programming interface
|
|
28852
30550
|
* @export
|
|
28853
30551
|
*/
|
|
28854
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>>;
|
|
28855
30561
|
/**
|
|
28856
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
|
|
28857
30563
|
* @summary Delete an Identity Profile
|
|
@@ -28889,7 +30595,7 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
28889
30595
|
*/
|
|
28890
30596
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityAttributeConfig>>;
|
|
28891
30597
|
/**
|
|
28892
|
-
* 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.
|
|
28893
30599
|
* @summary Get single Identity Profile
|
|
28894
30600
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
28895
30601
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -28916,6 +30622,14 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
28916
30622
|
* @throws {RequiredError}
|
|
28917
30623
|
*/
|
|
28918
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>>;
|
|
28919
30633
|
/**
|
|
28920
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.
|
|
28921
30635
|
* @summary Process identities under profile
|
|
@@ -28924,12 +30638,29 @@ export declare const IdentityProfilesApiFp: (configuration?: Configuration) => {
|
|
|
28924
30638
|
* @throws {RequiredError}
|
|
28925
30639
|
*/
|
|
28926
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>>;
|
|
28927
30650
|
};
|
|
28928
30651
|
/**
|
|
28929
30652
|
* IdentityProfilesApi - factory interface
|
|
28930
30653
|
* @export
|
|
28931
30654
|
*/
|
|
28932
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>;
|
|
28933
30664
|
/**
|
|
28934
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
|
|
28935
30666
|
* @summary Delete an Identity Profile
|
|
@@ -28967,7 +30698,7 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
28967
30698
|
*/
|
|
28968
30699
|
getDefaultIdentityAttributeConfig(identityProfileId: string, axiosOptions?: any): AxiosPromise<IdentityAttributeConfig>;
|
|
28969
30700
|
/**
|
|
28970
|
-
* 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.
|
|
28971
30702
|
* @summary Get single Identity Profile
|
|
28972
30703
|
* @param {string} identityProfileId The Identity Profile ID.
|
|
28973
30704
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -28994,6 +30725,14 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
28994
30725
|
* @throws {RequiredError}
|
|
28995
30726
|
*/
|
|
28996
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>;
|
|
28997
30736
|
/**
|
|
28998
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.
|
|
28999
30738
|
* @summary Process identities under profile
|
|
@@ -29002,7 +30741,29 @@ export declare const IdentityProfilesApiFactory: (configuration?: Configuration,
|
|
|
29002
30741
|
* @throws {RequiredError}
|
|
29003
30742
|
*/
|
|
29004
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>;
|
|
29005
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
|
+
}
|
|
29006
30767
|
/**
|
|
29007
30768
|
* Request parameters for deleteIdentityProfile operation in IdentityProfilesApi.
|
|
29008
30769
|
* @export
|
|
@@ -29142,6 +30903,19 @@ export interface IdentityProfilesApiListIdentityProfilesRequest {
|
|
|
29142
30903
|
*/
|
|
29143
30904
|
readonly sorters?: string;
|
|
29144
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
|
+
}
|
|
29145
30919
|
/**
|
|
29146
30920
|
* Request parameters for syncIdentityProfile operation in IdentityProfilesApi.
|
|
29147
30921
|
* @export
|
|
@@ -29155,6 +30929,25 @@ export interface IdentityProfilesApiSyncIdentityProfileRequest {
|
|
|
29155
30929
|
*/
|
|
29156
30930
|
readonly identityProfileId: string;
|
|
29157
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
|
+
}
|
|
29158
30951
|
/**
|
|
29159
30952
|
* IdentityProfilesApi - object-oriented interface
|
|
29160
30953
|
* @export
|
|
@@ -29162,6 +30955,15 @@ export interface IdentityProfilesApiSyncIdentityProfileRequest {
|
|
|
29162
30955
|
* @extends {BaseAPI}
|
|
29163
30956
|
*/
|
|
29164
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>>;
|
|
29165
30967
|
/**
|
|
29166
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
|
|
29167
30969
|
* @summary Delete an Identity Profile
|
|
@@ -29199,7 +31001,7 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29199
31001
|
*/
|
|
29200
31002
|
getDefaultIdentityAttributeConfig(requestParameters: IdentityProfilesApiGetDefaultIdentityAttributeConfigRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityAttributeConfig, any>>;
|
|
29201
31003
|
/**
|
|
29202
|
-
* 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.
|
|
29203
31005
|
* @summary Get single Identity Profile
|
|
29204
31006
|
* @param {IdentityProfilesApiGetIdentityProfileRequest} requestParameters Request parameters.
|
|
29205
31007
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -29225,6 +31027,15 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29225
31027
|
* @memberof IdentityProfilesApi
|
|
29226
31028
|
*/
|
|
29227
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>>;
|
|
29228
31039
|
/**
|
|
29229
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.
|
|
29230
31041
|
* @summary Process identities under profile
|
|
@@ -29234,6 +31045,15 @@ export declare class IdentityProfilesApi extends BaseAPI {
|
|
|
29234
31045
|
* @memberof IdentityProfilesApi
|
|
29235
31046
|
*/
|
|
29236
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>>;
|
|
29237
31057
|
}
|
|
29238
31058
|
/**
|
|
29239
31059
|
* LifecycleStatesApi - axios parameter creator
|
|
@@ -29280,9 +31100,9 @@ export declare const LifecycleStatesApiAxiosParamCreator: (configuration?: Confi
|
|
|
29280
31100
|
*/
|
|
29281
31101
|
getLifecycleStates: (identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
29282
31102
|
/**
|
|
29283
|
-
* Use this
|
|
31103
|
+
* Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. A token with ORG_ADMIN or API authority and the appropriate user context is required to call this API.
|
|
29284
31104
|
* @summary Set Lifecycle State
|
|
29285
|
-
* @param {string} identityId
|
|
31105
|
+
* @param {string} identityId ID of the identity to update.
|
|
29286
31106
|
* @param {SetLifecycleStateRequest} setLifecycleStateRequest
|
|
29287
31107
|
* @param {*} [axiosOptions] Override http request option.
|
|
29288
31108
|
* @throws {RequiredError}
|
|
@@ -29344,9 +31164,9 @@ export declare const LifecycleStatesApiFp: (configuration?: Configuration) => {
|
|
|
29344
31164
|
*/
|
|
29345
31165
|
getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<LifecycleState>>>;
|
|
29346
31166
|
/**
|
|
29347
|
-
* Use this
|
|
31167
|
+
* Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. A token with ORG_ADMIN or API authority and the appropriate user context is required to call this API.
|
|
29348
31168
|
* @summary Set Lifecycle State
|
|
29349
|
-
* @param {string} identityId
|
|
31169
|
+
* @param {string} identityId ID of the identity to update.
|
|
29350
31170
|
* @param {SetLifecycleStateRequest} setLifecycleStateRequest
|
|
29351
31171
|
* @param {*} [axiosOptions] Override http request option.
|
|
29352
31172
|
* @throws {RequiredError}
|
|
@@ -29408,9 +31228,9 @@ export declare const LifecycleStatesApiFactory: (configuration?: Configuration,
|
|
|
29408
31228
|
*/
|
|
29409
31229
|
getLifecycleStates(identityProfileId: string, limit?: number, offset?: number, count?: boolean, sorters?: string, axiosOptions?: any): AxiosPromise<Array<LifecycleState>>;
|
|
29410
31230
|
/**
|
|
29411
|
-
* Use this
|
|
31231
|
+
* Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. A token with ORG_ADMIN or API authority and the appropriate user context is required to call this API.
|
|
29412
31232
|
* @summary Set Lifecycle State
|
|
29413
|
-
* @param {string} identityId
|
|
31233
|
+
* @param {string} identityId ID of the identity to update.
|
|
29414
31234
|
* @param {SetLifecycleStateRequest} setLifecycleStateRequest
|
|
29415
31235
|
* @param {*} [axiosOptions] Override http request option.
|
|
29416
31236
|
* @throws {RequiredError}
|
|
@@ -29528,7 +31348,7 @@ export interface LifecycleStatesApiGetLifecycleStatesRequest {
|
|
|
29528
31348
|
*/
|
|
29529
31349
|
export interface LifecycleStatesApiSetLifecycleStateRequest {
|
|
29530
31350
|
/**
|
|
29531
|
-
*
|
|
31351
|
+
* ID of the identity to update.
|
|
29532
31352
|
* @type {string}
|
|
29533
31353
|
* @memberof LifecycleStatesApiSetLifecycleState
|
|
29534
31354
|
*/
|
|
@@ -29609,7 +31429,7 @@ export declare class LifecycleStatesApi extends BaseAPI {
|
|
|
29609
31429
|
*/
|
|
29610
31430
|
getLifecycleStates(requestParameters: LifecycleStatesApiGetLifecycleStatesRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LifecycleState[], any>>;
|
|
29611
31431
|
/**
|
|
29612
|
-
* Use this
|
|
31432
|
+
* Use this API to set/update an identity\'s lifecycle state to the one provided and update the corresponding identity profile. A token with ORG_ADMIN or API authority and the appropriate user context is required to call this API.
|
|
29613
31433
|
* @summary Set Lifecycle State
|
|
29614
31434
|
* @param {LifecycleStatesApiSetLifecycleStateRequest} requestParameters Request parameters.
|
|
29615
31435
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -33997,7 +35817,7 @@ export declare const PersonalAccessTokensApiAxiosParamCreator: (configuration?:
|
|
|
33997
35817
|
*/
|
|
33998
35818
|
listPersonalAccessTokens: (ownerId?: string, filters?: string, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33999
35819
|
/**
|
|
34000
|
-
* 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.
|
|
34001
35821
|
* @summary Patch Personal Access Token
|
|
34002
35822
|
* @param {string} id The Personal Access Token id
|
|
34003
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
|
|
@@ -34037,7 +35857,7 @@ export declare const PersonalAccessTokensApiFp: (configuration?: Configuration)
|
|
|
34037
35857
|
*/
|
|
34038
35858
|
listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<GetPersonalAccessTokenResponse>>>;
|
|
34039
35859
|
/**
|
|
34040
|
-
* 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.
|
|
34041
35861
|
* @summary Patch Personal Access Token
|
|
34042
35862
|
* @param {string} id The Personal Access Token id
|
|
34043
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
|
|
@@ -34077,7 +35897,7 @@ export declare const PersonalAccessTokensApiFactory: (configuration?: Configurat
|
|
|
34077
35897
|
*/
|
|
34078
35898
|
listPersonalAccessTokens(ownerId?: string, filters?: string, axiosOptions?: any): AxiosPromise<Array<GetPersonalAccessTokenResponse>>;
|
|
34079
35899
|
/**
|
|
34080
|
-
* 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.
|
|
34081
35901
|
* @summary Patch Personal Access Token
|
|
34082
35902
|
* @param {string} id The Personal Access Token id
|
|
34083
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
|
|
@@ -34185,7 +36005,7 @@ export declare class PersonalAccessTokensApi extends BaseAPI {
|
|
|
34185
36005
|
*/
|
|
34186
36006
|
listPersonalAccessTokens(requestParameters?: PersonalAccessTokensApiListPersonalAccessTokensRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetPersonalAccessTokenResponse[], any>>;
|
|
34187
36007
|
/**
|
|
34188
|
-
* 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.
|
|
34189
36009
|
* @summary Patch Personal Access Token
|
|
34190
36010
|
* @param {PersonalAccessTokensApiPatchPersonalAccessTokenRequest} requestParameters Request parameters.
|
|
34191
36011
|
* @param {*} [axiosOptions] Override http request option.
|
|
@@ -37224,6 +39044,254 @@ export declare class SearchApi extends BaseAPI {
|
|
|
37224
39044
|
*/
|
|
37225
39045
|
searchPost(requestParameters: SearchApiSearchPostRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SearchDocument[], any>>;
|
|
37226
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
|
+
}
|
|
37227
39295
|
/**
|
|
37228
39296
|
* SegmentsApi - axios parameter creator
|
|
37229
39297
|
* @export
|
|
@@ -39621,11 +41689,11 @@ export declare const TaggedObjectsApiAxiosParamCreator: (configuration?: Configu
|
|
|
39621
41689
|
/**
|
|
39622
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.
|
|
39623
41691
|
* @summary Remove Tags from Multiple Objects
|
|
39624
|
-
* @param {
|
|
41692
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39625
41693
|
* @param {*} [axiosOptions] Override http request option.
|
|
39626
41694
|
* @throws {RequiredError}
|
|
39627
41695
|
*/
|
|
39628
|
-
deleteTagsToManyObject: (
|
|
41696
|
+
deleteTagsToManyObject: (bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39629
41697
|
/**
|
|
39630
41698
|
* This gets a tagged object for the specified type.
|
|
39631
41699
|
* @summary Get Tagged Object
|
|
@@ -39679,11 +41747,11 @@ export declare const TaggedObjectsApiAxiosParamCreator: (configuration?: Configu
|
|
|
39679
41747
|
/**
|
|
39680
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.
|
|
39681
41749
|
* @summary Tag Multiple Objects
|
|
39682
|
-
* @param {
|
|
41750
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39683
41751
|
* @param {*} [axiosOptions] Override http request option.
|
|
39684
41752
|
* @throws {RequiredError}
|
|
39685
41753
|
*/
|
|
39686
|
-
setTagsToManyObjects: (
|
|
41754
|
+
setTagsToManyObjects: (bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
39687
41755
|
};
|
|
39688
41756
|
/**
|
|
39689
41757
|
* TaggedObjectsApi - functional programming interface
|
|
@@ -39702,11 +41770,11 @@ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => {
|
|
|
39702
41770
|
/**
|
|
39703
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.
|
|
39704
41772
|
* @summary Remove Tags from Multiple Objects
|
|
39705
|
-
* @param {
|
|
41773
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39706
41774
|
* @param {*} [axiosOptions] Override http request option.
|
|
39707
41775
|
* @throws {RequiredError}
|
|
39708
41776
|
*/
|
|
39709
|
-
deleteTagsToManyObject(
|
|
41777
|
+
deleteTagsToManyObject(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
39710
41778
|
/**
|
|
39711
41779
|
* This gets a tagged object for the specified type.
|
|
39712
41780
|
* @summary Get Tagged Object
|
|
@@ -39760,11 +41828,11 @@ export declare const TaggedObjectsApiFp: (configuration?: Configuration) => {
|
|
|
39760
41828
|
/**
|
|
39761
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.
|
|
39762
41830
|
* @summary Tag Multiple Objects
|
|
39763
|
-
* @param {
|
|
41831
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39764
41832
|
* @param {*} [axiosOptions] Override http request option.
|
|
39765
41833
|
* @throws {RequiredError}
|
|
39766
41834
|
*/
|
|
39767
|
-
setTagsToManyObjects(
|
|
41835
|
+
setTagsToManyObjects(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<BulkTaggedObjectResponse>>>;
|
|
39768
41836
|
};
|
|
39769
41837
|
/**
|
|
39770
41838
|
* TaggedObjectsApi - factory interface
|
|
@@ -39783,11 +41851,11 @@ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, ba
|
|
|
39783
41851
|
/**
|
|
39784
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.
|
|
39785
41853
|
* @summary Remove Tags from Multiple Objects
|
|
39786
|
-
* @param {
|
|
41854
|
+
* @param {BulkRemoveTaggedObject} bulkRemoveTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39787
41855
|
* @param {*} [axiosOptions] Override http request option.
|
|
39788
41856
|
* @throws {RequiredError}
|
|
39789
41857
|
*/
|
|
39790
|
-
deleteTagsToManyObject(
|
|
41858
|
+
deleteTagsToManyObject(bulkRemoveTaggedObject: BulkRemoveTaggedObject, axiosOptions?: any): AxiosPromise<void>;
|
|
39791
41859
|
/**
|
|
39792
41860
|
* This gets a tagged object for the specified type.
|
|
39793
41861
|
* @summary Get Tagged Object
|
|
@@ -39841,11 +41909,11 @@ export declare const TaggedObjectsApiFactory: (configuration?: Configuration, ba
|
|
|
39841
41909
|
/**
|
|
39842
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.
|
|
39843
41911
|
* @summary Tag Multiple Objects
|
|
39844
|
-
* @param {
|
|
41912
|
+
* @param {BulkAddTaggedObject} bulkAddTaggedObject Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39845
41913
|
* @param {*} [axiosOptions] Override http request option.
|
|
39846
41914
|
* @throws {RequiredError}
|
|
39847
41915
|
*/
|
|
39848
|
-
setTagsToManyObjects(
|
|
41916
|
+
setTagsToManyObjects(bulkAddTaggedObject: BulkAddTaggedObject, axiosOptions?: any): AxiosPromise<Array<BulkTaggedObjectResponse>>;
|
|
39849
41917
|
};
|
|
39850
41918
|
/**
|
|
39851
41919
|
* Request parameters for deleteTaggedObject operation in TaggedObjectsApi.
|
|
@@ -39874,10 +41942,10 @@ export interface TaggedObjectsApiDeleteTaggedObjectRequest {
|
|
|
39874
41942
|
export interface TaggedObjectsApiDeleteTagsToManyObjectRequest {
|
|
39875
41943
|
/**
|
|
39876
41944
|
* Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
39877
|
-
* @type {
|
|
41945
|
+
* @type {BulkRemoveTaggedObject}
|
|
39878
41946
|
* @memberof TaggedObjectsApiDeleteTagsToManyObject
|
|
39879
41947
|
*/
|
|
39880
|
-
readonly
|
|
41948
|
+
readonly bulkRemoveTaggedObject: BulkRemoveTaggedObject;
|
|
39881
41949
|
}
|
|
39882
41950
|
/**
|
|
39883
41951
|
* Request parameters for getTaggedObject operation in TaggedObjectsApi.
|
|
@@ -40012,10 +42080,10 @@ export interface TaggedObjectsApiSetTagToObjectRequest {
|
|
|
40012
42080
|
export interface TaggedObjectsApiSetTagsToManyObjectsRequest {
|
|
40013
42081
|
/**
|
|
40014
42082
|
* Supported object types are ACCESS_PROFILE, APPLICATION, CAMPAIGN, ENTITLEMENT, IDENTITY, ROLE, SOD_POLICY, SOURCE.
|
|
40015
|
-
* @type {
|
|
42083
|
+
* @type {BulkAddTaggedObject}
|
|
40016
42084
|
* @memberof TaggedObjectsApiSetTagsToManyObjects
|
|
40017
42085
|
*/
|
|
40018
|
-
readonly
|
|
42086
|
+
readonly bulkAddTaggedObject: BulkAddTaggedObject;
|
|
40019
42087
|
}
|
|
40020
42088
|
/**
|
|
40021
42089
|
* TaggedObjectsApi - object-oriented interface
|
|
@@ -40095,7 +42163,7 @@ export declare class TaggedObjectsApi extends BaseAPI {
|
|
|
40095
42163
|
* @throws {RequiredError}
|
|
40096
42164
|
* @memberof TaggedObjectsApi
|
|
40097
42165
|
*/
|
|
40098
|
-
setTagsToManyObjects(requestParameters: TaggedObjectsApiSetTagsToManyObjectsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<
|
|
42166
|
+
setTagsToManyObjects(requestParameters: TaggedObjectsApiSetTagsToManyObjectsRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<BulkTaggedObjectResponse[], any>>;
|
|
40099
42167
|
}
|
|
40100
42168
|
/**
|
|
40101
42169
|
* TransformsApi - axios parameter creator
|
|
@@ -40398,6 +42466,124 @@ export declare class TransformsApi extends BaseAPI {
|
|
|
40398
42466
|
*/
|
|
40399
42467
|
updateTransform(requestParameters: TransformsApiUpdateTransformRequest, axiosOptions?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TransformRead, any>>;
|
|
40400
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
|
+
}
|
|
40401
42587
|
/**
|
|
40402
42588
|
* WorkItemsApi - axios parameter creator
|
|
40403
42589
|
* @export
|
|
@@ -40499,6 +42685,15 @@ export declare const WorkItemsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
40499
42685
|
* @throws {RequiredError}
|
|
40500
42686
|
*/
|
|
40501
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>;
|
|
40502
42697
|
/**
|
|
40503
42698
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
40504
42699
|
* @summary Submit Account Selections
|
|
@@ -40612,6 +42807,15 @@ export declare const WorkItemsApiFp: (configuration?: Configuration) => {
|
|
|
40612
42807
|
* @throws {RequiredError}
|
|
40613
42808
|
*/
|
|
40614
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>>;
|
|
40615
42819
|
/**
|
|
40616
42820
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
40617
42821
|
* @summary Submit Account Selections
|
|
@@ -40725,6 +42929,15 @@ export declare const WorkItemsApiFactory: (configuration?: Configuration, basePa
|
|
|
40725
42929
|
* @throws {RequiredError}
|
|
40726
42930
|
*/
|
|
40727
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>;
|
|
40728
42941
|
/**
|
|
40729
42942
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
40730
42943
|
* @summary Submit Account Selections
|
|
@@ -40928,6 +43141,25 @@ export interface WorkItemsApiRejectApprovalItemsInBulkRequest {
|
|
|
40928
43141
|
*/
|
|
40929
43142
|
readonly id: string;
|
|
40930
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
|
+
}
|
|
40931
43163
|
/**
|
|
40932
43164
|
* Request parameters for submitAccountSelection operation in WorkItemsApi.
|
|
40933
43165
|
* @export
|
|
@@ -41055,6 +43287,15 @@ export declare class WorkItemsApi extends BaseAPI {
|
|
|
41055
43287
|
* @memberof WorkItemsApi
|
|
41056
43288
|
*/
|
|
41057
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>>;
|
|
41058
43299
|
/**
|
|
41059
43300
|
* This API submits account selections. Either an admin, or the owning/current user must make this request.
|
|
41060
43301
|
* @summary Submit Account Selections
|