@sailpoint/api-client 2.2.42 → 2.2.43
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/esm/public_identities/api.js +203 -1
- package/dist/nerm/common.js +2 -2
- package/dist/nerm/common.js.map +1 -1
- package/dist/nermv2025/common.js +2 -2
- package/dist/nermv2025/common.js.map +1 -1
- package/dist/public_identities/api.d.ts +450 -0
- package/dist/public_identities/api.js +203 -1
- package/dist/public_identities/api.js.map +1 -1
- package/package.json +1 -1
|
@@ -167,6 +167,206 @@ export declare const LocaleOrigin: {
|
|
|
167
167
|
readonly Request: "REQUEST";
|
|
168
168
|
};
|
|
169
169
|
export type LocaleOrigin = typeof LocaleOrigin[keyof typeof LocaleOrigin];
|
|
170
|
+
/**
|
|
171
|
+
* @type PublicIdentitiesCompositeEntry
|
|
172
|
+
* A querySet entry that is either a TEXT clause or a nested COMPOSITE querySet.
|
|
173
|
+
* @export
|
|
174
|
+
*/
|
|
175
|
+
export type PublicIdentitiesCompositeEntry = {
|
|
176
|
+
queryType: 'COMPOSITE';
|
|
177
|
+
} & PublicIdentitiesNestedCompositeEntry | {
|
|
178
|
+
queryType: 'TEXT';
|
|
179
|
+
} & PublicIdentitiesTextEntry;
|
|
180
|
+
/**
|
|
181
|
+
* A COMPOSITE query entry that nests another querySet.
|
|
182
|
+
* @export
|
|
183
|
+
* @interface PublicIdentitiesNestedCompositeEntry
|
|
184
|
+
*/
|
|
185
|
+
export interface PublicIdentitiesNestedCompositeEntry {
|
|
186
|
+
/**
|
|
187
|
+
* Entry type discriminator. Must be COMPOSITE for nested query sets.
|
|
188
|
+
* @type {string}
|
|
189
|
+
* @memberof PublicIdentitiesNestedCompositeEntry
|
|
190
|
+
*/
|
|
191
|
+
'queryType': PublicIdentitiesNestedCompositeEntryQueryTypeEnum;
|
|
192
|
+
/**
|
|
193
|
+
* Nested query set for this COMPOSITE entry.
|
|
194
|
+
* @type {PublicIdentitiesNestedQuerySet}
|
|
195
|
+
* @memberof PublicIdentitiesNestedCompositeEntry
|
|
196
|
+
*/
|
|
197
|
+
'querySet': PublicIdentitiesNestedQuerySet;
|
|
198
|
+
}
|
|
199
|
+
export declare const PublicIdentitiesNestedCompositeEntryQueryTypeEnum: {
|
|
200
|
+
readonly Composite: "COMPOSITE";
|
|
201
|
+
};
|
|
202
|
+
export type PublicIdentitiesNestedCompositeEntryQueryTypeEnum = typeof PublicIdentitiesNestedCompositeEntryQueryTypeEnum[keyof typeof PublicIdentitiesNestedCompositeEntryQueryTypeEnum];
|
|
203
|
+
/**
|
|
204
|
+
* Query set nested inside a COMPOSITE entry. TEXT entries combined with AND (matchAny false) or OR (matchAny true).
|
|
205
|
+
* @export
|
|
206
|
+
* @interface PublicIdentitiesNestedQuerySet
|
|
207
|
+
*/
|
|
208
|
+
export interface PublicIdentitiesNestedQuerySet {
|
|
209
|
+
/**
|
|
210
|
+
* When true, entries are OR\'d; when false, entries are AND\'d.
|
|
211
|
+
* @type {boolean}
|
|
212
|
+
* @memberof PublicIdentitiesNestedQuerySet
|
|
213
|
+
*/
|
|
214
|
+
'matchAny': boolean;
|
|
215
|
+
/**
|
|
216
|
+
* One or more TEXT entries.
|
|
217
|
+
* @type {Array<PublicIdentitiesTextEntry>}
|
|
218
|
+
* @memberof PublicIdentitiesNestedQuerySet
|
|
219
|
+
*/
|
|
220
|
+
'entries': Array<PublicIdentitiesTextEntry>;
|
|
221
|
+
}
|
|
222
|
+
/**
|
|
223
|
+
* A set of COMPOSITE query entries combined with AND (matchAny false) or OR (matchAny true).
|
|
224
|
+
* @export
|
|
225
|
+
* @interface PublicIdentitiesQuerySet
|
|
226
|
+
*/
|
|
227
|
+
export interface PublicIdentitiesQuerySet {
|
|
228
|
+
/**
|
|
229
|
+
* When true, entries are OR\'d; when false, entries are AND\'d.
|
|
230
|
+
* @type {boolean}
|
|
231
|
+
* @memberof PublicIdentitiesQuerySet
|
|
232
|
+
*/
|
|
233
|
+
'matchAny': boolean;
|
|
234
|
+
/**
|
|
235
|
+
* One or more TEXT or nested COMPOSITE entries.
|
|
236
|
+
* @type {Array<PublicIdentitiesCompositeEntry>}
|
|
237
|
+
* @memberof PublicIdentitiesQuerySet
|
|
238
|
+
*/
|
|
239
|
+
'entries': Array<PublicIdentitiesCompositeEntry>;
|
|
240
|
+
}
|
|
241
|
+
/**
|
|
242
|
+
* COMPOSITE search request for public identities. Root querySet must use matchAny false (AND). The first entries item must be the ACTIVE identityState TEXT gate; identityState may not appear elsewhere in the query tree.
|
|
243
|
+
* @export
|
|
244
|
+
* @interface PublicIdentitiesSearchRequest
|
|
245
|
+
*/
|
|
246
|
+
export interface PublicIdentitiesSearchRequest {
|
|
247
|
+
/**
|
|
248
|
+
* Search query type. Must be COMPOSITE.
|
|
249
|
+
* @type {string}
|
|
250
|
+
* @memberof PublicIdentitiesSearchRequest
|
|
251
|
+
*/
|
|
252
|
+
'queryType': PublicIdentitiesSearchRequestQueryTypeEnum;
|
|
253
|
+
/**
|
|
254
|
+
* Search indices. Must be exactly [\"identities\"].
|
|
255
|
+
* @type {Array<string>}
|
|
256
|
+
* @memberof PublicIdentitiesSearchRequest
|
|
257
|
+
*/
|
|
258
|
+
'indices': Array<PublicIdentitiesSearchRequestIndicesEnum>;
|
|
259
|
+
/**
|
|
260
|
+
* Must be false for public identities search.
|
|
261
|
+
* @type {boolean}
|
|
262
|
+
* @memberof PublicIdentitiesSearchRequest
|
|
263
|
+
*/
|
|
264
|
+
'includeNested': boolean;
|
|
265
|
+
/**
|
|
266
|
+
* Optional attribute keys to sort by. Base keys must match those returned by GET /public-identities/v2/visible-attributes (defaultAttributes + configuredAttributes). Optional \"attributes.\" prefix and/or \".exact\" suffix.
|
|
267
|
+
* @type {Array<string>}
|
|
268
|
+
* @memberof PublicIdentitiesSearchRequest
|
|
269
|
+
*/
|
|
270
|
+
'sort'?: Array<string>;
|
|
271
|
+
/**
|
|
272
|
+
*
|
|
273
|
+
* @type {PublicIdentitiesSearchRequestQuerySet}
|
|
274
|
+
* @memberof PublicIdentitiesSearchRequest
|
|
275
|
+
*/
|
|
276
|
+
'querySet': PublicIdentitiesSearchRequestQuerySet;
|
|
277
|
+
}
|
|
278
|
+
export declare const PublicIdentitiesSearchRequestQueryTypeEnum: {
|
|
279
|
+
readonly Composite: "COMPOSITE";
|
|
280
|
+
};
|
|
281
|
+
export type PublicIdentitiesSearchRequestQueryTypeEnum = typeof PublicIdentitiesSearchRequestQueryTypeEnum[keyof typeof PublicIdentitiesSearchRequestQueryTypeEnum];
|
|
282
|
+
export declare const PublicIdentitiesSearchRequestIndicesEnum: {
|
|
283
|
+
readonly Identities: "identities";
|
|
284
|
+
};
|
|
285
|
+
export type PublicIdentitiesSearchRequestIndicesEnum = typeof PublicIdentitiesSearchRequestIndicesEnum[keyof typeof PublicIdentitiesSearchRequestIndicesEnum];
|
|
286
|
+
/**
|
|
287
|
+
*
|
|
288
|
+
* @export
|
|
289
|
+
* @interface PublicIdentitiesSearchRequestQuerySet
|
|
290
|
+
*/
|
|
291
|
+
export interface PublicIdentitiesSearchRequestQuerySet {
|
|
292
|
+
/**
|
|
293
|
+
* When true, entries are OR\'d; when false, entries are AND\'d.
|
|
294
|
+
* @type {boolean}
|
|
295
|
+
* @memberof PublicIdentitiesSearchRequestQuerySet
|
|
296
|
+
*/
|
|
297
|
+
'matchAny': boolean;
|
|
298
|
+
/**
|
|
299
|
+
* One or more TEXT or nested COMPOSITE entries.
|
|
300
|
+
* @type {Array<PublicIdentitiesCompositeEntry>}
|
|
301
|
+
* @memberof PublicIdentitiesSearchRequestQuerySet
|
|
302
|
+
*/
|
|
303
|
+
'entries': Array<PublicIdentitiesCompositeEntry>;
|
|
304
|
+
}
|
|
305
|
+
/**
|
|
306
|
+
* A COMPOSITE query entry that contains a TEXT query.
|
|
307
|
+
* @export
|
|
308
|
+
* @interface PublicIdentitiesTextEntry
|
|
309
|
+
*/
|
|
310
|
+
export interface PublicIdentitiesTextEntry {
|
|
311
|
+
/**
|
|
312
|
+
* Entry type discriminator. Must be TEXT for text query entries.
|
|
313
|
+
* @type {string}
|
|
314
|
+
* @memberof PublicIdentitiesTextEntry
|
|
315
|
+
*/
|
|
316
|
+
'queryType': PublicIdentitiesTextEntryQueryTypeEnum;
|
|
317
|
+
/**
|
|
318
|
+
* Text query clause for this TEXT entry.
|
|
319
|
+
* @type {PublicIdentitiesTextQuery}
|
|
320
|
+
* @memberof PublicIdentitiesTextEntry
|
|
321
|
+
*/
|
|
322
|
+
'textQuery': PublicIdentitiesTextQuery;
|
|
323
|
+
}
|
|
324
|
+
export declare const PublicIdentitiesTextEntryQueryTypeEnum: {
|
|
325
|
+
readonly Text: "TEXT";
|
|
326
|
+
};
|
|
327
|
+
export type PublicIdentitiesTextEntryQueryTypeEnum = typeof PublicIdentitiesTextEntryQueryTypeEnum[keyof typeof PublicIdentitiesTextEntryQueryTypeEnum];
|
|
328
|
+
/**
|
|
329
|
+
* Text query clause used inside a TEXT composite entry.
|
|
330
|
+
* @export
|
|
331
|
+
* @interface PublicIdentitiesTextQuery
|
|
332
|
+
*/
|
|
333
|
+
export interface PublicIdentitiesTextQuery {
|
|
334
|
+
/**
|
|
335
|
+
* Attribute keys to search. Base keys must match GET /public-identities/v2/visible-attributes (defaultAttributes + configuredAttributes). Optional \"attributes.\" prefix and/or \".exact\" suffix (e.g. email, attributes.email, email.exact, attributes.email.exact).
|
|
336
|
+
* @type {Array<string>}
|
|
337
|
+
* @memberof PublicIdentitiesTextQuery
|
|
338
|
+
*/
|
|
339
|
+
'fields': Array<string>;
|
|
340
|
+
/**
|
|
341
|
+
* Search terms. Each value must be a non-blank string or a JSON boolean.
|
|
342
|
+
* @type {Array<PublicIdentitiesTextQueryTermsInner>}
|
|
343
|
+
* @memberof PublicIdentitiesTextQuery
|
|
344
|
+
*/
|
|
345
|
+
'terms': Array<PublicIdentitiesTextQueryTermsInner>;
|
|
346
|
+
/**
|
|
347
|
+
* When true, terms/fields are OR\'d within this text query. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to false.
|
|
348
|
+
* @type {boolean}
|
|
349
|
+
* @memberof PublicIdentitiesTextQuery
|
|
350
|
+
*/
|
|
351
|
+
'matchAny'?: boolean;
|
|
352
|
+
/**
|
|
353
|
+
* When true, matches substrings. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to false.
|
|
354
|
+
* @type {boolean}
|
|
355
|
+
* @memberof PublicIdentitiesTextQuery
|
|
356
|
+
*/
|
|
357
|
+
'contains'?: boolean;
|
|
358
|
+
/**
|
|
359
|
+
* When true, applies strict matching. Optional for normal search clauses. The mandatory ACTIVE identityState gate entry must set this to true.
|
|
360
|
+
* @type {boolean}
|
|
361
|
+
* @memberof PublicIdentitiesTextQuery
|
|
362
|
+
*/
|
|
363
|
+
'strict'?: boolean;
|
|
364
|
+
}
|
|
365
|
+
/**
|
|
366
|
+
* @type PublicIdentitiesTextQueryTermsInner
|
|
367
|
+
* @export
|
|
368
|
+
*/
|
|
369
|
+
export type PublicIdentitiesTextQueryTermsInner = boolean | string;
|
|
170
370
|
/**
|
|
171
371
|
* Details about a public identity
|
|
172
372
|
* @export
|
|
@@ -228,6 +428,25 @@ export declare const PublicIdentityIdentityStateEnum: {
|
|
|
228
428
|
readonly InactiveLongTerm: "INACTIVE_LONG_TERM";
|
|
229
429
|
};
|
|
230
430
|
export type PublicIdentityIdentityStateEnum = typeof PublicIdentityIdentityStateEnum[keyof typeof PublicIdentityIdentityStateEnum];
|
|
431
|
+
/**
|
|
432
|
+
* Maps an identity attribute key to its display name.
|
|
433
|
+
* @export
|
|
434
|
+
* @interface PublicIdentityAttributeConfig
|
|
435
|
+
*/
|
|
436
|
+
export interface PublicIdentityAttributeConfig {
|
|
437
|
+
/**
|
|
438
|
+
* Attribute / search field key (e.g. email, manager.displayName).
|
|
439
|
+
* @type {string}
|
|
440
|
+
* @memberof PublicIdentityAttributeConfig
|
|
441
|
+
*/
|
|
442
|
+
'key': string;
|
|
443
|
+
/**
|
|
444
|
+
* Human-readable display name for the attribute.
|
|
445
|
+
* @type {string}
|
|
446
|
+
* @memberof PublicIdentityAttributeConfig
|
|
447
|
+
*/
|
|
448
|
+
'name': string;
|
|
449
|
+
}
|
|
231
450
|
/**
|
|
232
451
|
*
|
|
233
452
|
* @export
|
|
@@ -253,6 +472,113 @@ export interface PublicIdentityAttributesInner {
|
|
|
253
472
|
*/
|
|
254
473
|
'value'?: string | null;
|
|
255
474
|
}
|
|
475
|
+
/**
|
|
476
|
+
* Projected public identity returned by POST /public-identities/v2/search. Root fields are always present (null when unavailable). attributes contains only keys from GET /public-identities/v2/visible-attributes configuredAttributes.
|
|
477
|
+
* @export
|
|
478
|
+
* @interface PublicIdentityV2
|
|
479
|
+
*/
|
|
480
|
+
export interface PublicIdentityV2 {
|
|
481
|
+
/**
|
|
482
|
+
* Identity id
|
|
483
|
+
* @type {string}
|
|
484
|
+
* @memberof PublicIdentityV2
|
|
485
|
+
*/
|
|
486
|
+
'id': string | null;
|
|
487
|
+
/**
|
|
488
|
+
* Alternate unique identifier for the identity (alias / search field name).
|
|
489
|
+
* @type {string}
|
|
490
|
+
* @memberof PublicIdentityV2
|
|
491
|
+
*/
|
|
492
|
+
'name': string | null;
|
|
493
|
+
/**
|
|
494
|
+
* Human-readable display name of the identity.
|
|
495
|
+
* @type {string}
|
|
496
|
+
* @memberof PublicIdentityV2
|
|
497
|
+
*/
|
|
498
|
+
'displayName': string | null;
|
|
499
|
+
/**
|
|
500
|
+
* Email address of identity.
|
|
501
|
+
* @type {string}
|
|
502
|
+
* @memberof PublicIdentityV2
|
|
503
|
+
*/
|
|
504
|
+
'email': string | null;
|
|
505
|
+
/**
|
|
506
|
+
* The current state of the identity, which determines how Identity Security Cloud interacts with the identity.
|
|
507
|
+
* @type {string}
|
|
508
|
+
* @memberof PublicIdentityV2
|
|
509
|
+
*/
|
|
510
|
+
'identityState': PublicIdentityV2IdentityStateEnum | null;
|
|
511
|
+
/**
|
|
512
|
+
* The lifecycle status for the identity
|
|
513
|
+
* @type {string}
|
|
514
|
+
* @memberof PublicIdentityV2
|
|
515
|
+
*/
|
|
516
|
+
'cloudLifecycleState': string | null;
|
|
517
|
+
/**
|
|
518
|
+
* Manager of this identity, or null when none
|
|
519
|
+
* @type {PublicIdentityV2Manager}
|
|
520
|
+
* @memberof PublicIdentityV2
|
|
521
|
+
*/
|
|
522
|
+
'manager': PublicIdentityV2Manager | null;
|
|
523
|
+
/**
|
|
524
|
+
* Configured public identity attributes only (from visible-attributes configuredAttributes). Missing keys are omitted; present null values are returned as null.
|
|
525
|
+
* @type {{ [key: string]: string | null; }}
|
|
526
|
+
* @memberof PublicIdentityV2
|
|
527
|
+
*/
|
|
528
|
+
'attributes': {
|
|
529
|
+
[key: string]: string | null;
|
|
530
|
+
};
|
|
531
|
+
}
|
|
532
|
+
export declare const PublicIdentityV2IdentityStateEnum: {
|
|
533
|
+
readonly Active: "ACTIVE";
|
|
534
|
+
readonly InactiveShortTerm: "INACTIVE_SHORT_TERM";
|
|
535
|
+
readonly InactiveLongTerm: "INACTIVE_LONG_TERM";
|
|
536
|
+
};
|
|
537
|
+
export type PublicIdentityV2IdentityStateEnum = typeof PublicIdentityV2IdentityStateEnum[keyof typeof PublicIdentityV2IdentityStateEnum];
|
|
538
|
+
/**
|
|
539
|
+
* Manager reference for a public identity search result
|
|
540
|
+
* @export
|
|
541
|
+
* @interface PublicIdentityV2Manager
|
|
542
|
+
*/
|
|
543
|
+
export interface PublicIdentityV2Manager {
|
|
544
|
+
/**
|
|
545
|
+
* Manager identity id
|
|
546
|
+
* @type {string}
|
|
547
|
+
* @memberof PublicIdentityV2Manager
|
|
548
|
+
*/
|
|
549
|
+
'id': string | null;
|
|
550
|
+
/**
|
|
551
|
+
* Manager alias / technical name
|
|
552
|
+
* @type {string}
|
|
553
|
+
* @memberof PublicIdentityV2Manager
|
|
554
|
+
*/
|
|
555
|
+
'name': string | null;
|
|
556
|
+
/**
|
|
557
|
+
* Manager display name. Null when absent from the search hit.
|
|
558
|
+
* @type {string}
|
|
559
|
+
* @memberof PublicIdentityV2Manager
|
|
560
|
+
*/
|
|
561
|
+
'displayName': string | null;
|
|
562
|
+
}
|
|
563
|
+
/**
|
|
564
|
+
* Default and configured identity attribute keys with display names exposed by the public identities API.
|
|
565
|
+
* @export
|
|
566
|
+
* @interface PublicIdentityVisibleAttributes
|
|
567
|
+
*/
|
|
568
|
+
export interface PublicIdentityVisibleAttributes {
|
|
569
|
+
/**
|
|
570
|
+
* Always-available public-identity field keys for search and sort. Fixed platform list. `key` is the search field name; `name` is the display label.
|
|
571
|
+
* @type {Array<PublicIdentityAttributeConfig>}
|
|
572
|
+
* @memberof PublicIdentityVisibleAttributes
|
|
573
|
+
*/
|
|
574
|
+
'defaultAttributes': Array<PublicIdentityAttributeConfig>;
|
|
575
|
+
/**
|
|
576
|
+
* Tenant-configured public attributes from public-identities config (same source as public-identities-config). These keys are also allowed in search/sort and appear under `attributes` on search results.
|
|
577
|
+
* @type {Array<PublicIdentityAttributeConfig>}
|
|
578
|
+
* @memberof PublicIdentityVisibleAttributes
|
|
579
|
+
*/
|
|
580
|
+
'configuredAttributes': Array<PublicIdentityAttributeConfig>;
|
|
581
|
+
}
|
|
256
582
|
/**
|
|
257
583
|
* PublicIdentitiesApi - axios parameter creator
|
|
258
584
|
* @export
|
|
@@ -271,6 +597,26 @@ export declare const PublicIdentitiesApiAxiosParamCreator: (configuration?: Conf
|
|
|
271
597
|
* @throws {RequiredError}
|
|
272
598
|
*/
|
|
273
599
|
getPublicIdentitiesV1: (limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
600
|
+
/**
|
|
601
|
+
* Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort. Any authenticated user with the default scope can call this endpoint.
|
|
602
|
+
* @summary Get public identity visible attributes
|
|
603
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
604
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
605
|
+
* @throws {RequiredError}
|
|
606
|
+
*/
|
|
607
|
+
getPublicIdentitiesVisibleAttributesV2: (xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
608
|
+
/**
|
|
609
|
+
* Search public identities using a composite query and return matching records. The root query set combines criteria with AND and must include attributes.identityState.exact = ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix \"attributes.\" and/or the suffix \".exact\". See the request examples for the required exact payload structure. Any authenticated user with the default scope can call this endpoint.
|
|
610
|
+
* @summary Search public identities
|
|
611
|
+
* @param {PublicIdentitiesSearchRequest} publicIdentitiesSearchRequest
|
|
612
|
+
* @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.
|
|
613
|
+
* @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.
|
|
614
|
+
* @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.
|
|
615
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
616
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
617
|
+
* @throws {RequiredError}
|
|
618
|
+
*/
|
|
619
|
+
searchPublicIdentitiesV2: (publicIdentitiesSearchRequest: PublicIdentitiesSearchRequest, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
274
620
|
};
|
|
275
621
|
/**
|
|
276
622
|
* PublicIdentitiesApi - functional programming interface
|
|
@@ -290,6 +636,26 @@ export declare const PublicIdentitiesApiFp: (configuration?: Configuration) => {
|
|
|
290
636
|
* @throws {RequiredError}
|
|
291
637
|
*/
|
|
292
638
|
getPublicIdentitiesV1(limit?: number, offset?: number, count?: boolean, filters?: string, addCoreFilters?: boolean, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PublicIdentity>>>;
|
|
639
|
+
/**
|
|
640
|
+
* Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort. Any authenticated user with the default scope can call this endpoint.
|
|
641
|
+
* @summary Get public identity visible attributes
|
|
642
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
643
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
644
|
+
* @throws {RequiredError}
|
|
645
|
+
*/
|
|
646
|
+
getPublicIdentitiesVisibleAttributesV2(xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PublicIdentityVisibleAttributes>>;
|
|
647
|
+
/**
|
|
648
|
+
* Search public identities using a composite query and return matching records. The root query set combines criteria with AND and must include attributes.identityState.exact = ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix \"attributes.\" and/or the suffix \".exact\". See the request examples for the required exact payload structure. Any authenticated user with the default scope can call this endpoint.
|
|
649
|
+
* @summary Search public identities
|
|
650
|
+
* @param {PublicIdentitiesSearchRequest} publicIdentitiesSearchRequest
|
|
651
|
+
* @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.
|
|
652
|
+
* @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.
|
|
653
|
+
* @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.
|
|
654
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
655
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
656
|
+
* @throws {RequiredError}
|
|
657
|
+
*/
|
|
658
|
+
searchPublicIdentitiesV2(publicIdentitiesSearchRequest: PublicIdentitiesSearchRequest, limit?: number, offset?: number, count?: boolean, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<PublicIdentityV2>>>;
|
|
293
659
|
};
|
|
294
660
|
/**
|
|
295
661
|
* PublicIdentitiesApi - factory interface
|
|
@@ -304,6 +670,22 @@ export declare const PublicIdentitiesApiFactory: (configuration?: Configuration,
|
|
|
304
670
|
* @throws {RequiredError}
|
|
305
671
|
*/
|
|
306
672
|
getPublicIdentitiesV1(requestParameters?: PublicIdentitiesApiGetPublicIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<PublicIdentity>>;
|
|
673
|
+
/**
|
|
674
|
+
* Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort. Any authenticated user with the default scope can call this endpoint.
|
|
675
|
+
* @summary Get public identity visible attributes
|
|
676
|
+
* @param {PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request} requestParameters Request parameters.
|
|
677
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
678
|
+
* @throws {RequiredError}
|
|
679
|
+
*/
|
|
680
|
+
getPublicIdentitiesVisibleAttributesV2(requestParameters?: PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<PublicIdentityVisibleAttributes>;
|
|
681
|
+
/**
|
|
682
|
+
* Search public identities using a composite query and return matching records. The root query set combines criteria with AND and must include attributes.identityState.exact = ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix \"attributes.\" and/or the suffix \".exact\". See the request examples for the required exact payload structure. Any authenticated user with the default scope can call this endpoint.
|
|
683
|
+
* @summary Search public identities
|
|
684
|
+
* @param {PublicIdentitiesApiSearchPublicIdentitiesV2Request} requestParameters Request parameters.
|
|
685
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
686
|
+
* @throws {RequiredError}
|
|
687
|
+
*/
|
|
688
|
+
searchPublicIdentitiesV2(requestParameters: PublicIdentitiesApiSearchPublicIdentitiesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<PublicIdentityV2>>;
|
|
307
689
|
};
|
|
308
690
|
/**
|
|
309
691
|
* Request parameters for getPublicIdentitiesV1 operation in PublicIdentitiesApi.
|
|
@@ -348,6 +730,56 @@ export interface PublicIdentitiesApiGetPublicIdentitiesV1Request {
|
|
|
348
730
|
*/
|
|
349
731
|
readonly sorters?: string;
|
|
350
732
|
}
|
|
733
|
+
/**
|
|
734
|
+
* Request parameters for getPublicIdentitiesVisibleAttributesV2 operation in PublicIdentitiesApi.
|
|
735
|
+
* @export
|
|
736
|
+
* @interface PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request
|
|
737
|
+
*/
|
|
738
|
+
export interface PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request {
|
|
739
|
+
/**
|
|
740
|
+
* Use this header to enable this experimental API.
|
|
741
|
+
* @type {string}
|
|
742
|
+
* @memberof PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2
|
|
743
|
+
*/
|
|
744
|
+
readonly xSailPointExperimental?: string;
|
|
745
|
+
}
|
|
746
|
+
/**
|
|
747
|
+
* Request parameters for searchPublicIdentitiesV2 operation in PublicIdentitiesApi.
|
|
748
|
+
* @export
|
|
749
|
+
* @interface PublicIdentitiesApiSearchPublicIdentitiesV2Request
|
|
750
|
+
*/
|
|
751
|
+
export interface PublicIdentitiesApiSearchPublicIdentitiesV2Request {
|
|
752
|
+
/**
|
|
753
|
+
*
|
|
754
|
+
* @type {PublicIdentitiesSearchRequest}
|
|
755
|
+
* @memberof PublicIdentitiesApiSearchPublicIdentitiesV2
|
|
756
|
+
*/
|
|
757
|
+
readonly publicIdentitiesSearchRequest: PublicIdentitiesSearchRequest;
|
|
758
|
+
/**
|
|
759
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
760
|
+
* @type {number}
|
|
761
|
+
* @memberof PublicIdentitiesApiSearchPublicIdentitiesV2
|
|
762
|
+
*/
|
|
763
|
+
readonly limit?: number;
|
|
764
|
+
/**
|
|
765
|
+
* 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.
|
|
766
|
+
* @type {number}
|
|
767
|
+
* @memberof PublicIdentitiesApiSearchPublicIdentitiesV2
|
|
768
|
+
*/
|
|
769
|
+
readonly offset?: number;
|
|
770
|
+
/**
|
|
771
|
+
* 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.
|
|
772
|
+
* @type {boolean}
|
|
773
|
+
* @memberof PublicIdentitiesApiSearchPublicIdentitiesV2
|
|
774
|
+
*/
|
|
775
|
+
readonly count?: boolean;
|
|
776
|
+
/**
|
|
777
|
+
* Use this header to enable this experimental API.
|
|
778
|
+
* @type {string}
|
|
779
|
+
* @memberof PublicIdentitiesApiSearchPublicIdentitiesV2
|
|
780
|
+
*/
|
|
781
|
+
readonly xSailPointExperimental?: string;
|
|
782
|
+
}
|
|
351
783
|
/**
|
|
352
784
|
* PublicIdentitiesApi - object-oriented interface
|
|
353
785
|
* @export
|
|
@@ -364,4 +796,22 @@ export declare class PublicIdentitiesApi extends BaseAPI {
|
|
|
364
796
|
* @memberof PublicIdentitiesApi
|
|
365
797
|
*/
|
|
366
798
|
getPublicIdentitiesV1(requestParameters?: PublicIdentitiesApiGetPublicIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicIdentity[], any>>;
|
|
799
|
+
/**
|
|
800
|
+
* Returns the default and configured identity attribute keys (with display names) that are allowed for public-identity search and projection. Call this before POST /public-identities/v2/search to learn which field keys are valid in query fields and sort. Any authenticated user with the default scope can call this endpoint.
|
|
801
|
+
* @summary Get public identity visible attributes
|
|
802
|
+
* @param {PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request} requestParameters Request parameters.
|
|
803
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
804
|
+
* @throws {RequiredError}
|
|
805
|
+
* @memberof PublicIdentitiesApi
|
|
806
|
+
*/
|
|
807
|
+
getPublicIdentitiesVisibleAttributesV2(requestParameters?: PublicIdentitiesApiGetPublicIdentitiesVisibleAttributesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicIdentityVisibleAttributes, any>>;
|
|
808
|
+
/**
|
|
809
|
+
* Search public identities using a composite query and return matching records. The root query set combines criteria with AND and must include attributes.identityState.exact = ACTIVE. The field keys must come from GET /public-identities/v2/visible-attributes and may use the prefix \"attributes.\" and/or the suffix \".exact\". See the request examples for the required exact payload structure. Any authenticated user with the default scope can call this endpoint.
|
|
810
|
+
* @summary Search public identities
|
|
811
|
+
* @param {PublicIdentitiesApiSearchPublicIdentitiesV2Request} requestParameters Request parameters.
|
|
812
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
813
|
+
* @throws {RequiredError}
|
|
814
|
+
* @memberof PublicIdentitiesApi
|
|
815
|
+
*/
|
|
816
|
+
searchPublicIdentitiesV2(requestParameters: PublicIdentitiesApiSearchPublicIdentitiesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<PublicIdentityV2[], any>>;
|
|
367
817
|
}
|