@sailpoint/api-client 2.2.50 → 2.2.51
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/access_profiles/api.d.ts +1110 -3
- package/dist/access_profiles/api.js +964 -6
- package/dist/access_profiles/api.js.map +1 -1
- package/dist/data_access_security/api.d.ts +10 -10
- package/dist/data_access_security/api.js +8 -8
- package/dist/data_access_security/api.js.map +1 -1
- package/dist/esm/access_profiles/api.js +963 -5
- package/dist/esm/data_access_security/api.js +8 -8
- package/dist/esm/nerm/common.js +2 -2
- package/dist/esm/nermv2025/common.js +2 -2
- 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/sailpoint-scopes.json +163 -18
|
@@ -316,6 +316,71 @@ export interface AccessProfileBulkUpdateRequestInner {
|
|
|
316
316
|
*/
|
|
317
317
|
'requestable'?: boolean;
|
|
318
318
|
}
|
|
319
|
+
/**
|
|
320
|
+
*
|
|
321
|
+
* @export
|
|
322
|
+
* @interface AccessProfileEntitlementPrivilegeLevel
|
|
323
|
+
*/
|
|
324
|
+
export interface AccessProfileEntitlementPrivilegeLevel {
|
|
325
|
+
/**
|
|
326
|
+
* Direct privilege level assigned to the entitlement
|
|
327
|
+
* @type {string}
|
|
328
|
+
* @memberof AccessProfileEntitlementPrivilegeLevel
|
|
329
|
+
*/
|
|
330
|
+
'direct'?: AccessProfileEntitlementPrivilegeLevelDirectEnum;
|
|
331
|
+
/**
|
|
332
|
+
* User or process that set the privilege level
|
|
333
|
+
* @type {string}
|
|
334
|
+
* @memberof AccessProfileEntitlementPrivilegeLevel
|
|
335
|
+
*/
|
|
336
|
+
'setBy'?: string;
|
|
337
|
+
/**
|
|
338
|
+
* Method by which the privilege level was set
|
|
339
|
+
* @type {string}
|
|
340
|
+
* @memberof AccessProfileEntitlementPrivilegeLevel
|
|
341
|
+
*/
|
|
342
|
+
'setByType'?: AccessProfileEntitlementPrivilegeLevelSetByTypeEnum | null;
|
|
343
|
+
/**
|
|
344
|
+
* Inherited privilege level on the entitlement, if any
|
|
345
|
+
* @type {string}
|
|
346
|
+
* @memberof AccessProfileEntitlementPrivilegeLevel
|
|
347
|
+
*/
|
|
348
|
+
'inherited'?: AccessProfileEntitlementPrivilegeLevelInheritedEnum | null;
|
|
349
|
+
/**
|
|
350
|
+
* Effective privilege level assigned to the entitlement
|
|
351
|
+
* @type {string}
|
|
352
|
+
* @memberof AccessProfileEntitlementPrivilegeLevel
|
|
353
|
+
*/
|
|
354
|
+
'effective'?: AccessProfileEntitlementPrivilegeLevelEffectiveEnum;
|
|
355
|
+
}
|
|
356
|
+
export declare const AccessProfileEntitlementPrivilegeLevelDirectEnum: {
|
|
357
|
+
readonly High: "HIGH";
|
|
358
|
+
readonly Low: "LOW";
|
|
359
|
+
readonly Medium: "MEDIUM";
|
|
360
|
+
readonly None: "NONE";
|
|
361
|
+
};
|
|
362
|
+
export type AccessProfileEntitlementPrivilegeLevelDirectEnum = typeof AccessProfileEntitlementPrivilegeLevelDirectEnum[keyof typeof AccessProfileEntitlementPrivilegeLevelDirectEnum];
|
|
363
|
+
export declare const AccessProfileEntitlementPrivilegeLevelSetByTypeEnum: {
|
|
364
|
+
readonly Override: "OVERRIDE";
|
|
365
|
+
readonly CustomCriteria: "CUSTOM_CRITERIA";
|
|
366
|
+
readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
|
|
367
|
+
readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
|
|
368
|
+
};
|
|
369
|
+
export type AccessProfileEntitlementPrivilegeLevelSetByTypeEnum = typeof AccessProfileEntitlementPrivilegeLevelSetByTypeEnum[keyof typeof AccessProfileEntitlementPrivilegeLevelSetByTypeEnum];
|
|
370
|
+
export declare const AccessProfileEntitlementPrivilegeLevelInheritedEnum: {
|
|
371
|
+
readonly High: "HIGH";
|
|
372
|
+
readonly Low: "LOW";
|
|
373
|
+
readonly Medium: "MEDIUM";
|
|
374
|
+
readonly None: "NONE";
|
|
375
|
+
};
|
|
376
|
+
export type AccessProfileEntitlementPrivilegeLevelInheritedEnum = typeof AccessProfileEntitlementPrivilegeLevelInheritedEnum[keyof typeof AccessProfileEntitlementPrivilegeLevelInheritedEnum];
|
|
377
|
+
export declare const AccessProfileEntitlementPrivilegeLevelEffectiveEnum: {
|
|
378
|
+
readonly High: "HIGH";
|
|
379
|
+
readonly Low: "LOW";
|
|
380
|
+
readonly Medium: "MEDIUM";
|
|
381
|
+
readonly None: "NONE";
|
|
382
|
+
};
|
|
383
|
+
export type AccessProfileEntitlementPrivilegeLevelEffectiveEnum = typeof AccessProfileEntitlementPrivilegeLevelEffectiveEnum[keyof typeof AccessProfileEntitlementPrivilegeLevelEffectiveEnum];
|
|
319
384
|
/**
|
|
320
385
|
* Filter criteria and Access Model Metadata key/values used to select access profiles.
|
|
321
386
|
* @export
|
|
@@ -354,6 +419,25 @@ export interface AccessProfileListFilterDTOAmmKeyValuesInner {
|
|
|
354
419
|
*/
|
|
355
420
|
'values'?: Array<string>;
|
|
356
421
|
}
|
|
422
|
+
/**
|
|
423
|
+
* Filter criteria and Access Model Metadata key/values used to select access profiles.
|
|
424
|
+
* @export
|
|
425
|
+
* @interface AccessProfileListFilterV2
|
|
426
|
+
*/
|
|
427
|
+
export interface AccessProfileListFilterV2 {
|
|
428
|
+
/**
|
|
429
|
+
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **requestable**: *eq* **source.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
430
|
+
* @type {string}
|
|
431
|
+
* @memberof AccessProfileListFilterV2
|
|
432
|
+
*/
|
|
433
|
+
'filters'?: string | null;
|
|
434
|
+
/**
|
|
435
|
+
* The Access Model Metadata attributes and values used to filter the results.
|
|
436
|
+
* @type {Array<AccessProfileListFilterDTOAmmKeyValuesInner>}
|
|
437
|
+
* @memberof AccessProfileListFilterV2
|
|
438
|
+
*/
|
|
439
|
+
'ammKeyValues'?: Array<AccessProfileListFilterDTOAmmKeyValuesInner> | null;
|
|
440
|
+
}
|
|
357
441
|
/**
|
|
358
442
|
* Request to bulk update Access Model Metadata on every access profile matching a filter expression. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
359
443
|
* @export
|
|
@@ -549,6 +633,27 @@ export declare const AccessProfileMetadataBulkUpdateResponseStatusEnum: {
|
|
|
549
633
|
readonly Failed: "FAILED";
|
|
550
634
|
};
|
|
551
635
|
export type AccessProfileMetadataBulkUpdateResponseStatusEnum = typeof AccessProfileMetadataBulkUpdateResponseStatusEnum[keyof typeof AccessProfileMetadataBulkUpdateResponseStatusEnum];
|
|
636
|
+
/**
|
|
637
|
+
* Effective privilege level calculated for the access profile.
|
|
638
|
+
* @export
|
|
639
|
+
* @interface AccessProfilePrivilegeLevel
|
|
640
|
+
*/
|
|
641
|
+
export interface AccessProfilePrivilegeLevel {
|
|
642
|
+
/**
|
|
643
|
+
* Effective privilege level of the access profile, derived from the highest privilege level of the entitlements it contains. `UNDETERMINED` indicates the level could not be calculated.
|
|
644
|
+
* @type {string}
|
|
645
|
+
* @memberof AccessProfilePrivilegeLevel
|
|
646
|
+
*/
|
|
647
|
+
'effective'?: AccessProfilePrivilegeLevelEffectiveEnum;
|
|
648
|
+
}
|
|
649
|
+
export declare const AccessProfilePrivilegeLevelEffectiveEnum: {
|
|
650
|
+
readonly None: "NONE";
|
|
651
|
+
readonly Low: "LOW";
|
|
652
|
+
readonly Medium: "MEDIUM";
|
|
653
|
+
readonly High: "HIGH";
|
|
654
|
+
readonly Undetermined: "UNDETERMINED";
|
|
655
|
+
};
|
|
656
|
+
export type AccessProfilePrivilegeLevelEffectiveEnum = typeof AccessProfilePrivilegeLevelEffectiveEnum[keyof typeof AccessProfilePrivilegeLevelEffectiveEnum];
|
|
552
657
|
/**
|
|
553
658
|
*
|
|
554
659
|
* @export
|
|
@@ -657,6 +762,273 @@ export declare const AccessProfileUsageUsedByInnerTypeEnum: {
|
|
|
657
762
|
readonly Role: "ROLE";
|
|
658
763
|
};
|
|
659
764
|
export type AccessProfileUsageUsedByInnerTypeEnum = typeof AccessProfileUsageUsedByInnerTypeEnum[keyof typeof AccessProfileUsageUsedByInnerTypeEnum];
|
|
765
|
+
/**
|
|
766
|
+
*
|
|
767
|
+
* @export
|
|
768
|
+
* @interface Accessprofileentitlementv2
|
|
769
|
+
*/
|
|
770
|
+
export interface Accessprofileentitlementv2 {
|
|
771
|
+
/**
|
|
772
|
+
* The entitlement id
|
|
773
|
+
* @type {string}
|
|
774
|
+
* @memberof Accessprofileentitlementv2
|
|
775
|
+
*/
|
|
776
|
+
'id'?: string;
|
|
777
|
+
/**
|
|
778
|
+
* The entitlement name
|
|
779
|
+
* @type {string}
|
|
780
|
+
* @memberof Accessprofileentitlementv2
|
|
781
|
+
*/
|
|
782
|
+
'name'?: string;
|
|
783
|
+
/**
|
|
784
|
+
* The entitlement attribute name
|
|
785
|
+
* @type {string}
|
|
786
|
+
* @memberof Accessprofileentitlementv2
|
|
787
|
+
*/
|
|
788
|
+
'attribute'?: string;
|
|
789
|
+
/**
|
|
790
|
+
* The value of the entitlement
|
|
791
|
+
* @type {string}
|
|
792
|
+
* @memberof Accessprofileentitlementv2
|
|
793
|
+
*/
|
|
794
|
+
'value'?: string;
|
|
795
|
+
/**
|
|
796
|
+
* The object type of the entitlement from the source schema
|
|
797
|
+
* @type {string}
|
|
798
|
+
* @memberof Accessprofileentitlementv2
|
|
799
|
+
*/
|
|
800
|
+
'sourceSchemaObjectType'?: string;
|
|
801
|
+
/**
|
|
802
|
+
* The description of the entitlement
|
|
803
|
+
* @type {string}
|
|
804
|
+
* @memberof Accessprofileentitlementv2
|
|
805
|
+
*/
|
|
806
|
+
'description'?: string | null;
|
|
807
|
+
/**
|
|
808
|
+
* True if the entitlement is privileged
|
|
809
|
+
* @type {boolean}
|
|
810
|
+
* @memberof Accessprofileentitlementv2
|
|
811
|
+
*/
|
|
812
|
+
'privileged'?: boolean;
|
|
813
|
+
/**
|
|
814
|
+
* True if the entitlement is cloud governed
|
|
815
|
+
* @type {boolean}
|
|
816
|
+
* @memberof Accessprofileentitlementv2
|
|
817
|
+
*/
|
|
818
|
+
'cloudGoverned'?: boolean;
|
|
819
|
+
/**
|
|
820
|
+
* True if the entitlement is able to be directly requested
|
|
821
|
+
* @type {boolean}
|
|
822
|
+
* @memberof Accessprofileentitlementv2
|
|
823
|
+
*/
|
|
824
|
+
'requestable'?: boolean;
|
|
825
|
+
/**
|
|
826
|
+
*
|
|
827
|
+
* @type {EntitlementOwner}
|
|
828
|
+
* @memberof Accessprofileentitlementv2
|
|
829
|
+
*/
|
|
830
|
+
'owner'?: EntitlementOwner | null;
|
|
831
|
+
/**
|
|
832
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
833
|
+
* @type {Array<AdditionalOwnerRef>}
|
|
834
|
+
* @memberof Accessprofileentitlementv2
|
|
835
|
+
*/
|
|
836
|
+
'additionalOwners'?: Array<AdditionalOwnerRef> | null;
|
|
837
|
+
/**
|
|
838
|
+
* A map of entitlement fields that have been manually updated. The key is the field name in UPPER_SNAKE_CASE format, and the value is true or false to indicate if the field has been updated.
|
|
839
|
+
* @type {{ [key: string]: any; }}
|
|
840
|
+
* @memberof Accessprofileentitlementv2
|
|
841
|
+
*/
|
|
842
|
+
'manuallyUpdatedFields'?: {
|
|
843
|
+
[key: string]: any;
|
|
844
|
+
} | null;
|
|
845
|
+
/**
|
|
846
|
+
*
|
|
847
|
+
* @type {EntitlementAccessModelMetadata}
|
|
848
|
+
* @memberof Accessprofileentitlementv2
|
|
849
|
+
*/
|
|
850
|
+
'accessModelMetadata'?: EntitlementAccessModelMetadata;
|
|
851
|
+
/**
|
|
852
|
+
* Time when the entitlement was created
|
|
853
|
+
* @type {string}
|
|
854
|
+
* @memberof Accessprofileentitlementv2
|
|
855
|
+
*/
|
|
856
|
+
'created'?: string;
|
|
857
|
+
/**
|
|
858
|
+
* Time when the entitlement was last modified
|
|
859
|
+
* @type {string}
|
|
860
|
+
* @memberof Accessprofileentitlementv2
|
|
861
|
+
*/
|
|
862
|
+
'modified'?: string;
|
|
863
|
+
/**
|
|
864
|
+
*
|
|
865
|
+
* @type {EntitlementSource}
|
|
866
|
+
* @memberof Accessprofileentitlementv2
|
|
867
|
+
*/
|
|
868
|
+
'source'?: EntitlementSource;
|
|
869
|
+
/**
|
|
870
|
+
* A map of free-form key-value pairs from the source system
|
|
871
|
+
* @type {{ [key: string]: any; }}
|
|
872
|
+
* @memberof Accessprofileentitlementv2
|
|
873
|
+
*/
|
|
874
|
+
'attributes'?: {
|
|
875
|
+
[key: string]: any;
|
|
876
|
+
};
|
|
877
|
+
/**
|
|
878
|
+
* List of IDs of segments, if any, to which this Entitlement is assigned.
|
|
879
|
+
* @type {Array<string>}
|
|
880
|
+
* @memberof Accessprofileentitlementv2
|
|
881
|
+
*/
|
|
882
|
+
'segments'?: Array<string> | null;
|
|
883
|
+
/**
|
|
884
|
+
*
|
|
885
|
+
* @type {Array<PermissionDTO>}
|
|
886
|
+
* @memberof Accessprofileentitlementv2
|
|
887
|
+
*/
|
|
888
|
+
'directPermissions'?: Array<PermissionDTO>;
|
|
889
|
+
/**
|
|
890
|
+
* List of tags assigned to the entitlement
|
|
891
|
+
* @type {Array<string>}
|
|
892
|
+
* @memberof Accessprofileentitlementv2
|
|
893
|
+
*/
|
|
894
|
+
'tags'?: Array<string> | null;
|
|
895
|
+
/**
|
|
896
|
+
*
|
|
897
|
+
* @type {AccessProfileEntitlementPrivilegeLevel}
|
|
898
|
+
* @memberof Accessprofileentitlementv2
|
|
899
|
+
*/
|
|
900
|
+
'privilegeLevel'?: AccessProfileEntitlementPrivilegeLevel;
|
|
901
|
+
}
|
|
902
|
+
/**
|
|
903
|
+
* Access profile.
|
|
904
|
+
* @export
|
|
905
|
+
* @interface Accessprofilev2
|
|
906
|
+
*/
|
|
907
|
+
export interface Accessprofilev2 {
|
|
908
|
+
/**
|
|
909
|
+
* Access profile ID.
|
|
910
|
+
* @type {string}
|
|
911
|
+
* @memberof Accessprofilev2
|
|
912
|
+
*/
|
|
913
|
+
'id'?: string;
|
|
914
|
+
/**
|
|
915
|
+
* Access profile name.
|
|
916
|
+
* @type {string}
|
|
917
|
+
* @memberof Accessprofilev2
|
|
918
|
+
*/
|
|
919
|
+
'name': string;
|
|
920
|
+
/**
|
|
921
|
+
* Access profile description.
|
|
922
|
+
* @type {string}
|
|
923
|
+
* @memberof Accessprofilev2
|
|
924
|
+
*/
|
|
925
|
+
'description'?: string | null;
|
|
926
|
+
/**
|
|
927
|
+
* Date and time when the access profile was created.
|
|
928
|
+
* @type {string}
|
|
929
|
+
* @memberof Accessprofilev2
|
|
930
|
+
*/
|
|
931
|
+
'created'?: string;
|
|
932
|
+
/**
|
|
933
|
+
* Date and time when the access profile was last modified.
|
|
934
|
+
* @type {string}
|
|
935
|
+
* @memberof Accessprofilev2
|
|
936
|
+
*/
|
|
937
|
+
'modified'?: string;
|
|
938
|
+
/**
|
|
939
|
+
* Indicates whether the access profile is enabled. If it\'s enabled, you must include at least one entitlement.
|
|
940
|
+
* @type {boolean}
|
|
941
|
+
* @memberof Accessprofilev2
|
|
942
|
+
*/
|
|
943
|
+
'enabled'?: boolean;
|
|
944
|
+
/**
|
|
945
|
+
*
|
|
946
|
+
* @type {OwnerReference}
|
|
947
|
+
* @memberof Accessprofilev2
|
|
948
|
+
*/
|
|
949
|
+
'owner': OwnerReference | null;
|
|
950
|
+
/**
|
|
951
|
+
*
|
|
952
|
+
* @type {AccessProfileSourceRef}
|
|
953
|
+
* @memberof Accessprofilev2
|
|
954
|
+
*/
|
|
955
|
+
'source': AccessProfileSourceRef;
|
|
956
|
+
/**
|
|
957
|
+
* List of entitlements associated with the access profile. If `enabled` is false, this can be empty. Otherwise, it must contain at least one entitlement.
|
|
958
|
+
* @type {Array<EntitlementRef>}
|
|
959
|
+
* @memberof Accessprofilev2
|
|
960
|
+
*/
|
|
961
|
+
'entitlements'?: Array<EntitlementRef> | null;
|
|
962
|
+
/**
|
|
963
|
+
* Indicates whether the access profile is requestable by access request. Currently, making an access profile non-requestable is only supported for customers enabled with the new Request Center. Otherwise, attempting to create an access profile with a value **false** in this field results in a 400 error.
|
|
964
|
+
* @type {boolean}
|
|
965
|
+
* @memberof Accessprofilev2
|
|
966
|
+
*/
|
|
967
|
+
'requestable'?: boolean;
|
|
968
|
+
/**
|
|
969
|
+
*
|
|
970
|
+
* @type {Requestability}
|
|
971
|
+
* @memberof Accessprofilev2
|
|
972
|
+
*/
|
|
973
|
+
'accessRequestConfig'?: Requestability | null;
|
|
974
|
+
/**
|
|
975
|
+
*
|
|
976
|
+
* @type {Revocability}
|
|
977
|
+
* @memberof Accessprofilev2
|
|
978
|
+
*/
|
|
979
|
+
'revocationRequestConfig'?: Revocability | null;
|
|
980
|
+
/**
|
|
981
|
+
* List of segment IDs, if any, that the access profile is assigned to.
|
|
982
|
+
* @type {Array<string>}
|
|
983
|
+
* @memberof Accessprofilev2
|
|
984
|
+
*/
|
|
985
|
+
'segments'?: Array<string> | null;
|
|
986
|
+
/**
|
|
987
|
+
*
|
|
988
|
+
* @type {AttributeDTOList}
|
|
989
|
+
* @memberof Accessprofilev2
|
|
990
|
+
*/
|
|
991
|
+
'accessModelMetadata'?: AttributeDTOList;
|
|
992
|
+
/**
|
|
993
|
+
*
|
|
994
|
+
* @type {ProvisioningCriteriaLevel1}
|
|
995
|
+
* @memberof Accessprofilev2
|
|
996
|
+
*/
|
|
997
|
+
'provisioningCriteria'?: ProvisioningCriteriaLevel1 | null;
|
|
998
|
+
/**
|
|
999
|
+
* List of additional owner references beyond the primary owner. Each entry may be an identity (IDENTITY) or a governance group (GOVERNANCE_GROUP).
|
|
1000
|
+
* @type {Array<AdditionalOwnerRef>}
|
|
1001
|
+
* @memberof Accessprofilev2
|
|
1002
|
+
*/
|
|
1003
|
+
'additionalOwners'?: Array<AdditionalOwnerRef> | null;
|
|
1004
|
+
/**
|
|
1005
|
+
*
|
|
1006
|
+
* @type {Accessprofilev2PrivilegeLevel}
|
|
1007
|
+
* @memberof Accessprofilev2
|
|
1008
|
+
*/
|
|
1009
|
+
'privilegeLevel'?: Accessprofilev2PrivilegeLevel;
|
|
1010
|
+
}
|
|
1011
|
+
/**
|
|
1012
|
+
*
|
|
1013
|
+
* @export
|
|
1014
|
+
* @interface Accessprofilev2PrivilegeLevel
|
|
1015
|
+
*/
|
|
1016
|
+
export interface Accessprofilev2PrivilegeLevel {
|
|
1017
|
+
/**
|
|
1018
|
+
* Effective privilege level of the access profile, derived from the highest privilege level of the entitlements it contains. `UNDETERMINED` indicates the level could not be calculated.
|
|
1019
|
+
* @type {string}
|
|
1020
|
+
* @memberof Accessprofilev2PrivilegeLevel
|
|
1021
|
+
*/
|
|
1022
|
+
'effective'?: Accessprofilev2PrivilegeLevelEffectiveEnum;
|
|
1023
|
+
}
|
|
1024
|
+
export declare const Accessprofilev2PrivilegeLevelEffectiveEnum: {
|
|
1025
|
+
readonly None: "NONE";
|
|
1026
|
+
readonly Low: "LOW";
|
|
1027
|
+
readonly Medium: "MEDIUM";
|
|
1028
|
+
readonly High: "HIGH";
|
|
1029
|
+
readonly Undetermined: "UNDETERMINED";
|
|
1030
|
+
};
|
|
1031
|
+
export type Accessprofilev2PrivilegeLevelEffectiveEnum = typeof Accessprofilev2PrivilegeLevelEffectiveEnum[keyof typeof Accessprofilev2PrivilegeLevelEffectiveEnum];
|
|
660
1032
|
/**
|
|
661
1033
|
* Reference to an additional owner (identity or governance group).
|
|
662
1034
|
* @export
|
|
@@ -972,11 +1344,76 @@ export declare const EntitlementOwnerTypeEnum: {
|
|
|
972
1344
|
};
|
|
973
1345
|
export type EntitlementOwnerTypeEnum = typeof EntitlementOwnerTypeEnum[keyof typeof EntitlementOwnerTypeEnum];
|
|
974
1346
|
/**
|
|
975
|
-
*
|
|
1347
|
+
* Privilege level detail for an entitlement.
|
|
976
1348
|
* @export
|
|
977
|
-
* @interface
|
|
1349
|
+
* @interface EntitlementPrivilegeLevel
|
|
978
1350
|
*/
|
|
979
|
-
export interface
|
|
1351
|
+
export interface EntitlementPrivilegeLevel {
|
|
1352
|
+
/**
|
|
1353
|
+
* Direct privilege level assigned to the entitlement
|
|
1354
|
+
* @type {string}
|
|
1355
|
+
* @memberof EntitlementPrivilegeLevel
|
|
1356
|
+
*/
|
|
1357
|
+
'direct'?: EntitlementPrivilegeLevelDirectEnum;
|
|
1358
|
+
/**
|
|
1359
|
+
* User or process that set the privilege level
|
|
1360
|
+
* @type {string}
|
|
1361
|
+
* @memberof EntitlementPrivilegeLevel
|
|
1362
|
+
*/
|
|
1363
|
+
'setBy'?: string;
|
|
1364
|
+
/**
|
|
1365
|
+
* Method by which the privilege level was set
|
|
1366
|
+
* @type {string}
|
|
1367
|
+
* @memberof EntitlementPrivilegeLevel
|
|
1368
|
+
*/
|
|
1369
|
+
'setByType'?: EntitlementPrivilegeLevelSetByTypeEnum | null;
|
|
1370
|
+
/**
|
|
1371
|
+
* Inherited privilege level on the entitlement, if any
|
|
1372
|
+
* @type {string}
|
|
1373
|
+
* @memberof EntitlementPrivilegeLevel
|
|
1374
|
+
*/
|
|
1375
|
+
'inherited'?: EntitlementPrivilegeLevelInheritedEnum | null;
|
|
1376
|
+
/**
|
|
1377
|
+
* Effective privilege level assigned to the entitlement
|
|
1378
|
+
* @type {string}
|
|
1379
|
+
* @memberof EntitlementPrivilegeLevel
|
|
1380
|
+
*/
|
|
1381
|
+
'effective'?: EntitlementPrivilegeLevelEffectiveEnum;
|
|
1382
|
+
}
|
|
1383
|
+
export declare const EntitlementPrivilegeLevelDirectEnum: {
|
|
1384
|
+
readonly High: "HIGH";
|
|
1385
|
+
readonly Low: "LOW";
|
|
1386
|
+
readonly Medium: "MEDIUM";
|
|
1387
|
+
readonly None: "NONE";
|
|
1388
|
+
};
|
|
1389
|
+
export type EntitlementPrivilegeLevelDirectEnum = typeof EntitlementPrivilegeLevelDirectEnum[keyof typeof EntitlementPrivilegeLevelDirectEnum];
|
|
1390
|
+
export declare const EntitlementPrivilegeLevelSetByTypeEnum: {
|
|
1391
|
+
readonly Override: "OVERRIDE";
|
|
1392
|
+
readonly CustomCriteria: "CUSTOM_CRITERIA";
|
|
1393
|
+
readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
|
|
1394
|
+
readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
|
|
1395
|
+
};
|
|
1396
|
+
export type EntitlementPrivilegeLevelSetByTypeEnum = typeof EntitlementPrivilegeLevelSetByTypeEnum[keyof typeof EntitlementPrivilegeLevelSetByTypeEnum];
|
|
1397
|
+
export declare const EntitlementPrivilegeLevelInheritedEnum: {
|
|
1398
|
+
readonly High: "HIGH";
|
|
1399
|
+
readonly Low: "LOW";
|
|
1400
|
+
readonly Medium: "MEDIUM";
|
|
1401
|
+
readonly None: "NONE";
|
|
1402
|
+
};
|
|
1403
|
+
export type EntitlementPrivilegeLevelInheritedEnum = typeof EntitlementPrivilegeLevelInheritedEnum[keyof typeof EntitlementPrivilegeLevelInheritedEnum];
|
|
1404
|
+
export declare const EntitlementPrivilegeLevelEffectiveEnum: {
|
|
1405
|
+
readonly High: "HIGH";
|
|
1406
|
+
readonly Low: "LOW";
|
|
1407
|
+
readonly Medium: "MEDIUM";
|
|
1408
|
+
readonly None: "NONE";
|
|
1409
|
+
};
|
|
1410
|
+
export type EntitlementPrivilegeLevelEffectiveEnum = typeof EntitlementPrivilegeLevelEffectiveEnum[keyof typeof EntitlementPrivilegeLevelEffectiveEnum];
|
|
1411
|
+
/**
|
|
1412
|
+
* Entitlement including a specific set of access.
|
|
1413
|
+
* @export
|
|
1414
|
+
* @interface EntitlementRef
|
|
1415
|
+
*/
|
|
1416
|
+
export interface EntitlementRef {
|
|
980
1417
|
/**
|
|
981
1418
|
* Entitlement\'s DTO type.
|
|
982
1419
|
* @type {string}
|
|
@@ -1400,6 +1837,15 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1400
1837
|
* @throws {RequiredError}
|
|
1401
1838
|
*/
|
|
1402
1839
|
createAccessProfileV1: (accessProfile: AccessProfile, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1840
|
+
/**
|
|
1841
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
1842
|
+
* @summary Create access profile
|
|
1843
|
+
* @param {Accessprofilev2} accessprofilev2
|
|
1844
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1845
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1846
|
+
* @throws {RequiredError}
|
|
1847
|
+
*/
|
|
1848
|
+
createAccessProfileV2: (accessprofilev2: Accessprofilev2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1403
1849
|
/**
|
|
1404
1850
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1405
1851
|
* @summary Delete the specified access profile
|
|
@@ -1408,6 +1854,15 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1408
1854
|
* @throws {RequiredError}
|
|
1409
1855
|
*/
|
|
1410
1856
|
deleteAccessProfileV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1857
|
+
/**
|
|
1858
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1859
|
+
* @summary Delete the specified access profile
|
|
1860
|
+
* @param {string} id ID of the Access Profile to delete
|
|
1861
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1862
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1863
|
+
* @throws {RequiredError}
|
|
1864
|
+
*/
|
|
1865
|
+
deleteAccessProfileV2: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1411
1866
|
/**
|
|
1412
1867
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1413
1868
|
* @summary Delete access profile(s)
|
|
@@ -1416,6 +1871,15 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1416
1871
|
* @throws {RequiredError}
|
|
1417
1872
|
*/
|
|
1418
1873
|
deleteAccessProfilesInBulkV1: (accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1874
|
+
/**
|
|
1875
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1876
|
+
* @summary Delete access profile(s)
|
|
1877
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
1878
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1879
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1880
|
+
* @throws {RequiredError}
|
|
1881
|
+
*/
|
|
1882
|
+
deleteAccessProfilesInBulkV2: (accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1419
1883
|
/**
|
|
1420
1884
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1421
1885
|
* @summary Remove metadata from access profile
|
|
@@ -1439,6 +1903,21 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1439
1903
|
* @throws {RequiredError}
|
|
1440
1904
|
*/
|
|
1441
1905
|
getAccessProfileEntitlementsV1: (id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1906
|
+
/**
|
|
1907
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
1908
|
+
* @summary List access profile\'s entitlements
|
|
1909
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
1910
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1911
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1912
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1913
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1914
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **attribute**: *eq, co* **value**: *eq, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **privilegeLevel.effective**: *eq, in* Results are automatically scoped to entitlements belonging to the access profile.
|
|
1915
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1916
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1917
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1918
|
+
* @throws {RequiredError}
|
|
1919
|
+
*/
|
|
1920
|
+
getAccessProfileEntitlementsV2: (id: string, xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, cursor?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1442
1921
|
/**
|
|
1443
1922
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
1444
1923
|
* @summary Get an access profile
|
|
@@ -1447,6 +1926,15 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1447
1926
|
* @throws {RequiredError}
|
|
1448
1927
|
*/
|
|
1449
1928
|
getAccessProfileV1: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1929
|
+
/**
|
|
1930
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
1931
|
+
* @summary Get an access profile
|
|
1932
|
+
* @param {string} id ID of the Access Profile
|
|
1933
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1934
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1935
|
+
* @throws {RequiredError}
|
|
1936
|
+
*/
|
|
1937
|
+
getAccessProfileV2: (id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1450
1938
|
/**
|
|
1451
1939
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1452
1940
|
* @summary List access profiles
|
|
@@ -1462,6 +1950,23 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1462
1950
|
* @throws {RequiredError}
|
|
1463
1951
|
*/
|
|
1464
1952
|
listAccessProfilesV1: (forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1953
|
+
/**
|
|
1954
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
1955
|
+
* @summary List access profiles
|
|
1956
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1957
|
+
* @param {string} [forSubadmin] 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
1958
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1959
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1960
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
1961
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **requestable**: *eq* **source.id**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
1962
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
1963
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
1964
|
+
* @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.
|
|
1965
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
1966
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1967
|
+
* @throws {RequiredError}
|
|
1968
|
+
*/
|
|
1969
|
+
listAccessProfilesV2: (xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, cursor?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1465
1970
|
/**
|
|
1466
1971
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
1467
1972
|
* @summary Patch a specified access profile
|
|
@@ -1471,6 +1976,16 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1471
1976
|
* @throws {RequiredError}
|
|
1472
1977
|
*/
|
|
1473
1978
|
patchAccessProfileV1: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1979
|
+
/**
|
|
1980
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
1981
|
+
* @summary Patch a specified access profile
|
|
1982
|
+
* @param {string} id ID of the Access Profile to patch
|
|
1983
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
1984
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
1985
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1986
|
+
* @throws {RequiredError}
|
|
1987
|
+
*/
|
|
1988
|
+
patchAccessProfileV2: (id: string, jsonPatchOperation: Array<JsonPatchOperation>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1474
1989
|
/**
|
|
1475
1990
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1476
1991
|
* @summary Filter access profiles by metadata
|
|
@@ -1486,6 +2001,23 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1486
2001
|
* @throws {RequiredError}
|
|
1487
2002
|
*/
|
|
1488
2003
|
searchAccessProfilesByFilterV1: (accessProfileListFilterDTO: AccessProfileListFilterDTO, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2004
|
+
/**
|
|
2005
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
2006
|
+
* @summary List access profiles by filter
|
|
2007
|
+
* @param {AccessProfileListFilterV2} accessProfileListFilterV2
|
|
2008
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2009
|
+
* @param {string} [forSubadmin] 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
2010
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2011
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2012
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2013
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2014
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
2015
|
+
* @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.
|
|
2016
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2017
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2018
|
+
* @throws {RequiredError}
|
|
2019
|
+
*/
|
|
2020
|
+
searchAccessProfilesByFilterV2: (accessProfileListFilterV2: AccessProfileListFilterV2, xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, cursor?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1489
2021
|
/**
|
|
1490
2022
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1491
2023
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1494,6 +2026,15 @@ export declare const AccessProfilesApiAxiosParamCreator: (configuration?: Config
|
|
|
1494
2026
|
* @throws {RequiredError}
|
|
1495
2027
|
*/
|
|
1496
2028
|
updateAccessProfilesInBulkV1: (accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
2029
|
+
/**
|
|
2030
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2031
|
+
* @summary Update access profile(s) requestable field.
|
|
2032
|
+
* @param {Array<AccessProfileBulkUpdateRequestInner>} accessProfileBulkUpdateRequestInner
|
|
2033
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2034
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2035
|
+
* @throws {RequiredError}
|
|
2036
|
+
*/
|
|
2037
|
+
updateAccessProfilesInBulkV2: (accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1497
2038
|
/**
|
|
1498
2039
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1499
2040
|
* @summary Bulk-update metadata by filter
|
|
@@ -1542,6 +2083,15 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1542
2083
|
* @throws {RequiredError}
|
|
1543
2084
|
*/
|
|
1544
2085
|
createAccessProfileV1(accessProfile: AccessProfile, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
2086
|
+
/**
|
|
2087
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
2088
|
+
* @summary Create access profile
|
|
2089
|
+
* @param {Accessprofilev2} accessprofilev2
|
|
2090
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2091
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2092
|
+
* @throws {RequiredError}
|
|
2093
|
+
*/
|
|
2094
|
+
createAccessProfileV2(accessprofilev2: Accessprofilev2, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilev2>>;
|
|
1545
2095
|
/**
|
|
1546
2096
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1547
2097
|
* @summary Delete the specified access profile
|
|
@@ -1550,6 +2100,15 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1550
2100
|
* @throws {RequiredError}
|
|
1551
2101
|
*/
|
|
1552
2102
|
deleteAccessProfileV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
2103
|
+
/**
|
|
2104
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
2105
|
+
* @summary Delete the specified access profile
|
|
2106
|
+
* @param {string} id ID of the Access Profile to delete
|
|
2107
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2108
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2109
|
+
* @throws {RequiredError}
|
|
2110
|
+
*/
|
|
2111
|
+
deleteAccessProfileV2(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1553
2112
|
/**
|
|
1554
2113
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1555
2114
|
* @summary Delete access profile(s)
|
|
@@ -1558,6 +2117,15 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1558
2117
|
* @throws {RequiredError}
|
|
1559
2118
|
*/
|
|
1560
2119
|
deleteAccessProfilesInBulkV1(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileBulkDeleteResponse>>;
|
|
2120
|
+
/**
|
|
2121
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
2122
|
+
* @summary Delete access profile(s)
|
|
2123
|
+
* @param {AccessProfileBulkDeleteRequest} accessProfileBulkDeleteRequest
|
|
2124
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2125
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2126
|
+
* @throws {RequiredError}
|
|
2127
|
+
*/
|
|
2128
|
+
deleteAccessProfilesInBulkV2(accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfileBulkDeleteResponse>>;
|
|
1561
2129
|
/**
|
|
1562
2130
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1563
2131
|
* @summary Remove metadata from access profile
|
|
@@ -1581,6 +2149,21 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1581
2149
|
* @throws {RequiredError}
|
|
1582
2150
|
*/
|
|
1583
2151
|
getAccessProfileEntitlementsV1(id: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Entitlement>>>;
|
|
2152
|
+
/**
|
|
2153
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
2154
|
+
* @summary List access profile\'s entitlements
|
|
2155
|
+
* @param {string} id ID of the access profile containing the entitlements.
|
|
2156
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2157
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2158
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2159
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2160
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **attribute**: *eq, co* **value**: *eq, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **privilegeLevel.effective**: *eq, in* Results are automatically scoped to entitlements belonging to the access profile.
|
|
2161
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2162
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2163
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2164
|
+
* @throws {RequiredError}
|
|
2165
|
+
*/
|
|
2166
|
+
getAccessProfileEntitlementsV2(id: string, xSailPointExperimental?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, cursor?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Accessprofileentitlementv2>>>;
|
|
1584
2167
|
/**
|
|
1585
2168
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
1586
2169
|
* @summary Get an access profile
|
|
@@ -1589,6 +2172,15 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1589
2172
|
* @throws {RequiredError}
|
|
1590
2173
|
*/
|
|
1591
2174
|
getAccessProfileV1(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
2175
|
+
/**
|
|
2176
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
2177
|
+
* @summary Get an access profile
|
|
2178
|
+
* @param {string} id ID of the Access Profile
|
|
2179
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2180
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2181
|
+
* @throws {RequiredError}
|
|
2182
|
+
*/
|
|
2183
|
+
getAccessProfileV2(id: string, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilev2>>;
|
|
1592
2184
|
/**
|
|
1593
2185
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1594
2186
|
* @summary List access profiles
|
|
@@ -1604,6 +2196,23 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1604
2196
|
* @throws {RequiredError}
|
|
1605
2197
|
*/
|
|
1606
2198
|
listAccessProfilesV1(forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfile>>>;
|
|
2199
|
+
/**
|
|
2200
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
2201
|
+
* @summary List access profiles
|
|
2202
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2203
|
+
* @param {string} [forSubadmin] 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
2204
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2205
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2206
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2207
|
+
* @param {string} [filters] Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **requestable**: *eq* **source.id**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
2208
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2209
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
2210
|
+
* @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.
|
|
2211
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2212
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2213
|
+
* @throws {RequiredError}
|
|
2214
|
+
*/
|
|
2215
|
+
listAccessProfilesV2(xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, filters?: string, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, cursor?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Accessprofilev2>>>;
|
|
1607
2216
|
/**
|
|
1608
2217
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
1609
2218
|
* @summary Patch a specified access profile
|
|
@@ -1613,6 +2222,16 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1613
2222
|
* @throws {RequiredError}
|
|
1614
2223
|
*/
|
|
1615
2224
|
patchAccessProfileV1(id: string, jsonPatchOperation: Array<JsonPatchOperation>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AccessProfile>>;
|
|
2225
|
+
/**
|
|
2226
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
2227
|
+
* @summary Patch a specified access profile
|
|
2228
|
+
* @param {string} id ID of the Access Profile to patch
|
|
2229
|
+
* @param {Array<JsonPatchOperation>} jsonPatchOperation
|
|
2230
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2231
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2232
|
+
* @throws {RequiredError}
|
|
2233
|
+
*/
|
|
2234
|
+
patchAccessProfileV2(id: string, jsonPatchOperation: Array<JsonPatchOperation>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Accessprofilev2>>;
|
|
1616
2235
|
/**
|
|
1617
2236
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1618
2237
|
* @summary Filter access profiles by metadata
|
|
@@ -1628,6 +2247,23 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1628
2247
|
* @throws {RequiredError}
|
|
1629
2248
|
*/
|
|
1630
2249
|
searchAccessProfilesByFilterV1(accessProfileListFilterDTO: AccessProfileListFilterDTO, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfile>>>;
|
|
2250
|
+
/**
|
|
2251
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
2252
|
+
* @summary List access profiles by filter
|
|
2253
|
+
* @param {AccessProfileListFilterV2} accessProfileListFilterV2
|
|
2254
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2255
|
+
* @param {string} [forSubadmin] 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
2256
|
+
* @param {number} [limit] Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2257
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2258
|
+
* @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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2259
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2260
|
+
* @param {string} [forSegmentIds] Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
2261
|
+
* @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.
|
|
2262
|
+
* @param {string} [cursor] Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2263
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
*/
|
|
2266
|
+
searchAccessProfilesByFilterV2(accessProfileListFilterV2: AccessProfileListFilterV2, xSailPointExperimental?: string, forSubadmin?: string, limit?: number, offset?: number, count?: boolean, sorters?: string, forSegmentIds?: string, includeUnsegmented?: boolean, cursor?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Accessprofilev2>>>;
|
|
1631
2267
|
/**
|
|
1632
2268
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1633
2269
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1636,6 +2272,15 @@ export declare const AccessProfilesApiFp: (configuration?: Configuration) => {
|
|
|
1636
2272
|
* @throws {RequiredError}
|
|
1637
2273
|
*/
|
|
1638
2274
|
updateAccessProfilesInBulkV1(accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileUpdateItem>>>;
|
|
2275
|
+
/**
|
|
2276
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2277
|
+
* @summary Update access profile(s) requestable field.
|
|
2278
|
+
* @param {Array<AccessProfileBulkUpdateRequestInner>} accessProfileBulkUpdateRequestInner
|
|
2279
|
+
* @param {string} [xSailPointExperimental] Use this header to enable this experimental API.
|
|
2280
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2281
|
+
* @throws {RequiredError}
|
|
2282
|
+
*/
|
|
2283
|
+
updateAccessProfilesInBulkV2(accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>, xSailPointExperimental?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<AccessProfileUpdateItem>>>;
|
|
1639
2284
|
/**
|
|
1640
2285
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1641
2286
|
* @summary Bulk-update metadata by filter
|
|
@@ -1684,6 +2329,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1684
2329
|
* @throws {RequiredError}
|
|
1685
2330
|
*/
|
|
1686
2331
|
createAccessProfileV1(requestParameters: AccessProfilesApiCreateAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfile>;
|
|
2332
|
+
/**
|
|
2333
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
2334
|
+
* @summary Create access profile
|
|
2335
|
+
* @param {AccessProfilesApiCreateAccessProfileV2Request} requestParameters Request parameters.
|
|
2336
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2337
|
+
* @throws {RequiredError}
|
|
2338
|
+
*/
|
|
2339
|
+
createAccessProfileV2(requestParameters: AccessProfilesApiCreateAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilev2>;
|
|
1687
2340
|
/**
|
|
1688
2341
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
1689
2342
|
* @summary Delete the specified access profile
|
|
@@ -1692,6 +2345,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1692
2345
|
* @throws {RequiredError}
|
|
1693
2346
|
*/
|
|
1694
2347
|
deleteAccessProfileV1(requestParameters: AccessProfilesApiDeleteAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2348
|
+
/**
|
|
2349
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
2350
|
+
* @summary Delete the specified access profile
|
|
2351
|
+
* @param {AccessProfilesApiDeleteAccessProfileV2Request} requestParameters Request parameters.
|
|
2352
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2353
|
+
* @throws {RequiredError}
|
|
2354
|
+
*/
|
|
2355
|
+
deleteAccessProfileV2(requestParameters: AccessProfilesApiDeleteAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
1695
2356
|
/**
|
|
1696
2357
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
1697
2358
|
* @summary Delete access profile(s)
|
|
@@ -1700,6 +2361,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1700
2361
|
* @throws {RequiredError}
|
|
1701
2362
|
*/
|
|
1702
2363
|
deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileBulkDeleteResponse>;
|
|
2364
|
+
/**
|
|
2365
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
2366
|
+
* @summary Delete access profile(s)
|
|
2367
|
+
* @param {AccessProfilesApiDeleteAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
2368
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2369
|
+
* @throws {RequiredError}
|
|
2370
|
+
*/
|
|
2371
|
+
deleteAccessProfilesInBulkV2(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfileBulkDeleteResponse>;
|
|
1703
2372
|
/**
|
|
1704
2373
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
1705
2374
|
* @summary Remove metadata from access profile
|
|
@@ -1716,6 +2385,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1716
2385
|
* @throws {RequiredError}
|
|
1717
2386
|
*/
|
|
1718
2387
|
getAccessProfileEntitlementsV1(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Entitlement>>;
|
|
2388
|
+
/**
|
|
2389
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
2390
|
+
* @summary List access profile\'s entitlements
|
|
2391
|
+
* @param {AccessProfilesApiGetAccessProfileEntitlementsV2Request} requestParameters Request parameters.
|
|
2392
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2393
|
+
* @throws {RequiredError}
|
|
2394
|
+
*/
|
|
2395
|
+
getAccessProfileEntitlementsV2(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Accessprofileentitlementv2>>;
|
|
1719
2396
|
/**
|
|
1720
2397
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
1721
2398
|
* @summary Get an access profile
|
|
@@ -1724,6 +2401,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1724
2401
|
* @throws {RequiredError}
|
|
1725
2402
|
*/
|
|
1726
2403
|
getAccessProfileV1(requestParameters: AccessProfilesApiGetAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfile>;
|
|
2404
|
+
/**
|
|
2405
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
2406
|
+
* @summary Get an access profile
|
|
2407
|
+
* @param {AccessProfilesApiGetAccessProfileV2Request} requestParameters Request parameters.
|
|
2408
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2409
|
+
* @throws {RequiredError}
|
|
2410
|
+
*/
|
|
2411
|
+
getAccessProfileV2(requestParameters: AccessProfilesApiGetAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilev2>;
|
|
1727
2412
|
/**
|
|
1728
2413
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
1729
2414
|
* @summary List access profiles
|
|
@@ -1732,6 +2417,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1732
2417
|
* @throws {RequiredError}
|
|
1733
2418
|
*/
|
|
1734
2419
|
listAccessProfilesV1(requestParameters?: AccessProfilesApiListAccessProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfile>>;
|
|
2420
|
+
/**
|
|
2421
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
2422
|
+
* @summary List access profiles
|
|
2423
|
+
* @param {AccessProfilesApiListAccessProfilesV2Request} requestParameters Request parameters.
|
|
2424
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2425
|
+
* @throws {RequiredError}
|
|
2426
|
+
*/
|
|
2427
|
+
listAccessProfilesV2(requestParameters?: AccessProfilesApiListAccessProfilesV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Accessprofilev2>>;
|
|
1735
2428
|
/**
|
|
1736
2429
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
1737
2430
|
* @summary Patch a specified access profile
|
|
@@ -1740,6 +2433,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1740
2433
|
* @throws {RequiredError}
|
|
1741
2434
|
*/
|
|
1742
2435
|
patchAccessProfileV1(requestParameters: AccessProfilesApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<AccessProfile>;
|
|
2436
|
+
/**
|
|
2437
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
2438
|
+
* @summary Patch a specified access profile
|
|
2439
|
+
* @param {AccessProfilesApiPatchAccessProfileV2Request} requestParameters Request parameters.
|
|
2440
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2441
|
+
* @throws {RequiredError}
|
|
2442
|
+
*/
|
|
2443
|
+
patchAccessProfileV2(requestParameters: AccessProfilesApiPatchAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Accessprofilev2>;
|
|
1743
2444
|
/**
|
|
1744
2445
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
1745
2446
|
* @summary Filter access profiles by metadata
|
|
@@ -1748,6 +2449,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1748
2449
|
* @throws {RequiredError}
|
|
1749
2450
|
*/
|
|
1750
2451
|
searchAccessProfilesByFilterV1(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfile>>;
|
|
2452
|
+
/**
|
|
2453
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
2454
|
+
* @summary List access profiles by filter
|
|
2455
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV2Request} requestParameters Request parameters.
|
|
2456
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2457
|
+
* @throws {RequiredError}
|
|
2458
|
+
*/
|
|
2459
|
+
searchAccessProfilesByFilterV2(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<Accessprofilev2>>;
|
|
1751
2460
|
/**
|
|
1752
2461
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
1753
2462
|
* @summary Update access profile(s) requestable field.
|
|
@@ -1756,6 +2465,14 @@ export declare const AccessProfilesApiFactory: (configuration?: Configuration, b
|
|
|
1756
2465
|
* @throws {RequiredError}
|
|
1757
2466
|
*/
|
|
1758
2467
|
updateAccessProfilesInBulkV1(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfileUpdateItem>>;
|
|
2468
|
+
/**
|
|
2469
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2470
|
+
* @summary Update access profile(s) requestable field.
|
|
2471
|
+
* @param {AccessProfilesApiUpdateAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
2472
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2473
|
+
* @throws {RequiredError}
|
|
2474
|
+
*/
|
|
2475
|
+
updateAccessProfilesInBulkV2(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV2Request, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<AccessProfileUpdateItem>>;
|
|
1759
2476
|
/**
|
|
1760
2477
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
1761
2478
|
* @summary Bulk-update metadata by filter
|
|
@@ -1802,6 +2519,25 @@ export interface AccessProfilesApiCreateAccessProfileV1Request {
|
|
|
1802
2519
|
*/
|
|
1803
2520
|
readonly accessProfile: AccessProfile;
|
|
1804
2521
|
}
|
|
2522
|
+
/**
|
|
2523
|
+
* Request parameters for createAccessProfileV2 operation in AccessProfilesApi.
|
|
2524
|
+
* @export
|
|
2525
|
+
* @interface AccessProfilesApiCreateAccessProfileV2Request
|
|
2526
|
+
*/
|
|
2527
|
+
export interface AccessProfilesApiCreateAccessProfileV2Request {
|
|
2528
|
+
/**
|
|
2529
|
+
*
|
|
2530
|
+
* @type {Accessprofilev2}
|
|
2531
|
+
* @memberof AccessProfilesApiCreateAccessProfileV2
|
|
2532
|
+
*/
|
|
2533
|
+
readonly accessprofilev2: Accessprofilev2;
|
|
2534
|
+
/**
|
|
2535
|
+
* Use this header to enable this experimental API.
|
|
2536
|
+
* @type {string}
|
|
2537
|
+
* @memberof AccessProfilesApiCreateAccessProfileV2
|
|
2538
|
+
*/
|
|
2539
|
+
readonly xSailPointExperimental?: string;
|
|
2540
|
+
}
|
|
1805
2541
|
/**
|
|
1806
2542
|
* Request parameters for deleteAccessProfileV1 operation in AccessProfilesApi.
|
|
1807
2543
|
* @export
|
|
@@ -1815,6 +2551,25 @@ export interface AccessProfilesApiDeleteAccessProfileV1Request {
|
|
|
1815
2551
|
*/
|
|
1816
2552
|
readonly id: string;
|
|
1817
2553
|
}
|
|
2554
|
+
/**
|
|
2555
|
+
* Request parameters for deleteAccessProfileV2 operation in AccessProfilesApi.
|
|
2556
|
+
* @export
|
|
2557
|
+
* @interface AccessProfilesApiDeleteAccessProfileV2Request
|
|
2558
|
+
*/
|
|
2559
|
+
export interface AccessProfilesApiDeleteAccessProfileV2Request {
|
|
2560
|
+
/**
|
|
2561
|
+
* ID of the Access Profile to delete
|
|
2562
|
+
* @type {string}
|
|
2563
|
+
* @memberof AccessProfilesApiDeleteAccessProfileV2
|
|
2564
|
+
*/
|
|
2565
|
+
readonly id: string;
|
|
2566
|
+
/**
|
|
2567
|
+
* Use this header to enable this experimental API.
|
|
2568
|
+
* @type {string}
|
|
2569
|
+
* @memberof AccessProfilesApiDeleteAccessProfileV2
|
|
2570
|
+
*/
|
|
2571
|
+
readonly xSailPointExperimental?: string;
|
|
2572
|
+
}
|
|
1818
2573
|
/**
|
|
1819
2574
|
* Request parameters for deleteAccessProfilesInBulkV1 operation in AccessProfilesApi.
|
|
1820
2575
|
* @export
|
|
@@ -1828,6 +2583,25 @@ export interface AccessProfilesApiDeleteAccessProfilesInBulkV1Request {
|
|
|
1828
2583
|
*/
|
|
1829
2584
|
readonly accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest;
|
|
1830
2585
|
}
|
|
2586
|
+
/**
|
|
2587
|
+
* Request parameters for deleteAccessProfilesInBulkV2 operation in AccessProfilesApi.
|
|
2588
|
+
* @export
|
|
2589
|
+
* @interface AccessProfilesApiDeleteAccessProfilesInBulkV2Request
|
|
2590
|
+
*/
|
|
2591
|
+
export interface AccessProfilesApiDeleteAccessProfilesInBulkV2Request {
|
|
2592
|
+
/**
|
|
2593
|
+
*
|
|
2594
|
+
* @type {AccessProfileBulkDeleteRequest}
|
|
2595
|
+
* @memberof AccessProfilesApiDeleteAccessProfilesInBulkV2
|
|
2596
|
+
*/
|
|
2597
|
+
readonly accessProfileBulkDeleteRequest: AccessProfileBulkDeleteRequest;
|
|
2598
|
+
/**
|
|
2599
|
+
* Use this header to enable this experimental API.
|
|
2600
|
+
* @type {string}
|
|
2601
|
+
* @memberof AccessProfilesApiDeleteAccessProfilesInBulkV2
|
|
2602
|
+
*/
|
|
2603
|
+
readonly xSailPointExperimental?: string;
|
|
2604
|
+
}
|
|
1831
2605
|
/**
|
|
1832
2606
|
* Request parameters for deleteMetadataFromAccessProfileByKeyAndValueV1 operation in AccessProfilesApi.
|
|
1833
2607
|
* @export
|
|
@@ -1896,6 +2670,61 @@ export interface AccessProfilesApiGetAccessProfileEntitlementsV1Request {
|
|
|
1896
2670
|
*/
|
|
1897
2671
|
readonly sorters?: string;
|
|
1898
2672
|
}
|
|
2673
|
+
/**
|
|
2674
|
+
* Request parameters for getAccessProfileEntitlementsV2 operation in AccessProfilesApi.
|
|
2675
|
+
* @export
|
|
2676
|
+
* @interface AccessProfilesApiGetAccessProfileEntitlementsV2Request
|
|
2677
|
+
*/
|
|
2678
|
+
export interface AccessProfilesApiGetAccessProfileEntitlementsV2Request {
|
|
2679
|
+
/**
|
|
2680
|
+
* ID of the access profile containing the entitlements.
|
|
2681
|
+
* @type {string}
|
|
2682
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2683
|
+
*/
|
|
2684
|
+
readonly id: string;
|
|
2685
|
+
/**
|
|
2686
|
+
* Use this header to enable this experimental API.
|
|
2687
|
+
* @type {string}
|
|
2688
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2689
|
+
*/
|
|
2690
|
+
readonly xSailPointExperimental?: string;
|
|
2691
|
+
/**
|
|
2692
|
+
* Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2693
|
+
* @type {number}
|
|
2694
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2695
|
+
*/
|
|
2696
|
+
readonly limit?: number;
|
|
2697
|
+
/**
|
|
2698
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2699
|
+
* @type {number}
|
|
2700
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2701
|
+
*/
|
|
2702
|
+
readonly offset?: number;
|
|
2703
|
+
/**
|
|
2704
|
+
* 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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2705
|
+
* @type {boolean}
|
|
2706
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2707
|
+
*/
|
|
2708
|
+
readonly count?: boolean;
|
|
2709
|
+
/**
|
|
2710
|
+
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **attribute**: *eq, co* **value**: *eq, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **privilegeLevel.effective**: *eq, in* Results are automatically scoped to entitlements belonging to the access profile.
|
|
2711
|
+
* @type {string}
|
|
2712
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2713
|
+
*/
|
|
2714
|
+
readonly filters?: string;
|
|
2715
|
+
/**
|
|
2716
|
+
* Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, attribute, value, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2717
|
+
* @type {string}
|
|
2718
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2719
|
+
*/
|
|
2720
|
+
readonly sorters?: string;
|
|
2721
|
+
/**
|
|
2722
|
+
* Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2723
|
+
* @type {string}
|
|
2724
|
+
* @memberof AccessProfilesApiGetAccessProfileEntitlementsV2
|
|
2725
|
+
*/
|
|
2726
|
+
readonly cursor?: string;
|
|
2727
|
+
}
|
|
1899
2728
|
/**
|
|
1900
2729
|
* Request parameters for getAccessProfileV1 operation in AccessProfilesApi.
|
|
1901
2730
|
* @export
|
|
@@ -1909,6 +2738,25 @@ export interface AccessProfilesApiGetAccessProfileV1Request {
|
|
|
1909
2738
|
*/
|
|
1910
2739
|
readonly id: string;
|
|
1911
2740
|
}
|
|
2741
|
+
/**
|
|
2742
|
+
* Request parameters for getAccessProfileV2 operation in AccessProfilesApi.
|
|
2743
|
+
* @export
|
|
2744
|
+
* @interface AccessProfilesApiGetAccessProfileV2Request
|
|
2745
|
+
*/
|
|
2746
|
+
export interface AccessProfilesApiGetAccessProfileV2Request {
|
|
2747
|
+
/**
|
|
2748
|
+
* ID of the Access Profile
|
|
2749
|
+
* @type {string}
|
|
2750
|
+
* @memberof AccessProfilesApiGetAccessProfileV2
|
|
2751
|
+
*/
|
|
2752
|
+
readonly id: string;
|
|
2753
|
+
/**
|
|
2754
|
+
* Use this header to enable this experimental API.
|
|
2755
|
+
* @type {string}
|
|
2756
|
+
* @memberof AccessProfilesApiGetAccessProfileV2
|
|
2757
|
+
*/
|
|
2758
|
+
readonly xSailPointExperimental?: string;
|
|
2759
|
+
}
|
|
1912
2760
|
/**
|
|
1913
2761
|
* Request parameters for listAccessProfilesV1 operation in AccessProfilesApi.
|
|
1914
2762
|
* @export
|
|
@@ -1964,6 +2812,73 @@ export interface AccessProfilesApiListAccessProfilesV1Request {
|
|
|
1964
2812
|
*/
|
|
1965
2813
|
readonly includeUnsegmented?: boolean;
|
|
1966
2814
|
}
|
|
2815
|
+
/**
|
|
2816
|
+
* Request parameters for listAccessProfilesV2 operation in AccessProfilesApi.
|
|
2817
|
+
* @export
|
|
2818
|
+
* @interface AccessProfilesApiListAccessProfilesV2Request
|
|
2819
|
+
*/
|
|
2820
|
+
export interface AccessProfilesApiListAccessProfilesV2Request {
|
|
2821
|
+
/**
|
|
2822
|
+
* Use this header to enable this experimental API.
|
|
2823
|
+
* @type {string}
|
|
2824
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2825
|
+
*/
|
|
2826
|
+
readonly xSailPointExperimental?: string;
|
|
2827
|
+
/**
|
|
2828
|
+
* 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
2829
|
+
* @type {string}
|
|
2830
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2831
|
+
*/
|
|
2832
|
+
readonly forSubadmin?: string;
|
|
2833
|
+
/**
|
|
2834
|
+
* Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2835
|
+
* @type {number}
|
|
2836
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2837
|
+
*/
|
|
2838
|
+
readonly limit?: number;
|
|
2839
|
+
/**
|
|
2840
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2841
|
+
* @type {number}
|
|
2842
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2843
|
+
*/
|
|
2844
|
+
readonly offset?: number;
|
|
2845
|
+
/**
|
|
2846
|
+
* 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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
2847
|
+
* @type {boolean}
|
|
2848
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2849
|
+
*/
|
|
2850
|
+
readonly count?: boolean;
|
|
2851
|
+
/**
|
|
2852
|
+
* Filter results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, co* **created**: *lt, le, gt, ge* **modified**: *lt, le, gt, ge* **requestable**: *eq* **source.id**: *eq, in* **owner.id**: *eq, in* **additionalOwners.id**: *eq, in* **dimensional**: *eq* **entitlement.id**: *eq, in* **entitlement.name**: *eq, co* **privilegeLevel.effective**: *eq, in* Supported composite operators are *and, or*
|
|
2853
|
+
* @type {string}
|
|
2854
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2855
|
+
*/
|
|
2856
|
+
readonly filters?: string;
|
|
2857
|
+
/**
|
|
2858
|
+
* Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
2859
|
+
* @type {string}
|
|
2860
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2861
|
+
*/
|
|
2862
|
+
readonly sorters?: string;
|
|
2863
|
+
/**
|
|
2864
|
+
* Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
2865
|
+
* @type {string}
|
|
2866
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2867
|
+
*/
|
|
2868
|
+
readonly forSegmentIds?: string;
|
|
2869
|
+
/**
|
|
2870
|
+
* 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.
|
|
2871
|
+
* @type {boolean}
|
|
2872
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2873
|
+
*/
|
|
2874
|
+
readonly includeUnsegmented?: boolean;
|
|
2875
|
+
/**
|
|
2876
|
+
* Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
2877
|
+
* @type {string}
|
|
2878
|
+
* @memberof AccessProfilesApiListAccessProfilesV2
|
|
2879
|
+
*/
|
|
2880
|
+
readonly cursor?: string;
|
|
2881
|
+
}
|
|
1967
2882
|
/**
|
|
1968
2883
|
* Request parameters for patchAccessProfileV1 operation in AccessProfilesApi.
|
|
1969
2884
|
* @export
|
|
@@ -1983,6 +2898,31 @@ export interface AccessProfilesApiPatchAccessProfileV1Request {
|
|
|
1983
2898
|
*/
|
|
1984
2899
|
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
1985
2900
|
}
|
|
2901
|
+
/**
|
|
2902
|
+
* Request parameters for patchAccessProfileV2 operation in AccessProfilesApi.
|
|
2903
|
+
* @export
|
|
2904
|
+
* @interface AccessProfilesApiPatchAccessProfileV2Request
|
|
2905
|
+
*/
|
|
2906
|
+
export interface AccessProfilesApiPatchAccessProfileV2Request {
|
|
2907
|
+
/**
|
|
2908
|
+
* ID of the Access Profile to patch
|
|
2909
|
+
* @type {string}
|
|
2910
|
+
* @memberof AccessProfilesApiPatchAccessProfileV2
|
|
2911
|
+
*/
|
|
2912
|
+
readonly id: string;
|
|
2913
|
+
/**
|
|
2914
|
+
*
|
|
2915
|
+
* @type {Array<JsonPatchOperation>}
|
|
2916
|
+
* @memberof AccessProfilesApiPatchAccessProfileV2
|
|
2917
|
+
*/
|
|
2918
|
+
readonly jsonPatchOperation: Array<JsonPatchOperation>;
|
|
2919
|
+
/**
|
|
2920
|
+
* Use this header to enable this experimental API.
|
|
2921
|
+
* @type {string}
|
|
2922
|
+
* @memberof AccessProfilesApiPatchAccessProfileV2
|
|
2923
|
+
*/
|
|
2924
|
+
readonly xSailPointExperimental?: string;
|
|
2925
|
+
}
|
|
1986
2926
|
/**
|
|
1987
2927
|
* Request parameters for searchAccessProfilesByFilterV1 operation in AccessProfilesApi.
|
|
1988
2928
|
* @export
|
|
@@ -2038,6 +2978,73 @@ export interface AccessProfilesApiSearchAccessProfilesByFilterV1Request {
|
|
|
2038
2978
|
*/
|
|
2039
2979
|
readonly includeUnsegmented?: boolean;
|
|
2040
2980
|
}
|
|
2981
|
+
/**
|
|
2982
|
+
* Request parameters for searchAccessProfilesByFilterV2 operation in AccessProfilesApi.
|
|
2983
|
+
* @export
|
|
2984
|
+
* @interface AccessProfilesApiSearchAccessProfilesByFilterV2Request
|
|
2985
|
+
*/
|
|
2986
|
+
export interface AccessProfilesApiSearchAccessProfilesByFilterV2Request {
|
|
2987
|
+
/**
|
|
2988
|
+
*
|
|
2989
|
+
* @type {AccessProfileListFilterV2}
|
|
2990
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
2991
|
+
*/
|
|
2992
|
+
readonly accessProfileListFilterV2: AccessProfileListFilterV2;
|
|
2993
|
+
/**
|
|
2994
|
+
* Use this header to enable this experimental API.
|
|
2995
|
+
* @type {string}
|
|
2996
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
2997
|
+
*/
|
|
2998
|
+
readonly xSailPointExperimental?: string;
|
|
2999
|
+
/**
|
|
3000
|
+
* 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. If you specify an identity that isn\'t a subadmin, the API returns a 400 Bad Request error.
|
|
3001
|
+
* @type {string}
|
|
3002
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3003
|
+
*/
|
|
3004
|
+
readonly forSubadmin?: string;
|
|
3005
|
+
/**
|
|
3006
|
+
* Max number of results to return. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
3007
|
+
* @type {number}
|
|
3008
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3009
|
+
*/
|
|
3010
|
+
readonly limit?: number;
|
|
3011
|
+
/**
|
|
3012
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. Must be 0 when you supply a `cursor`, and `offset` plus `limit` must not exceed 10000. See [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
3013
|
+
* @type {number}
|
|
3014
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3015
|
+
*/
|
|
3016
|
+
readonly offset?: number;
|
|
3017
|
+
/**
|
|
3018
|
+
* 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 [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters) for more information.
|
|
3019
|
+
* @type {boolean}
|
|
3020
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3021
|
+
*/
|
|
3022
|
+
readonly count?: boolean;
|
|
3023
|
+
/**
|
|
3024
|
+
* Sort results using the standard syntax described in [API Standard Collection Parameters](https://developer.sailpoint.com/docs/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **name, created, modified, id, privilegeLevel.effective** Defaults to **created** ascending when omitted.
|
|
3025
|
+
* @type {string}
|
|
3026
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3027
|
+
*/
|
|
3028
|
+
readonly sorters?: string;
|
|
3029
|
+
/**
|
|
3030
|
+
* Filters access profiles to only those assigned to the segment(s) with the specified IDs. If segmentation is currently unavailable, specifying this parameter results in an error.
|
|
3031
|
+
* @type {string}
|
|
3032
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3033
|
+
*/
|
|
3034
|
+
readonly forSegmentIds?: string;
|
|
3035
|
+
/**
|
|
3036
|
+
* 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.
|
|
3037
|
+
* @type {boolean}
|
|
3038
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3039
|
+
*/
|
|
3040
|
+
readonly includeUnsegmented?: boolean;
|
|
3041
|
+
/**
|
|
3042
|
+
* Opaque cursor taken from the `X-Next-Cursor` header of a previous response, used to retrieve the next page of results. When you supply a cursor, `offset` must be 0.
|
|
3043
|
+
* @type {string}
|
|
3044
|
+
* @memberof AccessProfilesApiSearchAccessProfilesByFilterV2
|
|
3045
|
+
*/
|
|
3046
|
+
readonly cursor?: string;
|
|
3047
|
+
}
|
|
2041
3048
|
/**
|
|
2042
3049
|
* Request parameters for updateAccessProfilesInBulkV1 operation in AccessProfilesApi.
|
|
2043
3050
|
* @export
|
|
@@ -2051,6 +3058,25 @@ export interface AccessProfilesApiUpdateAccessProfilesInBulkV1Request {
|
|
|
2051
3058
|
*/
|
|
2052
3059
|
readonly accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>;
|
|
2053
3060
|
}
|
|
3061
|
+
/**
|
|
3062
|
+
* Request parameters for updateAccessProfilesInBulkV2 operation in AccessProfilesApi.
|
|
3063
|
+
* @export
|
|
3064
|
+
* @interface AccessProfilesApiUpdateAccessProfilesInBulkV2Request
|
|
3065
|
+
*/
|
|
3066
|
+
export interface AccessProfilesApiUpdateAccessProfilesInBulkV2Request {
|
|
3067
|
+
/**
|
|
3068
|
+
*
|
|
3069
|
+
* @type {Array<AccessProfileBulkUpdateRequestInner>}
|
|
3070
|
+
* @memberof AccessProfilesApiUpdateAccessProfilesInBulkV2
|
|
3071
|
+
*/
|
|
3072
|
+
readonly accessProfileBulkUpdateRequestInner: Array<AccessProfileBulkUpdateRequestInner>;
|
|
3073
|
+
/**
|
|
3074
|
+
* Use this header to enable this experimental API.
|
|
3075
|
+
* @type {string}
|
|
3076
|
+
* @memberof AccessProfilesApiUpdateAccessProfilesInBulkV2
|
|
3077
|
+
*/
|
|
3078
|
+
readonly xSailPointExperimental?: string;
|
|
3079
|
+
}
|
|
2054
3080
|
/**
|
|
2055
3081
|
* Request parameters for updateAccessProfilesMetadataByFilterV1 operation in AccessProfilesApi.
|
|
2056
3082
|
* @export
|
|
@@ -2131,6 +3157,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2131
3157
|
* @memberof AccessProfilesApi
|
|
2132
3158
|
*/
|
|
2133
3159
|
createAccessProfileV1(requestParameters: AccessProfilesApiCreateAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
3160
|
+
/**
|
|
3161
|
+
* Create an access profile. This version accepts the same request body and applies the same validation as [Create Access Profile V1](https://developer.sailpoint.com/docs/api/create-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. A user with `ROLE_SUBADMIN` or `SOURCE_SUBADMIN` authority must be associated with the access profile\'s source. The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles. However, any new access profiles as well as any updates to existing descriptions are limited to 2000 characters. >**Note:** To use this endpoint, you need all the listed scopes. >**Note:** `privilegeLevel` is read-only and is ignored if supplied in the request body. It is calculated asynchronously from the access profile\'s entitlements, so it is typically absent from the create response.
|
|
3162
|
+
* @summary Create access profile
|
|
3163
|
+
* @param {AccessProfilesApiCreateAccessProfileV2Request} requestParameters Request parameters.
|
|
3164
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3165
|
+
* @throws {RequiredError}
|
|
3166
|
+
* @memberof AccessProfilesApi
|
|
3167
|
+
*/
|
|
3168
|
+
createAccessProfileV2(requestParameters: AccessProfilesApiCreateAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilev2, any>>;
|
|
2134
3169
|
/**
|
|
2135
3170
|
* This API deletes an existing Access Profile. The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
2136
3171
|
* @summary Delete the specified access profile
|
|
@@ -2140,6 +3175,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2140
3175
|
* @memberof AccessProfilesApi
|
|
2141
3176
|
*/
|
|
2142
3177
|
deleteAccessProfileV1(requestParameters: AccessProfilesApiDeleteAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
3178
|
+
/**
|
|
3179
|
+
* This API deletes an existing Access Profile. This version behaves identically to [Delete the Specified Access Profile V1](https://developer.sailpoint.com/docs/api/delete-access-profile-v-1). The Access Profile must not be in use, for example, Access Profile can not be deleted if they belong to an Application, Life Cycle State or a Role. If it is, a 400 error is returned. A user with SOURCE_SUBADMIN must be able to administer the Source associated with the Access Profile.
|
|
3180
|
+
* @summary Delete the specified access profile
|
|
3181
|
+
* @param {AccessProfilesApiDeleteAccessProfileV2Request} requestParameters Request parameters.
|
|
3182
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3183
|
+
* @throws {RequiredError}
|
|
3184
|
+
* @memberof AccessProfilesApi
|
|
3185
|
+
*/
|
|
3186
|
+
deleteAccessProfileV2(requestParameters: AccessProfilesApiDeleteAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2143
3187
|
/**
|
|
2144
3188
|
* This endpoint initiates a bulk deletion of one or more access profiles. When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
2145
3189
|
* @summary Delete access profile(s)
|
|
@@ -2149,6 +3193,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2149
3193
|
* @memberof AccessProfilesApi
|
|
2150
3194
|
*/
|
|
2151
3195
|
deleteAccessProfilesInBulkV1(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBulkDeleteResponse, any>>;
|
|
3196
|
+
/**
|
|
3197
|
+
* This endpoint initiates a bulk deletion of one or more access profiles. This version behaves identically to [Delete Access Profile(s) V1](https://developer.sailpoint.com/docs/api/delete-access-profiles-in-bulk-v-1). When the request is successful, the endpoint returns the bulk delete\'s task result ID. To follow the task, you can use [Get Task Status by ID](https://developer.sailpoint.com/docs/api/get-task-status-v-1), which will return the task result\'s status and information. This endpoint can only bulk delete up to a limit of 50 access profiles per request. By default, if any of the indicated access profiles are in use, no deletions will be performed and the **inUse** field of the response indicates the usages that must be removed first. If the request field **bestEffortOnly** is **true**, however, usages are reported in the **inUse** response field but all other indicated access profiles will be deleted. A SOURCE_SUBADMIN user can only use this endpoint to delete access profiles associated with sources they\'re able to administer.
|
|
3198
|
+
* @summary Delete access profile(s)
|
|
3199
|
+
* @param {AccessProfilesApiDeleteAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
3200
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3201
|
+
* @throws {RequiredError}
|
|
3202
|
+
* @memberof AccessProfilesApi
|
|
3203
|
+
*/
|
|
3204
|
+
deleteAccessProfilesInBulkV2(requestParameters: AccessProfilesApiDeleteAccessProfilesInBulkV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileBulkDeleteResponse, any>>;
|
|
2152
3205
|
/**
|
|
2153
3206
|
* This API removes a single Access Model Metadata value from an access profile by attribute key and attribute value.
|
|
2154
3207
|
* @summary Remove metadata from access profile
|
|
@@ -2167,6 +3220,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2167
3220
|
* @memberof AccessProfilesApi
|
|
2168
3221
|
*/
|
|
2169
3222
|
getAccessProfileEntitlementsV1(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Entitlement[], any>>;
|
|
3223
|
+
/**
|
|
3224
|
+
* Get a list of an access profile\'s entitlements. This version reads from Search Lite and returns a superset of the entitlement returned by [List Access Profile\'s Entitlements V1](https://developer.sailpoint.com/docs/api/get-access-profile-entitlements-v-1), adding the entitlement\'s `tags` and calculated `privilegeLevel`. It also supports opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. A SOURCE_SUBADMIN user must have access to the source associated with the specified access profile.
|
|
3225
|
+
* @summary List access profile\'s entitlements
|
|
3226
|
+
* @param {AccessProfilesApiGetAccessProfileEntitlementsV2Request} requestParameters Request parameters.
|
|
3227
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3228
|
+
* @throws {RequiredError}
|
|
3229
|
+
* @memberof AccessProfilesApi
|
|
3230
|
+
*/
|
|
3231
|
+
getAccessProfileEntitlementsV2(requestParameters: AccessProfilesApiGetAccessProfileEntitlementsV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofileentitlementv2[], any>>;
|
|
2170
3232
|
/**
|
|
2171
3233
|
* This API returns an Access Profile by its ID. The `accessRequestConfig.formDefinitionId` field associates an optional custom form with access profile access requests.
|
|
2172
3234
|
* @summary Get an access profile
|
|
@@ -2176,6 +3238,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2176
3238
|
* @memberof AccessProfilesApi
|
|
2177
3239
|
*/
|
|
2178
3240
|
getAccessProfileV1(requestParameters: AccessProfilesApiGetAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
3241
|
+
/**
|
|
3242
|
+
* Get an access profile by its ID. This version reads from Search Lite and returns the same access profile shape as [Get Access Profile V1](https://developer.sailpoint.com/docs/api/get-access-profile-v-1), with the calculated `privilegeLevel` field added.
|
|
3243
|
+
* @summary Get an access profile
|
|
3244
|
+
* @param {AccessProfilesApiGetAccessProfileV2Request} requestParameters Request parameters.
|
|
3245
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3246
|
+
* @throws {RequiredError}
|
|
3247
|
+
* @memberof AccessProfilesApi
|
|
3248
|
+
*/
|
|
3249
|
+
getAccessProfileV2(requestParameters: AccessProfilesApiGetAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilev2, any>>;
|
|
2179
3250
|
/**
|
|
2180
3251
|
* Get a list of access profiles. >**Note:** When you filter for access profiles that have the \'+\' symbol in their names, the response is blank.
|
|
2181
3252
|
* @summary List access profiles
|
|
@@ -2185,6 +3256,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2185
3256
|
* @memberof AccessProfilesApi
|
|
2186
3257
|
*/
|
|
2187
3258
|
listAccessProfilesV1(requestParameters?: AccessProfilesApiListAccessProfilesV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile[], any>>;
|
|
3259
|
+
/**
|
|
3260
|
+
* Get a list of access profiles. This version reads from Search Lite and returns the same access profile shape as [List Access Profiles V1](https://developer.sailpoint.com/docs/api/list-access-profiles-v-1), with two additions: the calculated `privilegeLevel` field, and opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header. >**Note:** When you omit `sorters`, results are sorted by `created` ascending. For deterministic ordering across pages, always specify explicit sorters. When you use cursor pagination, include `id` in `sorters`; the service appends it automatically if you omit it. >**Note:** `offset` and `cursor` are mutually exclusive. Use `offset=0` along with a cursor value taken from a prior response\'s `X-Next-Cursor` header.
|
|
3261
|
+
* @summary List access profiles
|
|
3262
|
+
* @param {AccessProfilesApiListAccessProfilesV2Request} requestParameters Request parameters.
|
|
3263
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3264
|
+
* @throws {RequiredError}
|
|
3265
|
+
* @memberof AccessProfilesApi
|
|
3266
|
+
*/
|
|
3267
|
+
listAccessProfilesV2(requestParameters?: AccessProfilesApiListAccessProfilesV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilev2[], any>>;
|
|
2188
3268
|
/**
|
|
2189
3269
|
* This API updates an existing Access Profile. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revokeRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. Set `accessRequestConfig.formDefinitionId` to associate an optional custom form with access profile access requests. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source.
|
|
2190
3270
|
* @summary Patch a specified access profile
|
|
@@ -2194,6 +3274,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2194
3274
|
* @memberof AccessProfilesApi
|
|
2195
3275
|
*/
|
|
2196
3276
|
patchAccessProfileV1(requestParameters: AccessProfilesApiPatchAccessProfileV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile, any>>;
|
|
3277
|
+
/**
|
|
3278
|
+
* This API updates an existing Access Profile. This version patches the same fields as [Patch a Specified Access Profile V1](https://developer.sailpoint.com/docs/api/patch-access-profile-v-1). It returns the v2 access profile shape, which adds the read-only `privilegeLevel` field. The following fields are patchable: **name** **description** **enabled** **owner** **additionalOwners** **requestable** **accessRequestConfig** **revocationRequestConfig** **segments** **entitlements** **provisioningCriteria** **source** (must be updated with entitlements belonging to new source in the same API call) If you need to change the `source` of the access profile, you can do so only if you update the `entitlements` in the same API call. The new entitlements can only come from the target source that you want to change to. Look for the example \"Replace Source\" in the examples dropdown. A user with SOURCE_SUBADMIN may only use this API to patch Access Profiles which are associated with Sources they are able to administer. > The maximum supported length for the description field is 2000 characters. Longer descriptions will be preserved for existing access profiles, however, any new access profiles as well as any updates to existing descriptions will be limited to 2000 characters. > You can only add or replace **entitlements** that exist on the source that the access profile is attached to. You can use the **list entitlements** endpoint with the **filters** query parameter to get a list of available entitlements on the access profile\'s source. >**Note:** `privilegeLevel` is read-only and cannot be patched. Changing the access profile\'s entitlements recalculates it asynchronously, so the patch response may still show the previous value.
|
|
3279
|
+
* @summary Patch a specified access profile
|
|
3280
|
+
* @param {AccessProfilesApiPatchAccessProfileV2Request} requestParameters Request parameters.
|
|
3281
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3282
|
+
* @throws {RequiredError}
|
|
3283
|
+
* @memberof AccessProfilesApi
|
|
3284
|
+
*/
|
|
3285
|
+
patchAccessProfileV2(requestParameters: AccessProfilesApiPatchAccessProfileV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilev2, any>>;
|
|
2197
3286
|
/**
|
|
2198
3287
|
* Get a list of access profiles filtered by Access Model Metadata and by filter expression. Filtering is supported by filter expression, by metadata attribute key and values, or by both together.
|
|
2199
3288
|
* @summary Filter access profiles by metadata
|
|
@@ -2203,6 +3292,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2203
3292
|
* @memberof AccessProfilesApi
|
|
2204
3293
|
*/
|
|
2205
3294
|
searchAccessProfilesByFilterV1(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfile[], any>>;
|
|
3295
|
+
/**
|
|
3296
|
+
* Get a list of access profiles, supplying the filter criteria and access model metadata key/values in the request body rather than as query parameters. Use this endpoint when you need to filter by access model metadata, or when your filter expression is too long to pass as a query parameter. Pagination, sorting, subadmin scoping, and segment scoping behave the same as [List Access Profiles V2](https://developer.sailpoint.com/docs/api/list-access-profiles-v-2), including opaque cursor pagination through the `cursor` parameter and `X-Next-Cursor` response header.
|
|
3297
|
+
* @summary List access profiles by filter
|
|
3298
|
+
* @param {AccessProfilesApiSearchAccessProfilesByFilterV2Request} requestParameters Request parameters.
|
|
3299
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3300
|
+
* @throws {RequiredError}
|
|
3301
|
+
* @memberof AccessProfilesApi
|
|
3302
|
+
*/
|
|
3303
|
+
searchAccessProfilesByFilterV2(requestParameters: AccessProfilesApiSearchAccessProfilesByFilterV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Accessprofilev2[], any>>;
|
|
2206
3304
|
/**
|
|
2207
3305
|
* This API initiates a bulk update of field requestable for one or more Access Profiles. > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
2208
3306
|
* @summary Update access profile(s) requestable field.
|
|
@@ -2212,6 +3310,15 @@ export declare class AccessProfilesApi extends BaseAPI {
|
|
|
2212
3310
|
* @memberof AccessProfilesApi
|
|
2213
3311
|
*/
|
|
2214
3312
|
updateAccessProfilesInBulkV1(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV1Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileUpdateItem[], any>>;
|
|
3313
|
+
/**
|
|
3314
|
+
* This API initiates a bulk update of field requestable for one or more Access Profiles. This version behaves identically to [Update Access Profile(s) Requestable Field V1](https://developer.sailpoint.com/docs/api/update-access-profiles-in-bulk-v-1). > If any of the indicated Access Profiles is exists in Organization,then those Access Profiles will be added in **updated** list of the response.Requestable field of these Access Profiles marked as **true** or **false**. > If any of the indicated Access Profiles is not does not exists in Organization,then those Access Profiles will be added in **notFound** list of the response. Access Profiles marked as **notFound** will not be updated. A SOURCE_SUBADMIN may only use this API to update Access Profiles which are associated with Sources they are able to administer.
|
|
3315
|
+
* @summary Update access profile(s) requestable field.
|
|
3316
|
+
* @param {AccessProfilesApiUpdateAccessProfilesInBulkV2Request} requestParameters Request parameters.
|
|
3317
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
3318
|
+
* @throws {RequiredError}
|
|
3319
|
+
* @memberof AccessProfilesApi
|
|
3320
|
+
*/
|
|
3321
|
+
updateAccessProfilesInBulkV2(requestParameters: AccessProfilesApiUpdateAccessProfilesInBulkV2Request, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccessProfileUpdateItem[], any>>;
|
|
2215
3322
|
/**
|
|
2216
3323
|
* This API initiates a bulk update of Access Model Metadata for every access profile matching the supplied filter expression. The update is processed asynchronously. The response returns the ID of the task performing the update. A single access profile cannot be assigned more than 25 metadata values. Adding or replacing custom metadata requires a suite license.
|
|
2217
3324
|
* @summary Bulk-update metadata by filter
|