@sailpoint/api-client 2.2.40 → 2.2.41
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/identities/api.js +205 -0
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- package/dist/identities/api.d.ts +339 -0
- package/dist/identities/api.js +206 -1
- package/dist/identities/api.js.map +1 -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/package.json +1 -1
package/dist/identities/api.d.ts
CHANGED
|
@@ -627,6 +627,197 @@ export interface IdentitySyncPayload {
|
|
|
627
627
|
*/
|
|
628
628
|
'dataJson': string;
|
|
629
629
|
}
|
|
630
|
+
/**
|
|
631
|
+
* Identity record returned by the search-backed identities v2 API.
|
|
632
|
+
* @export
|
|
633
|
+
* @interface IdentityV2
|
|
634
|
+
*/
|
|
635
|
+
export interface IdentityV2 {
|
|
636
|
+
/**
|
|
637
|
+
* System-generated unique ID of the identity.
|
|
638
|
+
* @type {string}
|
|
639
|
+
* @memberof IdentityV2
|
|
640
|
+
*/
|
|
641
|
+
'id'?: string | null;
|
|
642
|
+
/**
|
|
643
|
+
* Display name of the identity.
|
|
644
|
+
* @type {string}
|
|
645
|
+
* @memberof IdentityV2
|
|
646
|
+
*/
|
|
647
|
+
'name'?: string | null;
|
|
648
|
+
/**
|
|
649
|
+
* Alternate unique identifier of the identity. Equivalent to the account name on the authoritative source.
|
|
650
|
+
* @type {string}
|
|
651
|
+
* @memberof IdentityV2
|
|
652
|
+
*/
|
|
653
|
+
'alias'?: string | null;
|
|
654
|
+
/**
|
|
655
|
+
* The identity type.
|
|
656
|
+
* @type {string}
|
|
657
|
+
* @memberof IdentityV2
|
|
658
|
+
*/
|
|
659
|
+
'type'?: string | null;
|
|
660
|
+
/**
|
|
661
|
+
* Email address of the identity.
|
|
662
|
+
* @type {string}
|
|
663
|
+
* @memberof IdentityV2
|
|
664
|
+
*/
|
|
665
|
+
'emailAddress'?: string | null;
|
|
666
|
+
/**
|
|
667
|
+
* The identity\'s status in the system.
|
|
668
|
+
* @type {string}
|
|
669
|
+
* @memberof IdentityV2
|
|
670
|
+
*/
|
|
671
|
+
'identityStatus'?: string | null;
|
|
672
|
+
/**
|
|
673
|
+
* The processing state of the identity.
|
|
674
|
+
* @type {string}
|
|
675
|
+
* @memberof IdentityV2
|
|
676
|
+
*/
|
|
677
|
+
'processingState'?: string | null;
|
|
678
|
+
/**
|
|
679
|
+
* Whether the identity is protected from accidental deletion or modification.
|
|
680
|
+
* @type {boolean}
|
|
681
|
+
* @memberof IdentityV2
|
|
682
|
+
*/
|
|
683
|
+
'protected'?: boolean;
|
|
684
|
+
/**
|
|
685
|
+
* Whether the identity is correlated to an authoritative account.
|
|
686
|
+
* @type {boolean}
|
|
687
|
+
* @memberof IdentityV2
|
|
688
|
+
*/
|
|
689
|
+
'correlated'?: boolean;
|
|
690
|
+
/**
|
|
691
|
+
* Whether the identity is inactive.
|
|
692
|
+
* @type {boolean}
|
|
693
|
+
* @memberof IdentityV2
|
|
694
|
+
*/
|
|
695
|
+
'inactive'?: boolean;
|
|
696
|
+
/**
|
|
697
|
+
* Whether this identity is a manager of another identity.
|
|
698
|
+
* @type {boolean}
|
|
699
|
+
* @memberof IdentityV2
|
|
700
|
+
*/
|
|
701
|
+
'isManager'?: boolean;
|
|
702
|
+
/**
|
|
703
|
+
* Whether the identity is locked.
|
|
704
|
+
* @type {boolean}
|
|
705
|
+
* @memberof IdentityV2
|
|
706
|
+
*/
|
|
707
|
+
'locked'?: boolean;
|
|
708
|
+
/**
|
|
709
|
+
* Whether the identity is disabled.
|
|
710
|
+
* @type {boolean}
|
|
711
|
+
* @memberof IdentityV2
|
|
712
|
+
*/
|
|
713
|
+
'disabled'?: boolean;
|
|
714
|
+
/**
|
|
715
|
+
*
|
|
716
|
+
* @type {IdentityV2Manager}
|
|
717
|
+
* @memberof IdentityV2
|
|
718
|
+
*/
|
|
719
|
+
'manager'?: IdentityV2Manager | null;
|
|
720
|
+
/**
|
|
721
|
+
*
|
|
722
|
+
* @type {IdentityV2LifecycleState}
|
|
723
|
+
* @memberof IdentityV2
|
|
724
|
+
*/
|
|
725
|
+
'lifecycleState'?: IdentityV2LifecycleState;
|
|
726
|
+
/**
|
|
727
|
+
* Creation date of the identity.
|
|
728
|
+
* @type {string}
|
|
729
|
+
* @memberof IdentityV2
|
|
730
|
+
*/
|
|
731
|
+
'created'?: string | null;
|
|
732
|
+
/**
|
|
733
|
+
* Last modification date of the identity.
|
|
734
|
+
* @type {string}
|
|
735
|
+
* @memberof IdentityV2
|
|
736
|
+
*/
|
|
737
|
+
'modified'?: string | null;
|
|
738
|
+
/**
|
|
739
|
+
* Last time the identity was synchronized to search.
|
|
740
|
+
* @type {string}
|
|
741
|
+
* @memberof IdentityV2
|
|
742
|
+
*/
|
|
743
|
+
'synced'?: string | null;
|
|
744
|
+
/**
|
|
745
|
+
* The last time the identity was refreshed by the system.
|
|
746
|
+
* @type {string}
|
|
747
|
+
* @memberof IdentityV2
|
|
748
|
+
*/
|
|
749
|
+
'lastRefresh'?: string | null;
|
|
750
|
+
/**
|
|
751
|
+
*
|
|
752
|
+
* @type {IdentityV2PrivilegeLevel}
|
|
753
|
+
* @memberof IdentityV2
|
|
754
|
+
*/
|
|
755
|
+
'privilegeLevel'?: IdentityV2PrivilegeLevel | null;
|
|
756
|
+
}
|
|
757
|
+
/**
|
|
758
|
+
*
|
|
759
|
+
* @export
|
|
760
|
+
* @interface IdentityV2LifecycleState
|
|
761
|
+
*/
|
|
762
|
+
export interface IdentityV2LifecycleState {
|
|
763
|
+
/**
|
|
764
|
+
* The name of the lifecycle state
|
|
765
|
+
* @type {string}
|
|
766
|
+
* @memberof IdentityV2LifecycleState
|
|
767
|
+
*/
|
|
768
|
+
'stateName': string;
|
|
769
|
+
/**
|
|
770
|
+
* Whether the lifecycle state has been manually or automatically set
|
|
771
|
+
* @type {boolean}
|
|
772
|
+
* @memberof IdentityV2LifecycleState
|
|
773
|
+
*/
|
|
774
|
+
'manuallyUpdated': boolean;
|
|
775
|
+
}
|
|
776
|
+
/**
|
|
777
|
+
* The identity\'s manager.
|
|
778
|
+
* @export
|
|
779
|
+
* @interface IdentityV2Manager
|
|
780
|
+
*/
|
|
781
|
+
export interface IdentityV2Manager {
|
|
782
|
+
/**
|
|
783
|
+
* ID of the identity\'s manager.
|
|
784
|
+
* @type {string}
|
|
785
|
+
* @memberof IdentityV2Manager
|
|
786
|
+
*/
|
|
787
|
+
'id'?: string | null;
|
|
788
|
+
/**
|
|
789
|
+
* Display name of the identity\'s manager.
|
|
790
|
+
* @type {string}
|
|
791
|
+
* @memberof IdentityV2Manager
|
|
792
|
+
*/
|
|
793
|
+
'name'?: string | null;
|
|
794
|
+
/**
|
|
795
|
+
* DTO type of the identity\'s manager.
|
|
796
|
+
* @type {string}
|
|
797
|
+
* @memberof IdentityV2Manager
|
|
798
|
+
*/
|
|
799
|
+
'type'?: string | null;
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* Effective privilege level of the identity. This object is null when the IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE feature flag is disabled. When the flag is enabled, an identity with no privilege level is returned with effective set to NONE.
|
|
803
|
+
* @export
|
|
804
|
+
* @interface IdentityV2PrivilegeLevel
|
|
805
|
+
*/
|
|
806
|
+
export interface IdentityV2PrivilegeLevel {
|
|
807
|
+
/**
|
|
808
|
+
* The effective privilege level of the identity. Returned values are uppercase. Filter and sort comparisons are case-insensitive. An identity with no privilege level is NONE.
|
|
809
|
+
* @type {string}
|
|
810
|
+
* @memberof IdentityV2PrivilegeLevel
|
|
811
|
+
*/
|
|
812
|
+
'effective'?: IdentityV2PrivilegeLevelEffectiveEnum | null;
|
|
813
|
+
}
|
|
814
|
+
export declare const IdentityV2PrivilegeLevelEffectiveEnum: {
|
|
815
|
+
readonly High: "HIGH";
|
|
816
|
+
readonly Medium: "MEDIUM";
|
|
817
|
+
readonly Low: "LOW";
|
|
818
|
+
readonly None: "NONE";
|
|
819
|
+
};
|
|
820
|
+
export type IdentityV2PrivilegeLevelEffectiveEnum = typeof IdentityV2PrivilegeLevelEffectiveEnum[keyof typeof IdentityV2PrivilegeLevelEffectiveEnum];
|
|
630
821
|
/**
|
|
631
822
|
*
|
|
632
823
|
* @export
|
|
@@ -1327,6 +1518,15 @@ export declare const IdentitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
1327
1518
|
* @throws {RequiredError}
|
|
1328
1519
|
*/
|
|
1329
1520
|
getIdentityV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1521
|
+
/**
|
|
1522
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
1523
|
+
* @summary Identity details (search)
|
|
1524
|
+
* @param {string} id Identity Id
|
|
1525
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1526
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1527
|
+
* @throws {RequiredError}
|
|
1528
|
+
*/
|
|
1529
|
+
getIdentityV2: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1330
1530
|
/**
|
|
1331
1531
|
*
|
|
1332
1532
|
* @summary Role assignment details
|
|
@@ -1370,6 +1570,20 @@ export declare const IdentitiesApiAxiosParamCreator: (configuration?: Configurat
|
|
|
1370
1570
|
* @throws {RequiredError}
|
|
1371
1571
|
*/
|
|
1372
1572
|
listIdentitiesV1: (filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterEnum, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1573
|
+
/**
|
|
1574
|
+
* List identities from the identities search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
1575
|
+
* @summary List identities (search)
|
|
1576
|
+
* @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.
|
|
1577
|
+
* @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.
|
|
1578
|
+
* @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.
|
|
1579
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=John Mathews,01f04e428c484542a241dc89c303b178&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
1580
|
+
* @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, sw* **name**: *eq, in, sw, isnull, pr* **alias**: *eq, in, sw, isnull, pr* **type**: *eq, in, sw, isnull, pr* **emailAddress**: *eq, in, sw, isnull, pr* **identityStatus**: *eq, in, sw, isnull, pr* **processingState**: *eq, in, sw, isnull, pr* **protected**: *eq* **correlated**: *eq* **inactive**: *eq* **isManager**: *eq* **locked**: *eq* **disabled**: *eq* **manager.id**: *eq, in, sw* **manager.name**: *eq, in, sw, isnull, pr* **manager.type**: *eq, in, sw, isnull, pr* **lifecycleState.stateName**: *eq, in, sw, isnull, pr* **lifecycleState.manuallyUpdated**: *eq* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **lastRefresh**: *eq, ge, gt, le, lt* **privilegeLevel.effective**: *eq, in, isnull, pr*
|
|
1581
|
+
* @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: **id, name, alias, type, emailAddress, identityStatus, processingState, protected, correlated, inactive, isManager, locked, disabled, manager.id, manager.name, manager.type, lifecycleState.stateName, lifecycleState.manuallyUpdated, created, modified, synced, lastRefresh, privilegeLevel.effective** Sorting on **privilegeLevel.effective** is case-insensitive and is accepted only when `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` is enabled. Returned values are uppercase. Default sort is **created** when no collection parameters are sent.
|
|
1582
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1583
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1584
|
+
* @throws {RequiredError}
|
|
1585
|
+
*/
|
|
1586
|
+
listIdentitiesV2: (limit?: number, offset?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1373
1587
|
/**
|
|
1374
1588
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1375
1589
|
* @summary Reset an identity
|
|
@@ -1445,6 +1659,15 @@ export declare const IdentitiesApiFp: (configuration?: Configuration) => {
|
|
|
1445
1659
|
* @throws {RequiredError}
|
|
1446
1660
|
*/
|
|
1447
1661
|
getIdentityV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Identity>>;
|
|
1662
|
+
/**
|
|
1663
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
1664
|
+
* @summary Identity details (search)
|
|
1665
|
+
* @param {string} id Identity Id
|
|
1666
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1667
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1668
|
+
* @throws {RequiredError}
|
|
1669
|
+
*/
|
|
1670
|
+
getIdentityV2(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<IdentityV2>>;
|
|
1448
1671
|
/**
|
|
1449
1672
|
*
|
|
1450
1673
|
* @summary Role assignment details
|
|
@@ -1488,6 +1711,20 @@ export declare const IdentitiesApiFp: (configuration?: Configuration) => {
|
|
|
1488
1711
|
* @throws {RequiredError}
|
|
1489
1712
|
*/
|
|
1490
1713
|
listIdentitiesV1(filters?: string, sorters?: string, defaultFilter?: ListIdentitiesV1DefaultFilterEnum, count?: boolean, limit?: number, offset?: number, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Identity>>>;
|
|
1714
|
+
/**
|
|
1715
|
+
* List identities from the identities search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
1716
|
+
* @summary List identities (search)
|
|
1717
|
+
* @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.
|
|
1718
|
+
* @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.
|
|
1719
|
+
* @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.
|
|
1720
|
+
* @param {string} [searchAfter] Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=John Mathews,01f04e428c484542a241dc89c303b178&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
1721
|
+
* @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, sw* **name**: *eq, in, sw, isnull, pr* **alias**: *eq, in, sw, isnull, pr* **type**: *eq, in, sw, isnull, pr* **emailAddress**: *eq, in, sw, isnull, pr* **identityStatus**: *eq, in, sw, isnull, pr* **processingState**: *eq, in, sw, isnull, pr* **protected**: *eq* **correlated**: *eq* **inactive**: *eq* **isManager**: *eq* **locked**: *eq* **disabled**: *eq* **manager.id**: *eq, in, sw* **manager.name**: *eq, in, sw, isnull, pr* **manager.type**: *eq, in, sw, isnull, pr* **lifecycleState.stateName**: *eq, in, sw, isnull, pr* **lifecycleState.manuallyUpdated**: *eq* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **lastRefresh**: *eq, ge, gt, le, lt* **privilegeLevel.effective**: *eq, in, isnull, pr*
|
|
1722
|
+
* @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: **id, name, alias, type, emailAddress, identityStatus, processingState, protected, correlated, inactive, isManager, locked, disabled, manager.id, manager.name, manager.type, lifecycleState.stateName, lifecycleState.manuallyUpdated, created, modified, synced, lastRefresh, privilegeLevel.effective** Sorting on **privilegeLevel.effective** is case-insensitive and is accepted only when `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` is enabled. Returned values are uppercase. Default sort is **created** when no collection parameters are sent.
|
|
1723
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1724
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1725
|
+
* @throws {RequiredError}
|
|
1726
|
+
*/
|
|
1727
|
+
listIdentitiesV2(limit?: number, offset?: number, count?: boolean, searchAfter?: string, filters?: string, sorters?: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<IdentityV2>>>;
|
|
1491
1728
|
/**
|
|
1492
1729
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1493
1730
|
* @summary Reset an identity
|
|
@@ -1563,6 +1800,14 @@ export declare const IdentitiesApiFactory: (configuration?: Configuration, baseP
|
|
|
1563
1800
|
* @throws {RequiredError}
|
|
1564
1801
|
*/
|
|
1565
1802
|
getIdentityV1(requestParameters: IdentitiesApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Identity>;
|
|
1803
|
+
/**
|
|
1804
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
1805
|
+
* @summary Identity details (search)
|
|
1806
|
+
* @param {IdentitiesApiGetIdentityV2Request} requestParameters Request parameters.
|
|
1807
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1808
|
+
* @throws {RequiredError}
|
|
1809
|
+
*/
|
|
1810
|
+
getIdentityV2(requestParameters: IdentitiesApiGetIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<IdentityV2>;
|
|
1566
1811
|
/**
|
|
1567
1812
|
*
|
|
1568
1813
|
* @summary Role assignment details
|
|
@@ -1595,6 +1840,14 @@ export declare const IdentitiesApiFactory: (configuration?: Configuration, baseP
|
|
|
1595
1840
|
* @throws {RequiredError}
|
|
1596
1841
|
*/
|
|
1597
1842
|
listIdentitiesV1(requestParameters?: IdentitiesApiListIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Identity>>;
|
|
1843
|
+
/**
|
|
1844
|
+
* List identities from the identities search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
1845
|
+
* @summary List identities (search)
|
|
1846
|
+
* @param {IdentitiesApiListIdentitiesV2Request} requestParameters Request parameters.
|
|
1847
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1848
|
+
* @throws {RequiredError}
|
|
1849
|
+
*/
|
|
1850
|
+
listIdentitiesV2(requestParameters?: IdentitiesApiListIdentitiesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<IdentityV2>>;
|
|
1598
1851
|
/**
|
|
1599
1852
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1600
1853
|
* @summary Reset an identity
|
|
@@ -1675,6 +1928,25 @@ export interface IdentitiesApiGetIdentityV1Request {
|
|
|
1675
1928
|
*/
|
|
1676
1929
|
readonly id: string;
|
|
1677
1930
|
}
|
|
1931
|
+
/**
|
|
1932
|
+
* Request parameters for getIdentityV2 operation in IdentitiesApi.
|
|
1933
|
+
* @export
|
|
1934
|
+
* @interface IdentitiesApiGetIdentityV2Request
|
|
1935
|
+
*/
|
|
1936
|
+
export interface IdentitiesApiGetIdentityV2Request {
|
|
1937
|
+
/**
|
|
1938
|
+
* Identity Id
|
|
1939
|
+
* @type {string}
|
|
1940
|
+
* @memberof IdentitiesApiGetIdentityV2
|
|
1941
|
+
*/
|
|
1942
|
+
readonly id: string;
|
|
1943
|
+
/**
|
|
1944
|
+
* Use this header to enable this experimental API.
|
|
1945
|
+
* @type {string}
|
|
1946
|
+
* @memberof IdentitiesApiGetIdentityV2
|
|
1947
|
+
*/
|
|
1948
|
+
readonly xSailPointExperimental?: string;
|
|
1949
|
+
}
|
|
1678
1950
|
/**
|
|
1679
1951
|
* Request parameters for getRoleAssignmentV1 operation in IdentitiesApi.
|
|
1680
1952
|
* @export
|
|
@@ -1793,6 +2065,55 @@ export interface IdentitiesApiListIdentitiesV1Request {
|
|
|
1793
2065
|
*/
|
|
1794
2066
|
readonly offset?: number;
|
|
1795
2067
|
}
|
|
2068
|
+
/**
|
|
2069
|
+
* Request parameters for listIdentitiesV2 operation in IdentitiesApi.
|
|
2070
|
+
* @export
|
|
2071
|
+
* @interface IdentitiesApiListIdentitiesV2Request
|
|
2072
|
+
*/
|
|
2073
|
+
export interface IdentitiesApiListIdentitiesV2Request {
|
|
2074
|
+
/**
|
|
2075
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2076
|
+
* @type {number}
|
|
2077
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2078
|
+
*/
|
|
2079
|
+
readonly limit?: number;
|
|
2080
|
+
/**
|
|
2081
|
+
* 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.
|
|
2082
|
+
* @type {number}
|
|
2083
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2084
|
+
*/
|
|
2085
|
+
readonly offset?: number;
|
|
2086
|
+
/**
|
|
2087
|
+
* 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.
|
|
2088
|
+
* @type {boolean}
|
|
2089
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2090
|
+
*/
|
|
2091
|
+
readonly count?: boolean;
|
|
2092
|
+
/**
|
|
2093
|
+
* Used to begin the search window at the values specified. This parameter consists of the last values of the sorted fields in the current record set. searchAfter length must match the number of sorters. This is used to page beyond the offset limit of 10,000 records by shifting the search window to begin at this value. `searchAfter` cannot be combined with `offset`. When `searchAfter` is provided, `id` must be included in `sorters`. It is recommended that you always include the ID of the object in addition to any other sort fields in order to ensure you don\'t get duplicate results while paging. For example, if you are sorting by name you will also want to include ID, for example searchAfter=John Mathews,01f04e428c484542a241dc89c303b178&sorters=name,id. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information about how to implement `searchAfter` paging.
|
|
2094
|
+
* @type {string}
|
|
2095
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2096
|
+
*/
|
|
2097
|
+
readonly searchAfter?: string;
|
|
2098
|
+
/**
|
|
2099
|
+
* 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, sw* **name**: *eq, in, sw, isnull, pr* **alias**: *eq, in, sw, isnull, pr* **type**: *eq, in, sw, isnull, pr* **emailAddress**: *eq, in, sw, isnull, pr* **identityStatus**: *eq, in, sw, isnull, pr* **processingState**: *eq, in, sw, isnull, pr* **protected**: *eq* **correlated**: *eq* **inactive**: *eq* **isManager**: *eq* **locked**: *eq* **disabled**: *eq* **manager.id**: *eq, in, sw* **manager.name**: *eq, in, sw, isnull, pr* **manager.type**: *eq, in, sw, isnull, pr* **lifecycleState.stateName**: *eq, in, sw, isnull, pr* **lifecycleState.manuallyUpdated**: *eq* **created**: *eq, ge, gt, le, lt* **modified**: *eq, ge, gt, le, lt* **synced**: *eq, ge, gt, le, lt* **lastRefresh**: *eq, ge, gt, le, lt* **privilegeLevel.effective**: *eq, in, isnull, pr*
|
|
2100
|
+
* @type {string}
|
|
2101
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2102
|
+
*/
|
|
2103
|
+
readonly filters?: string;
|
|
2104
|
+
/**
|
|
2105
|
+
* 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: **id, name, alias, type, emailAddress, identityStatus, processingState, protected, correlated, inactive, isManager, locked, disabled, manager.id, manager.name, manager.type, lifecycleState.stateName, lifecycleState.manuallyUpdated, created, modified, synced, lastRefresh, privilegeLevel.effective** Sorting on **privilegeLevel.effective** is case-insensitive and is accepted only when `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` is enabled. Returned values are uppercase. Default sort is **created** when no collection parameters are sent.
|
|
2106
|
+
* @type {string}
|
|
2107
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2108
|
+
*/
|
|
2109
|
+
readonly sorters?: string;
|
|
2110
|
+
/**
|
|
2111
|
+
* Use this header to enable this experimental API.
|
|
2112
|
+
* @type {string}
|
|
2113
|
+
* @memberof IdentitiesApiListIdentitiesV2
|
|
2114
|
+
*/
|
|
2115
|
+
readonly xSailPointExperimental?: string;
|
|
2116
|
+
}
|
|
1796
2117
|
/**
|
|
1797
2118
|
* Request parameters for resetIdentityV1 operation in IdentitiesApi.
|
|
1798
2119
|
* @export
|
|
@@ -1922,6 +2243,15 @@ export declare class IdentitiesApi extends BaseAPI {
|
|
|
1922
2243
|
* @memberof IdentitiesApi
|
|
1923
2244
|
*/
|
|
1924
2245
|
getIdentityV1(requestParameters: IdentitiesApiGetIdentityV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Identity, any>>;
|
|
2246
|
+
/**
|
|
2247
|
+
* This API returns a single identity from the identities search index. `privilegeLevel.effective` is `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level is returned as `NONE`. `privilegeLevel` is null when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is disabled. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase.
|
|
2248
|
+
* @summary Identity details (search)
|
|
2249
|
+
* @param {IdentitiesApiGetIdentityV2Request} requestParameters Request parameters.
|
|
2250
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2251
|
+
* @throws {RequiredError}
|
|
2252
|
+
* @memberof IdentitiesApi
|
|
2253
|
+
*/
|
|
2254
|
+
getIdentityV2(requestParameters: IdentitiesApiGetIdentityV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityV2, any>>;
|
|
1925
2255
|
/**
|
|
1926
2256
|
*
|
|
1927
2257
|
* @summary Role assignment details
|
|
@@ -1958,6 +2288,15 @@ export declare class IdentitiesApi extends BaseAPI {
|
|
|
1958
2288
|
* @memberof IdentitiesApi
|
|
1959
2289
|
*/
|
|
1960
2290
|
listIdentitiesV1(requestParameters?: IdentitiesApiListIdentitiesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Identity[], any>>;
|
|
2291
|
+
/**
|
|
2292
|
+
* List identities from the identities search index. Use standard collection parameters for paging (`limit`, `offset`, `count`). Default page size is 25 when no collection parameters are sent. Maximum `limit` is 250. Requests that specify a larger `limit` are capped at 250. `offset + limit` cannot exceed 10,000. To page beyond that window, use `searchAfter` instead of a large offset. `searchAfter` cannot be combined with `offset`. Always include `id` in `sorters` when using `searchAfter`. Refer to [Paginating Search Queries](https://developer.sailpoint.com/idn/api/standard-collection-parameters#paginating-search-queries) for more information. `privilegeLevel` is returned when the `IDNARC_ENABLE_IDENTITY_EFFECTIVE_PRIVILEGE` feature flag is enabled. When the flag is disabled, `privilegeLevel` is null and a filter or sort on `privilegeLevel.effective` is rejected. When the flag is enabled, an identity with no privilege level is returned as `NONE`. Comparisons on `privilegeLevel.effective` are case-insensitive, and returned values are uppercase: `HIGH`, `MEDIUM`, `LOW`, or `NONE`. An identity with no privilege level matches `privilegeLevel.effective eq \"NONE\"` and does not match `isnull`.
|
|
2293
|
+
* @summary List identities (search)
|
|
2294
|
+
* @param {IdentitiesApiListIdentitiesV2Request} requestParameters Request parameters.
|
|
2295
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2296
|
+
* @throws {RequiredError}
|
|
2297
|
+
* @memberof IdentitiesApi
|
|
2298
|
+
*/
|
|
2299
|
+
listIdentitiesV2(requestParameters?: IdentitiesApiListIdentitiesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<IdentityV2[], any>>;
|
|
1961
2300
|
/**
|
|
1962
2301
|
* Use this endpoint to reset a user\'s identity if they have forgotten their authentication information like their answers to knowledge-based questions. Resetting an identity de-registers the user and removes any elevated user levels they have.
|
|
1963
2302
|
* @summary Reset an identity
|