sailpoint-api-client 1.7.8 → 1.7.9
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/beta/README.md +2 -2
- package/beta/common.ts +2 -2
- package/beta/package.json +1 -1
- package/dist/beta/common.js +1 -1
- package/dist/v2024/common.js +1 -1
- package/dist/v2025/common.js +1 -1
- package/dist/v2026/api.d.ts +917 -26
- package/dist/v2026/api.js +865 -1
- package/dist/v2026/api.js.map +1 -1
- package/dist/v2026/common.js +1 -1
- package/dist/v3/common.js +1 -1
- package/package.json +1 -1
- package/v2024/README.md +2 -2
- package/v2024/common.ts +2 -2
- package/v2024/package.json +1 -1
- package/v2025/README.md +2 -2
- package/v2025/common.ts +2 -2
- package/v2025/package.json +1 -1
- package/v2026/README.md +2 -2
- package/v2026/api.ts +1357 -26
- package/v2026/common.ts +2 -2
- package/v2026/package.json +1 -1
- package/v3/README.md +2 -2
- package/v3/common.ts +2 -2
- package/v3/package.json +1 -1
package/dist/v2026/api.d.ts
CHANGED
|
@@ -13,6 +13,86 @@ import type { Configuration } from '../configuration';
|
|
|
13
13
|
import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
|
|
14
14
|
import type { RequestArgs } from './base';
|
|
15
15
|
import { BaseAPI } from './base';
|
|
16
|
+
/**
|
|
17
|
+
* Metadata that describes an access item
|
|
18
|
+
* @export
|
|
19
|
+
* @interface AccessModelMetadataV2026
|
|
20
|
+
*/
|
|
21
|
+
export interface AccessModelMetadataV2026 {
|
|
22
|
+
/**
|
|
23
|
+
* Unique identifier for the metadata type
|
|
24
|
+
* @type {string}
|
|
25
|
+
* @memberof AccessModelMetadataV2026
|
|
26
|
+
*/
|
|
27
|
+
'key'?: string;
|
|
28
|
+
/**
|
|
29
|
+
* Human readable name of the metadata type
|
|
30
|
+
* @type {string}
|
|
31
|
+
* @memberof AccessModelMetadataV2026
|
|
32
|
+
*/
|
|
33
|
+
'name'?: string;
|
|
34
|
+
/**
|
|
35
|
+
* Allows selecting multiple values
|
|
36
|
+
* @type {boolean}
|
|
37
|
+
* @memberof AccessModelMetadataV2026
|
|
38
|
+
*/
|
|
39
|
+
'multiselect'?: boolean;
|
|
40
|
+
/**
|
|
41
|
+
* The state of the metadata item
|
|
42
|
+
* @type {string}
|
|
43
|
+
* @memberof AccessModelMetadataV2026
|
|
44
|
+
*/
|
|
45
|
+
'status'?: string;
|
|
46
|
+
/**
|
|
47
|
+
* The type of the metadata item
|
|
48
|
+
* @type {string}
|
|
49
|
+
* @memberof AccessModelMetadataV2026
|
|
50
|
+
*/
|
|
51
|
+
'type'?: string;
|
|
52
|
+
/**
|
|
53
|
+
* The types of objects
|
|
54
|
+
* @type {Array<string>}
|
|
55
|
+
* @memberof AccessModelMetadataV2026
|
|
56
|
+
*/
|
|
57
|
+
'objectTypes'?: Array<string>;
|
|
58
|
+
/**
|
|
59
|
+
* Describes the metadata item
|
|
60
|
+
* @type {string}
|
|
61
|
+
* @memberof AccessModelMetadataV2026
|
|
62
|
+
*/
|
|
63
|
+
'description'?: string;
|
|
64
|
+
/**
|
|
65
|
+
* The value to assign to the metadata item
|
|
66
|
+
* @type {Array<AccessModelMetadataValuesInnerV2026>}
|
|
67
|
+
* @memberof AccessModelMetadataV2026
|
|
68
|
+
*/
|
|
69
|
+
'values'?: Array<AccessModelMetadataValuesInnerV2026>;
|
|
70
|
+
}
|
|
71
|
+
/**
|
|
72
|
+
* An individual value to assign to the metadata item
|
|
73
|
+
* @export
|
|
74
|
+
* @interface AccessModelMetadataValuesInnerV2026
|
|
75
|
+
*/
|
|
76
|
+
export interface AccessModelMetadataValuesInnerV2026 {
|
|
77
|
+
/**
|
|
78
|
+
* The value to assign to the metdata item
|
|
79
|
+
* @type {string}
|
|
80
|
+
* @memberof AccessModelMetadataValuesInnerV2026
|
|
81
|
+
*/
|
|
82
|
+
'value'?: string;
|
|
83
|
+
/**
|
|
84
|
+
* Display name of the value
|
|
85
|
+
* @type {string}
|
|
86
|
+
* @memberof AccessModelMetadataValuesInnerV2026
|
|
87
|
+
*/
|
|
88
|
+
'name'?: string;
|
|
89
|
+
/**
|
|
90
|
+
* The status of the individual value
|
|
91
|
+
* @type {string}
|
|
92
|
+
* @memberof AccessModelMetadataValuesInnerV2026
|
|
93
|
+
*/
|
|
94
|
+
'status'?: string;
|
|
95
|
+
}
|
|
16
96
|
/**
|
|
17
97
|
*
|
|
18
98
|
* @export
|
|
@@ -696,6 +776,282 @@ export declare const DtoTypeV2026: {
|
|
|
696
776
|
readonly Unknown: "UNKNOWN";
|
|
697
777
|
};
|
|
698
778
|
export type DtoTypeV2026 = typeof DtoTypeV2026[keyof typeof DtoTypeV2026];
|
|
779
|
+
/**
|
|
780
|
+
* Additional data to classify the entitlement
|
|
781
|
+
* @export
|
|
782
|
+
* @interface EntitlementAccessModelMetadataV2026
|
|
783
|
+
*/
|
|
784
|
+
export interface EntitlementAccessModelMetadataV2026 {
|
|
785
|
+
/**
|
|
786
|
+
*
|
|
787
|
+
* @type {Array<AccessModelMetadataV2026>}
|
|
788
|
+
* @memberof EntitlementAccessModelMetadataV2026
|
|
789
|
+
*/
|
|
790
|
+
'attributes'?: Array<AccessModelMetadataV2026>;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* Object for specifying the bulk update request
|
|
794
|
+
* @export
|
|
795
|
+
* @interface EntitlementBulkUpdateRequestV2026
|
|
796
|
+
*/
|
|
797
|
+
export interface EntitlementBulkUpdateRequestV2026 {
|
|
798
|
+
/**
|
|
799
|
+
* List of entitlement ids to update
|
|
800
|
+
* @type {Array<string>}
|
|
801
|
+
* @memberof EntitlementBulkUpdateRequestV2026
|
|
802
|
+
*/
|
|
803
|
+
'entitlementIds': Array<string>;
|
|
804
|
+
/**
|
|
805
|
+
*
|
|
806
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
807
|
+
* @memberof EntitlementBulkUpdateRequestV2026
|
|
808
|
+
*/
|
|
809
|
+
'jsonPatch': Array<JsonPatchOperationV2026>;
|
|
810
|
+
}
|
|
811
|
+
/**
|
|
812
|
+
* The identity that owns the entitlement
|
|
813
|
+
* @export
|
|
814
|
+
* @interface EntitlementOwnerV2026
|
|
815
|
+
*/
|
|
816
|
+
export interface EntitlementOwnerV2026 {
|
|
817
|
+
/**
|
|
818
|
+
* The identity ID
|
|
819
|
+
* @type {string}
|
|
820
|
+
* @memberof EntitlementOwnerV2026
|
|
821
|
+
*/
|
|
822
|
+
'id'?: string;
|
|
823
|
+
/**
|
|
824
|
+
* The type of object
|
|
825
|
+
* @type {string}
|
|
826
|
+
* @memberof EntitlementOwnerV2026
|
|
827
|
+
*/
|
|
828
|
+
'type'?: EntitlementOwnerV2026TypeV2026;
|
|
829
|
+
/**
|
|
830
|
+
* The display name of the identity
|
|
831
|
+
* @type {string}
|
|
832
|
+
* @memberof EntitlementOwnerV2026
|
|
833
|
+
*/
|
|
834
|
+
'name'?: string;
|
|
835
|
+
}
|
|
836
|
+
export declare const EntitlementOwnerV2026TypeV2026: {
|
|
837
|
+
readonly Identity: "IDENTITY";
|
|
838
|
+
};
|
|
839
|
+
export type EntitlementOwnerV2026TypeV2026 = typeof EntitlementOwnerV2026TypeV2026[keyof typeof EntitlementOwnerV2026TypeV2026];
|
|
840
|
+
/**
|
|
841
|
+
*
|
|
842
|
+
* @export
|
|
843
|
+
* @interface EntitlementPrivilegeLevelV2026
|
|
844
|
+
*/
|
|
845
|
+
export interface EntitlementPrivilegeLevelV2026 {
|
|
846
|
+
/**
|
|
847
|
+
* Direct privilege level assigned to the entitlement
|
|
848
|
+
* @type {string}
|
|
849
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
850
|
+
*/
|
|
851
|
+
'direct'?: EntitlementPrivilegeLevelV2026DirectV2026;
|
|
852
|
+
/**
|
|
853
|
+
* User or process that set the privilege level
|
|
854
|
+
* @type {string}
|
|
855
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
856
|
+
*/
|
|
857
|
+
'setBy'?: string;
|
|
858
|
+
/**
|
|
859
|
+
* Method by which the privilege level was set
|
|
860
|
+
* @type {string}
|
|
861
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
862
|
+
*/
|
|
863
|
+
'setByType'?: EntitlementPrivilegeLevelV2026SetByTypeV2026 | null;
|
|
864
|
+
/**
|
|
865
|
+
* Inherited privilege level on the entitlement, if any
|
|
866
|
+
* @type {string}
|
|
867
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
868
|
+
*/
|
|
869
|
+
'inherited'?: EntitlementPrivilegeLevelV2026InheritedV2026 | null;
|
|
870
|
+
/**
|
|
871
|
+
* Effective privilege level assigned to the entitlement
|
|
872
|
+
* @type {string}
|
|
873
|
+
* @memberof EntitlementPrivilegeLevelV2026
|
|
874
|
+
*/
|
|
875
|
+
'effective'?: EntitlementPrivilegeLevelV2026EffectiveV2026;
|
|
876
|
+
}
|
|
877
|
+
export declare const EntitlementPrivilegeLevelV2026DirectV2026: {
|
|
878
|
+
readonly High: "HIGH";
|
|
879
|
+
readonly Low: "LOW";
|
|
880
|
+
readonly Medium: "MEDIUM";
|
|
881
|
+
readonly None: "NONE";
|
|
882
|
+
};
|
|
883
|
+
export type EntitlementPrivilegeLevelV2026DirectV2026 = typeof EntitlementPrivilegeLevelV2026DirectV2026[keyof typeof EntitlementPrivilegeLevelV2026DirectV2026];
|
|
884
|
+
export declare const EntitlementPrivilegeLevelV2026SetByTypeV2026: {
|
|
885
|
+
readonly Override: "OVERRIDE";
|
|
886
|
+
readonly CustomCriteria: "CUSTOM_CRITERIA";
|
|
887
|
+
readonly ConnectorCriteria: "CONNECTOR_CRITERIA";
|
|
888
|
+
readonly SingleLevelCriteria: "SINGLE_LEVEL_CRITERIA";
|
|
889
|
+
};
|
|
890
|
+
export type EntitlementPrivilegeLevelV2026SetByTypeV2026 = typeof EntitlementPrivilegeLevelV2026SetByTypeV2026[keyof typeof EntitlementPrivilegeLevelV2026SetByTypeV2026];
|
|
891
|
+
export declare const EntitlementPrivilegeLevelV2026InheritedV2026: {
|
|
892
|
+
readonly High: "HIGH";
|
|
893
|
+
readonly Low: "LOW";
|
|
894
|
+
readonly Medium: "MEDIUM";
|
|
895
|
+
readonly None: "NONE";
|
|
896
|
+
};
|
|
897
|
+
export type EntitlementPrivilegeLevelV2026InheritedV2026 = typeof EntitlementPrivilegeLevelV2026InheritedV2026[keyof typeof EntitlementPrivilegeLevelV2026InheritedV2026];
|
|
898
|
+
export declare const EntitlementPrivilegeLevelV2026EffectiveV2026: {
|
|
899
|
+
readonly High: "HIGH";
|
|
900
|
+
readonly Low: "LOW";
|
|
901
|
+
readonly Medium: "MEDIUM";
|
|
902
|
+
readonly None: "NONE";
|
|
903
|
+
};
|
|
904
|
+
export type EntitlementPrivilegeLevelV2026EffectiveV2026 = typeof EntitlementPrivilegeLevelV2026EffectiveV2026[keyof typeof EntitlementPrivilegeLevelV2026EffectiveV2026];
|
|
905
|
+
/**
|
|
906
|
+
*
|
|
907
|
+
* @export
|
|
908
|
+
* @interface EntitlementSourceV2026
|
|
909
|
+
*/
|
|
910
|
+
export interface EntitlementSourceV2026 {
|
|
911
|
+
/**
|
|
912
|
+
* The source ID
|
|
913
|
+
* @type {string}
|
|
914
|
+
* @memberof EntitlementSourceV2026
|
|
915
|
+
*/
|
|
916
|
+
'id'?: string;
|
|
917
|
+
/**
|
|
918
|
+
* The source type, will always be \"SOURCE\"
|
|
919
|
+
* @type {string}
|
|
920
|
+
* @memberof EntitlementSourceV2026
|
|
921
|
+
*/
|
|
922
|
+
'type'?: string;
|
|
923
|
+
/**
|
|
924
|
+
* The source name
|
|
925
|
+
* @type {string}
|
|
926
|
+
* @memberof EntitlementSourceV2026
|
|
927
|
+
*/
|
|
928
|
+
'name'?: string;
|
|
929
|
+
}
|
|
930
|
+
/**
|
|
931
|
+
*
|
|
932
|
+
* @export
|
|
933
|
+
* @interface EntitlementV2026
|
|
934
|
+
*/
|
|
935
|
+
export interface EntitlementV2026 {
|
|
936
|
+
/**
|
|
937
|
+
* The entitlement id
|
|
938
|
+
* @type {string}
|
|
939
|
+
* @memberof EntitlementV2026
|
|
940
|
+
*/
|
|
941
|
+
'id'?: string;
|
|
942
|
+
/**
|
|
943
|
+
* The entitlement name
|
|
944
|
+
* @type {string}
|
|
945
|
+
* @memberof EntitlementV2026
|
|
946
|
+
*/
|
|
947
|
+
'name'?: string;
|
|
948
|
+
/**
|
|
949
|
+
* The entitlement attribute name
|
|
950
|
+
* @type {string}
|
|
951
|
+
* @memberof EntitlementV2026
|
|
952
|
+
*/
|
|
953
|
+
'attribute'?: string;
|
|
954
|
+
/**
|
|
955
|
+
* The value of the entitlement
|
|
956
|
+
* @type {string}
|
|
957
|
+
* @memberof EntitlementV2026
|
|
958
|
+
*/
|
|
959
|
+
'value'?: string;
|
|
960
|
+
/**
|
|
961
|
+
* The object type of the entitlement from the source schema
|
|
962
|
+
* @type {string}
|
|
963
|
+
* @memberof EntitlementV2026
|
|
964
|
+
*/
|
|
965
|
+
'sourceSchemaObjectType'?: string;
|
|
966
|
+
/**
|
|
967
|
+
* The description of the entitlement
|
|
968
|
+
* @type {string}
|
|
969
|
+
* @memberof EntitlementV2026
|
|
970
|
+
*/
|
|
971
|
+
'description'?: string | null;
|
|
972
|
+
/**
|
|
973
|
+
*
|
|
974
|
+
* @type {EntitlementPrivilegeLevelV2026}
|
|
975
|
+
* @memberof EntitlementV2026
|
|
976
|
+
*/
|
|
977
|
+
'privilegeLevel'?: EntitlementPrivilegeLevelV2026;
|
|
978
|
+
/**
|
|
979
|
+
* List of tags assigned to the entitlement
|
|
980
|
+
* @type {Array<string>}
|
|
981
|
+
* @memberof EntitlementV2026
|
|
982
|
+
*/
|
|
983
|
+
'tags'?: Array<string> | null;
|
|
984
|
+
/**
|
|
985
|
+
* True if the entitlement is cloud governed
|
|
986
|
+
* @type {boolean}
|
|
987
|
+
* @memberof EntitlementV2026
|
|
988
|
+
*/
|
|
989
|
+
'cloudGoverned'?: boolean;
|
|
990
|
+
/**
|
|
991
|
+
* True if the entitlement is able to be directly requested
|
|
992
|
+
* @type {boolean}
|
|
993
|
+
* @memberof EntitlementV2026
|
|
994
|
+
*/
|
|
995
|
+
'requestable'?: boolean;
|
|
996
|
+
/**
|
|
997
|
+
*
|
|
998
|
+
* @type {EntitlementOwnerV2026}
|
|
999
|
+
* @memberof EntitlementV2026
|
|
1000
|
+
*/
|
|
1001
|
+
'owner'?: EntitlementOwnerV2026 | null;
|
|
1002
|
+
/**
|
|
1003
|
+
* 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.
|
|
1004
|
+
* @type {{ [key: string]: any; }}
|
|
1005
|
+
* @memberof EntitlementV2026
|
|
1006
|
+
*/
|
|
1007
|
+
'manuallyUpdatedFields'?: {
|
|
1008
|
+
[key: string]: any;
|
|
1009
|
+
} | null;
|
|
1010
|
+
/**
|
|
1011
|
+
*
|
|
1012
|
+
* @type {EntitlementAccessModelMetadataV2026}
|
|
1013
|
+
* @memberof EntitlementV2026
|
|
1014
|
+
*/
|
|
1015
|
+
'accessModelMetadata'?: EntitlementAccessModelMetadataV2026;
|
|
1016
|
+
/**
|
|
1017
|
+
* Time when the entitlement was created
|
|
1018
|
+
* @type {string}
|
|
1019
|
+
* @memberof EntitlementV2026
|
|
1020
|
+
*/
|
|
1021
|
+
'created'?: string;
|
|
1022
|
+
/**
|
|
1023
|
+
* Time when the entitlement was last modified
|
|
1024
|
+
* @type {string}
|
|
1025
|
+
* @memberof EntitlementV2026
|
|
1026
|
+
*/
|
|
1027
|
+
'modified'?: string;
|
|
1028
|
+
/**
|
|
1029
|
+
*
|
|
1030
|
+
* @type {EntitlementSourceV2026}
|
|
1031
|
+
* @memberof EntitlementV2026
|
|
1032
|
+
*/
|
|
1033
|
+
'source'?: EntitlementSourceV2026;
|
|
1034
|
+
/**
|
|
1035
|
+
* A map of free-form key-value pairs from the source system
|
|
1036
|
+
* @type {{ [key: string]: any; }}
|
|
1037
|
+
* @memberof EntitlementV2026
|
|
1038
|
+
*/
|
|
1039
|
+
'attributes'?: {
|
|
1040
|
+
[key: string]: any;
|
|
1041
|
+
};
|
|
1042
|
+
/**
|
|
1043
|
+
* List of IDs of segments, if any, to which this Entitlement is assigned.
|
|
1044
|
+
* @type {Array<string>}
|
|
1045
|
+
* @memberof EntitlementV2026
|
|
1046
|
+
*/
|
|
1047
|
+
'segments'?: Array<string> | null;
|
|
1048
|
+
/**
|
|
1049
|
+
*
|
|
1050
|
+
* @type {Array<PermissionDtoV2026>}
|
|
1051
|
+
* @memberof EntitlementV2026
|
|
1052
|
+
*/
|
|
1053
|
+
'directPermissions'?: Array<PermissionDtoV2026>;
|
|
1054
|
+
}
|
|
699
1055
|
/**
|
|
700
1056
|
*
|
|
701
1057
|
* @export
|
|
@@ -752,32 +1108,6 @@ export interface ErrorResponseDtoV2026 {
|
|
|
752
1108
|
*/
|
|
753
1109
|
'causes'?: Array<ErrorMessageDtoV2026>;
|
|
754
1110
|
}
|
|
755
|
-
/**
|
|
756
|
-
*
|
|
757
|
-
* @export
|
|
758
|
-
* @interface GetTaskStatus401ResponseV2026
|
|
759
|
-
*/
|
|
760
|
-
export interface GetTaskStatus401ResponseV2026 {
|
|
761
|
-
/**
|
|
762
|
-
* A message describing the error
|
|
763
|
-
* @type {object}
|
|
764
|
-
* @memberof GetTaskStatus401ResponseV2026
|
|
765
|
-
*/
|
|
766
|
-
'error'?: object;
|
|
767
|
-
}
|
|
768
|
-
/**
|
|
769
|
-
*
|
|
770
|
-
* @export
|
|
771
|
-
* @interface GetTaskStatus429ResponseV2026
|
|
772
|
-
*/
|
|
773
|
-
export interface GetTaskStatus429ResponseV2026 {
|
|
774
|
-
/**
|
|
775
|
-
* A message describing the error
|
|
776
|
-
* @type {object}
|
|
777
|
-
* @memberof GetTaskStatus429ResponseV2026
|
|
778
|
-
*/
|
|
779
|
-
'message'?: object;
|
|
780
|
-
}
|
|
781
1111
|
/**
|
|
782
1112
|
* Contains detailed information about an identity, including unique identifier, name, email address, and registration status.
|
|
783
1113
|
* @export
|
|
@@ -849,6 +1179,32 @@ export type JsonPatchOperationV2026OpV2026 = typeof JsonPatchOperationV2026OpV20
|
|
|
849
1179
|
* @export
|
|
850
1180
|
*/
|
|
851
1181
|
export type JsonPatchOperationValueV2026 = Array<ArrayInnerV2026> | boolean | number | object | string;
|
|
1182
|
+
/**
|
|
1183
|
+
*
|
|
1184
|
+
* @export
|
|
1185
|
+
* @interface ListEntitlements401ResponseV2026
|
|
1186
|
+
*/
|
|
1187
|
+
export interface ListEntitlements401ResponseV2026 {
|
|
1188
|
+
/**
|
|
1189
|
+
* A message describing the error
|
|
1190
|
+
* @type {object}
|
|
1191
|
+
* @memberof ListEntitlements401ResponseV2026
|
|
1192
|
+
*/
|
|
1193
|
+
'error'?: object;
|
|
1194
|
+
}
|
|
1195
|
+
/**
|
|
1196
|
+
*
|
|
1197
|
+
* @export
|
|
1198
|
+
* @interface ListEntitlements429ResponseV2026
|
|
1199
|
+
*/
|
|
1200
|
+
export interface ListEntitlements429ResponseV2026 {
|
|
1201
|
+
/**
|
|
1202
|
+
* A message describing the error
|
|
1203
|
+
* @type {object}
|
|
1204
|
+
* @memberof ListEntitlements429ResponseV2026
|
|
1205
|
+
*/
|
|
1206
|
+
'message'?: object;
|
|
1207
|
+
}
|
|
852
1208
|
/**
|
|
853
1209
|
* An indicator of how the locale was selected. *DEFAULT* means the locale is the system default. *REQUEST* means the locale was selected from the request context (i.e., best match based on the *Accept-Language* header). Additional values may be added in the future without notice.
|
|
854
1210
|
* @export
|
|
@@ -959,6 +1315,25 @@ export interface MachineAccountSubTypeConfigDtoV2026 {
|
|
|
959
1315
|
*/
|
|
960
1316
|
'machineAccountDelete'?: MachineAccountSubTypeConfigDtoMachineAccountDeleteV2026;
|
|
961
1317
|
}
|
|
1318
|
+
/**
|
|
1319
|
+
* Simplified DTO for the Permission objects stored in SailPoint\'s database. The data is aggregated from customer systems and is free-form, so its appearance can vary largely between different clients/customers.
|
|
1320
|
+
* @export
|
|
1321
|
+
* @interface PermissionDtoV2026
|
|
1322
|
+
*/
|
|
1323
|
+
export interface PermissionDtoV2026 {
|
|
1324
|
+
/**
|
|
1325
|
+
* All the rights (e.g. actions) that this permission allows on the target
|
|
1326
|
+
* @type {Array<string>}
|
|
1327
|
+
* @memberof PermissionDtoV2026
|
|
1328
|
+
*/
|
|
1329
|
+
'rights'?: Array<string>;
|
|
1330
|
+
/**
|
|
1331
|
+
* The target the permission would grants rights on.
|
|
1332
|
+
* @type {string}
|
|
1333
|
+
* @memberof PermissionDtoV2026
|
|
1334
|
+
*/
|
|
1335
|
+
'target'?: string;
|
|
1336
|
+
}
|
|
962
1337
|
/**
|
|
963
1338
|
*
|
|
964
1339
|
* @export
|
|
@@ -1420,6 +1795,522 @@ export declare class DeleteAccountV2026Api extends BaseAPI {
|
|
|
1420
1795
|
*/
|
|
1421
1796
|
deleteAccountRequest(requestParameters: DeleteAccountV2026ApiDeleteAccountRequestRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<AccountDeleteAsyncResultV2026, any>>;
|
|
1422
1797
|
}
|
|
1798
|
+
/**
|
|
1799
|
+
* EntitlementsV2026Api - axios parameter creator
|
|
1800
|
+
* @export
|
|
1801
|
+
*/
|
|
1802
|
+
export declare const EntitlementsV2026ApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
1803
|
+
/**
|
|
1804
|
+
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
1805
|
+
* @summary Get entitlements for an account
|
|
1806
|
+
* @param {string} accountId The account ID to get entitlements for
|
|
1807
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1808
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1809
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1810
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1811
|
+
* @throws {RequiredError}
|
|
1812
|
+
*/
|
|
1813
|
+
getAccountEntitlements: (accountId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1814
|
+
/**
|
|
1815
|
+
* This API returns an entitlement by its ID.
|
|
1816
|
+
* @summary Get an entitlement
|
|
1817
|
+
* @param {string} id The entitlement ID
|
|
1818
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1819
|
+
* @throws {RequiredError}
|
|
1820
|
+
*/
|
|
1821
|
+
getEntitlement: (id: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1822
|
+
/**
|
|
1823
|
+
* This API returns a list of all child entitlements of a given entitlement.
|
|
1824
|
+
* @summary List of entitlements children
|
|
1825
|
+
* @param {string} id Entitlement Id
|
|
1826
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1827
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1828
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1829
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
1830
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1831
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1832
|
+
* @throws {RequiredError}
|
|
1833
|
+
*/
|
|
1834
|
+
listEntitlementChildren: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1835
|
+
/**
|
|
1836
|
+
* This API returns a list of all parent entitlements of a given entitlement.
|
|
1837
|
+
* @summary List of entitlements parents
|
|
1838
|
+
* @param {string} id Entitlement Id
|
|
1839
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1840
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1841
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1842
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
1843
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1844
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1845
|
+
* @throws {RequiredError}
|
|
1846
|
+
*/
|
|
1847
|
+
listEntitlementParents: (id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1848
|
+
/**
|
|
1849
|
+
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
1850
|
+
* @summary Gets a list of entitlements.
|
|
1851
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
1852
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
1853
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
1854
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1855
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1856
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1857
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable**
|
|
1858
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1859
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1860
|
+
* @throws {RequiredError}
|
|
1861
|
+
*/
|
|
1862
|
+
listEntitlements: (segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1863
|
+
/**
|
|
1864
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
1865
|
+
* @summary Patch an entitlement
|
|
1866
|
+
* @param {string} id ID of the entitlement to patch
|
|
1867
|
+
* @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
|
|
1868
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1869
|
+
* @throws {RequiredError}
|
|
1870
|
+
*/
|
|
1871
|
+
patchEntitlement: (id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1872
|
+
/**
|
|
1873
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
1874
|
+
* @summary Bulk update an entitlement list
|
|
1875
|
+
* @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026
|
|
1876
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1877
|
+
* @throws {RequiredError}
|
|
1878
|
+
*/
|
|
1879
|
+
updateEntitlementsInBulk: (entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig) => Promise<RequestArgs>;
|
|
1880
|
+
};
|
|
1881
|
+
/**
|
|
1882
|
+
* EntitlementsV2026Api - functional programming interface
|
|
1883
|
+
* @export
|
|
1884
|
+
*/
|
|
1885
|
+
export declare const EntitlementsV2026ApiFp: (configuration?: Configuration) => {
|
|
1886
|
+
/**
|
|
1887
|
+
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
1888
|
+
* @summary Get entitlements for an account
|
|
1889
|
+
* @param {string} accountId The account ID to get entitlements for
|
|
1890
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1891
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1892
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1893
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1894
|
+
* @throws {RequiredError}
|
|
1895
|
+
*/
|
|
1896
|
+
getAccountEntitlements(accountId: string, limit?: number, offset?: number, count?: boolean, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>>;
|
|
1897
|
+
/**
|
|
1898
|
+
* This API returns an entitlement by its ID.
|
|
1899
|
+
* @summary Get an entitlement
|
|
1900
|
+
* @param {string} id The entitlement ID
|
|
1901
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1902
|
+
* @throws {RequiredError}
|
|
1903
|
+
*/
|
|
1904
|
+
getEntitlement(id: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2026>>;
|
|
1905
|
+
/**
|
|
1906
|
+
* This API returns a list of all child entitlements of a given entitlement.
|
|
1907
|
+
* @summary List of entitlements children
|
|
1908
|
+
* @param {string} id Entitlement Id
|
|
1909
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1910
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1911
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1912
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
1913
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1914
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1915
|
+
* @throws {RequiredError}
|
|
1916
|
+
*/
|
|
1917
|
+
listEntitlementChildren(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>>;
|
|
1918
|
+
/**
|
|
1919
|
+
* This API returns a list of all parent entitlements of a given entitlement.
|
|
1920
|
+
* @summary List of entitlements parents
|
|
1921
|
+
* @param {string} id Entitlement Id
|
|
1922
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1923
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1924
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1925
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
1926
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1927
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1928
|
+
* @throws {RequiredError}
|
|
1929
|
+
*/
|
|
1930
|
+
listEntitlementParents(id: string, limit?: number, offset?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>>;
|
|
1931
|
+
/**
|
|
1932
|
+
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
1933
|
+
* @summary Gets a list of entitlements.
|
|
1934
|
+
* @param {string} [segmentedForIdentity] If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
1935
|
+
* @param {string} [forSegmentIds] If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
1936
|
+
* @param {boolean} [includeUnsegmented] Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
1937
|
+
* @param {number} [offset] Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1938
|
+
* @param {number} [limit] Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1939
|
+
* @param {boolean} [count] If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
1940
|
+
* @param {string} [sorters] Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable**
|
|
1941
|
+
* @param {string} [filters] Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
1942
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1943
|
+
* @throws {RequiredError}
|
|
1944
|
+
*/
|
|
1945
|
+
listEntitlements(segmentedForIdentity?: string, forSegmentIds?: string, includeUnsegmented?: boolean, offset?: number, limit?: number, count?: boolean, sorters?: string, filters?: string, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EntitlementV2026>>>;
|
|
1946
|
+
/**
|
|
1947
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
1948
|
+
* @summary Patch an entitlement
|
|
1949
|
+
* @param {string} id ID of the entitlement to patch
|
|
1950
|
+
* @param {Array<JsonPatchOperationV2026>} [jsonPatchOperationV2026]
|
|
1951
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1952
|
+
* @throws {RequiredError}
|
|
1953
|
+
*/
|
|
1954
|
+
patchEntitlement(id: string, jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EntitlementV2026>>;
|
|
1955
|
+
/**
|
|
1956
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
1957
|
+
* @summary Bulk update an entitlement list
|
|
1958
|
+
* @param {EntitlementBulkUpdateRequestV2026} entitlementBulkUpdateRequestV2026
|
|
1959
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1960
|
+
* @throws {RequiredError}
|
|
1961
|
+
*/
|
|
1962
|
+
updateEntitlementsInBulk(entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026, axiosOptions?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
1963
|
+
};
|
|
1964
|
+
/**
|
|
1965
|
+
* EntitlementsV2026Api - factory interface
|
|
1966
|
+
* @export
|
|
1967
|
+
*/
|
|
1968
|
+
export declare const EntitlementsV2026ApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
1969
|
+
/**
|
|
1970
|
+
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
1971
|
+
* @summary Get entitlements for an account
|
|
1972
|
+
* @param {EntitlementsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters.
|
|
1973
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1974
|
+
* @throws {RequiredError}
|
|
1975
|
+
*/
|
|
1976
|
+
getAccountEntitlements(requestParameters: EntitlementsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>>;
|
|
1977
|
+
/**
|
|
1978
|
+
* This API returns an entitlement by its ID.
|
|
1979
|
+
* @summary Get an entitlement
|
|
1980
|
+
* @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
|
|
1981
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1982
|
+
* @throws {RequiredError}
|
|
1983
|
+
*/
|
|
1984
|
+
getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2026>;
|
|
1985
|
+
/**
|
|
1986
|
+
* This API returns a list of all child entitlements of a given entitlement.
|
|
1987
|
+
* @summary List of entitlements children
|
|
1988
|
+
* @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters.
|
|
1989
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1990
|
+
* @throws {RequiredError}
|
|
1991
|
+
*/
|
|
1992
|
+
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>>;
|
|
1993
|
+
/**
|
|
1994
|
+
* This API returns a list of all parent entitlements of a given entitlement.
|
|
1995
|
+
* @summary List of entitlements parents
|
|
1996
|
+
* @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters.
|
|
1997
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
1998
|
+
* @throws {RequiredError}
|
|
1999
|
+
*/
|
|
2000
|
+
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>>;
|
|
2001
|
+
/**
|
|
2002
|
+
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
2003
|
+
* @summary Gets a list of entitlements.
|
|
2004
|
+
* @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
|
|
2005
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2006
|
+
* @throws {RequiredError}
|
|
2007
|
+
*/
|
|
2008
|
+
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<Array<EntitlementV2026>>;
|
|
2009
|
+
/**
|
|
2010
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
2011
|
+
* @summary Patch an entitlement
|
|
2012
|
+
* @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
|
|
2013
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2014
|
+
* @throws {RequiredError}
|
|
2015
|
+
*/
|
|
2016
|
+
patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<EntitlementV2026>;
|
|
2017
|
+
/**
|
|
2018
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
2019
|
+
* @summary Bulk update an entitlement list
|
|
2020
|
+
* @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
2021
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2022
|
+
* @throws {RequiredError}
|
|
2023
|
+
*/
|
|
2024
|
+
updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): AxiosPromise<void>;
|
|
2025
|
+
};
|
|
2026
|
+
/**
|
|
2027
|
+
* Request parameters for getAccountEntitlements operation in EntitlementsV2026Api.
|
|
2028
|
+
* @export
|
|
2029
|
+
* @interface EntitlementsV2026ApiGetAccountEntitlementsRequest
|
|
2030
|
+
*/
|
|
2031
|
+
export interface EntitlementsV2026ApiGetAccountEntitlementsRequest {
|
|
2032
|
+
/**
|
|
2033
|
+
* The account ID to get entitlements for
|
|
2034
|
+
* @type {string}
|
|
2035
|
+
* @memberof EntitlementsV2026ApiGetAccountEntitlements
|
|
2036
|
+
*/
|
|
2037
|
+
readonly accountId: string;
|
|
2038
|
+
/**
|
|
2039
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2040
|
+
* @type {number}
|
|
2041
|
+
* @memberof EntitlementsV2026ApiGetAccountEntitlements
|
|
2042
|
+
*/
|
|
2043
|
+
readonly limit?: number;
|
|
2044
|
+
/**
|
|
2045
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2046
|
+
* @type {number}
|
|
2047
|
+
* @memberof EntitlementsV2026ApiGetAccountEntitlements
|
|
2048
|
+
*/
|
|
2049
|
+
readonly offset?: number;
|
|
2050
|
+
/**
|
|
2051
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2052
|
+
* @type {boolean}
|
|
2053
|
+
* @memberof EntitlementsV2026ApiGetAccountEntitlements
|
|
2054
|
+
*/
|
|
2055
|
+
readonly count?: boolean;
|
|
2056
|
+
}
|
|
2057
|
+
/**
|
|
2058
|
+
* Request parameters for getEntitlement operation in EntitlementsV2026Api.
|
|
2059
|
+
* @export
|
|
2060
|
+
* @interface EntitlementsV2026ApiGetEntitlementRequest
|
|
2061
|
+
*/
|
|
2062
|
+
export interface EntitlementsV2026ApiGetEntitlementRequest {
|
|
2063
|
+
/**
|
|
2064
|
+
* The entitlement ID
|
|
2065
|
+
* @type {string}
|
|
2066
|
+
* @memberof EntitlementsV2026ApiGetEntitlement
|
|
2067
|
+
*/
|
|
2068
|
+
readonly id: string;
|
|
2069
|
+
}
|
|
2070
|
+
/**
|
|
2071
|
+
* Request parameters for listEntitlementChildren operation in EntitlementsV2026Api.
|
|
2072
|
+
* @export
|
|
2073
|
+
* @interface EntitlementsV2026ApiListEntitlementChildrenRequest
|
|
2074
|
+
*/
|
|
2075
|
+
export interface EntitlementsV2026ApiListEntitlementChildrenRequest {
|
|
2076
|
+
/**
|
|
2077
|
+
* Entitlement Id
|
|
2078
|
+
* @type {string}
|
|
2079
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2080
|
+
*/
|
|
2081
|
+
readonly id: string;
|
|
2082
|
+
/**
|
|
2083
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2084
|
+
* @type {number}
|
|
2085
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2086
|
+
*/
|
|
2087
|
+
readonly limit?: number;
|
|
2088
|
+
/**
|
|
2089
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2090
|
+
* @type {number}
|
|
2091
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2092
|
+
*/
|
|
2093
|
+
readonly offset?: number;
|
|
2094
|
+
/**
|
|
2095
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2096
|
+
* @type {boolean}
|
|
2097
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2098
|
+
*/
|
|
2099
|
+
readonly count?: boolean;
|
|
2100
|
+
/**
|
|
2101
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
2102
|
+
* @type {string}
|
|
2103
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2104
|
+
*/
|
|
2105
|
+
readonly sorters?: string;
|
|
2106
|
+
/**
|
|
2107
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
2108
|
+
* @type {string}
|
|
2109
|
+
* @memberof EntitlementsV2026ApiListEntitlementChildren
|
|
2110
|
+
*/
|
|
2111
|
+
readonly filters?: string;
|
|
2112
|
+
}
|
|
2113
|
+
/**
|
|
2114
|
+
* Request parameters for listEntitlementParents operation in EntitlementsV2026Api.
|
|
2115
|
+
* @export
|
|
2116
|
+
* @interface EntitlementsV2026ApiListEntitlementParentsRequest
|
|
2117
|
+
*/
|
|
2118
|
+
export interface EntitlementsV2026ApiListEntitlementParentsRequest {
|
|
2119
|
+
/**
|
|
2120
|
+
* Entitlement Id
|
|
2121
|
+
* @type {string}
|
|
2122
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2123
|
+
*/
|
|
2124
|
+
readonly id: string;
|
|
2125
|
+
/**
|
|
2126
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2127
|
+
* @type {number}
|
|
2128
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2129
|
+
*/
|
|
2130
|
+
readonly limit?: number;
|
|
2131
|
+
/**
|
|
2132
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2133
|
+
* @type {number}
|
|
2134
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2135
|
+
*/
|
|
2136
|
+
readonly offset?: number;
|
|
2137
|
+
/**
|
|
2138
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2139
|
+
* @type {boolean}
|
|
2140
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2141
|
+
*/
|
|
2142
|
+
readonly count?: boolean;
|
|
2143
|
+
/**
|
|
2144
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id**
|
|
2145
|
+
* @type {string}
|
|
2146
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2147
|
+
*/
|
|
2148
|
+
readonly sorters?: string;
|
|
2149
|
+
/**
|
|
2150
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
2151
|
+
* @type {string}
|
|
2152
|
+
* @memberof EntitlementsV2026ApiListEntitlementParents
|
|
2153
|
+
*/
|
|
2154
|
+
readonly filters?: string;
|
|
2155
|
+
}
|
|
2156
|
+
/**
|
|
2157
|
+
* Request parameters for listEntitlements operation in EntitlementsV2026Api.
|
|
2158
|
+
* @export
|
|
2159
|
+
* @interface EntitlementsV2026ApiListEntitlementsRequest
|
|
2160
|
+
*/
|
|
2161
|
+
export interface EntitlementsV2026ApiListEntitlementsRequest {
|
|
2162
|
+
/**
|
|
2163
|
+
* If present and not empty, additionally filters Entitlements to those which are assigned to the Segment(s) which are visible to the Identity with the specified ID. Cannot be specified with the **account-id** or **for-segment-ids** param(s). It is also illegal to specify a value that refers to a different user\'s Identity.
|
|
2164
|
+
* @type {string}
|
|
2165
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2166
|
+
*/
|
|
2167
|
+
readonly segmentedForIdentity?: string;
|
|
2168
|
+
/**
|
|
2169
|
+
* If present and not empty, additionally filters Access Profiles to those which are assigned to the Segment(s) with the specified IDs. Cannot be specified with the **account-id** or **segmented-for-identity** param(s).
|
|
2170
|
+
* @type {string}
|
|
2171
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2172
|
+
*/
|
|
2173
|
+
readonly forSegmentIds?: string;
|
|
2174
|
+
/**
|
|
2175
|
+
* Whether or not the response list should contain unsegmented Entitlements. If **for-segment-ids** and **segmented-for-identity** are both absent or empty, specifying **include-unsegmented=false** results in an error.
|
|
2176
|
+
* @type {boolean}
|
|
2177
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2178
|
+
*/
|
|
2179
|
+
readonly includeUnsegmented?: boolean;
|
|
2180
|
+
/**
|
|
2181
|
+
* Offset into the full result set. Usually specified with *limit* to paginate through the results. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2182
|
+
* @type {number}
|
|
2183
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2184
|
+
*/
|
|
2185
|
+
readonly offset?: number;
|
|
2186
|
+
/**
|
|
2187
|
+
* Max number of results to return. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2188
|
+
* @type {number}
|
|
2189
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2190
|
+
*/
|
|
2191
|
+
readonly limit?: number;
|
|
2192
|
+
/**
|
|
2193
|
+
* If *true* it will populate the *X-Total-Count* response header with the number of results that would be returned if *limit* and *offset* were ignored. Since requesting a total count can have a performance impact, it is recommended not to send **count=true** if that value will not be used. See [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters) for more information.
|
|
2194
|
+
* @type {boolean}
|
|
2195
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2196
|
+
*/
|
|
2197
|
+
readonly count?: boolean;
|
|
2198
|
+
/**
|
|
2199
|
+
* Sort results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#sorting-results) Sorting is supported for the following fields: **id, name, created, modified, type, attribute, value, source.id, requestable**
|
|
2200
|
+
* @type {string}
|
|
2201
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2202
|
+
*/
|
|
2203
|
+
readonly sorters?: string;
|
|
2204
|
+
/**
|
|
2205
|
+
* Filter results using the standard syntax described in [V3 API Standard Collection Parameters](https://developer.sailpoint.com/idn/api/standard-collection-parameters#filtering-results) Filtering is supported for the following fields and operators: **id**: *eq, in* **name**: *eq, in, sw* **type**: *eq, in* **attribute**: *eq, in* **value**: *eq, in, sw* **source.id**: *eq, in* **requestable**: *eq* **created**: *gt, lt, ge, le* **modified**: *gt, lt, ge, le* **owner.id**: *eq, in* **tags**: *eq* **privilegeLevel.direct**: *eq*
|
|
2206
|
+
* @type {string}
|
|
2207
|
+
* @memberof EntitlementsV2026ApiListEntitlements
|
|
2208
|
+
*/
|
|
2209
|
+
readonly filters?: string;
|
|
2210
|
+
}
|
|
2211
|
+
/**
|
|
2212
|
+
* Request parameters for patchEntitlement operation in EntitlementsV2026Api.
|
|
2213
|
+
* @export
|
|
2214
|
+
* @interface EntitlementsV2026ApiPatchEntitlementRequest
|
|
2215
|
+
*/
|
|
2216
|
+
export interface EntitlementsV2026ApiPatchEntitlementRequest {
|
|
2217
|
+
/**
|
|
2218
|
+
* ID of the entitlement to patch
|
|
2219
|
+
* @type {string}
|
|
2220
|
+
* @memberof EntitlementsV2026ApiPatchEntitlement
|
|
2221
|
+
*/
|
|
2222
|
+
readonly id: string;
|
|
2223
|
+
/**
|
|
2224
|
+
*
|
|
2225
|
+
* @type {Array<JsonPatchOperationV2026>}
|
|
2226
|
+
* @memberof EntitlementsV2026ApiPatchEntitlement
|
|
2227
|
+
*/
|
|
2228
|
+
readonly jsonPatchOperationV2026?: Array<JsonPatchOperationV2026>;
|
|
2229
|
+
}
|
|
2230
|
+
/**
|
|
2231
|
+
* Request parameters for updateEntitlementsInBulk operation in EntitlementsV2026Api.
|
|
2232
|
+
* @export
|
|
2233
|
+
* @interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest
|
|
2234
|
+
*/
|
|
2235
|
+
export interface EntitlementsV2026ApiUpdateEntitlementsInBulkRequest {
|
|
2236
|
+
/**
|
|
2237
|
+
*
|
|
2238
|
+
* @type {EntitlementBulkUpdateRequestV2026}
|
|
2239
|
+
* @memberof EntitlementsV2026ApiUpdateEntitlementsInBulk
|
|
2240
|
+
*/
|
|
2241
|
+
readonly entitlementBulkUpdateRequestV2026: EntitlementBulkUpdateRequestV2026;
|
|
2242
|
+
}
|
|
2243
|
+
/**
|
|
2244
|
+
* EntitlementsV2026Api - object-oriented interface
|
|
2245
|
+
* @export
|
|
2246
|
+
* @class EntitlementsV2026Api
|
|
2247
|
+
* @extends {BaseAPI}
|
|
2248
|
+
*/
|
|
2249
|
+
export declare class EntitlementsV2026Api extends BaseAPI {
|
|
2250
|
+
/**
|
|
2251
|
+
* This API returns a list of all entitlements associated with the given account ID. The account must exist; if not found, the API returns 404.
|
|
2252
|
+
* @summary Get entitlements for an account
|
|
2253
|
+
* @param {EntitlementsV2026ApiGetAccountEntitlementsRequest} requestParameters Request parameters.
|
|
2254
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2255
|
+
* @throws {RequiredError}
|
|
2256
|
+
* @memberof EntitlementsV2026Api
|
|
2257
|
+
*/
|
|
2258
|
+
getAccountEntitlements(requestParameters: EntitlementsV2026ApiGetAccountEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026[], any>>;
|
|
2259
|
+
/**
|
|
2260
|
+
* This API returns an entitlement by its ID.
|
|
2261
|
+
* @summary Get an entitlement
|
|
2262
|
+
* @param {EntitlementsV2026ApiGetEntitlementRequest} requestParameters Request parameters.
|
|
2263
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2264
|
+
* @throws {RequiredError}
|
|
2265
|
+
* @memberof EntitlementsV2026Api
|
|
2266
|
+
*/
|
|
2267
|
+
getEntitlement(requestParameters: EntitlementsV2026ApiGetEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026, any>>;
|
|
2268
|
+
/**
|
|
2269
|
+
* This API returns a list of all child entitlements of a given entitlement.
|
|
2270
|
+
* @summary List of entitlements children
|
|
2271
|
+
* @param {EntitlementsV2026ApiListEntitlementChildrenRequest} requestParameters Request parameters.
|
|
2272
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2273
|
+
* @throws {RequiredError}
|
|
2274
|
+
* @memberof EntitlementsV2026Api
|
|
2275
|
+
*/
|
|
2276
|
+
listEntitlementChildren(requestParameters: EntitlementsV2026ApiListEntitlementChildrenRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026[], any>>;
|
|
2277
|
+
/**
|
|
2278
|
+
* This API returns a list of all parent entitlements of a given entitlement.
|
|
2279
|
+
* @summary List of entitlements parents
|
|
2280
|
+
* @param {EntitlementsV2026ApiListEntitlementParentsRequest} requestParameters Request parameters.
|
|
2281
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2282
|
+
* @throws {RequiredError}
|
|
2283
|
+
* @memberof EntitlementsV2026Api
|
|
2284
|
+
*/
|
|
2285
|
+
listEntitlementParents(requestParameters: EntitlementsV2026ApiListEntitlementParentsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026[], any>>;
|
|
2286
|
+
/**
|
|
2287
|
+
* This API returns a list of entitlements. This API can be used in one of the two following ways: either getting entitlements for a specific **account-id**, or getting via use of **filters** (those two options are exclusive). Any authenticated token can call this API.
|
|
2288
|
+
* @summary Gets a list of entitlements.
|
|
2289
|
+
* @param {EntitlementsV2026ApiListEntitlementsRequest} requestParameters Request parameters.
|
|
2290
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2291
|
+
* @throws {RequiredError}
|
|
2292
|
+
* @memberof EntitlementsV2026Api
|
|
2293
|
+
*/
|
|
2294
|
+
listEntitlements(requestParameters?: EntitlementsV2026ApiListEntitlementsRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026[], any>>;
|
|
2295
|
+
/**
|
|
2296
|
+
* This API updates an existing entitlement using [JSON Patch](https://tools.ietf.org/html/rfc6902) syntax. The following fields are patchable: **requestable**, **segments**, **privilegeOverride/level**, **owner**, **name**, **description**, and **manuallyUpdatedFields** When you\'re patching owner, only owner type and owner id must be provided. Owner name is optional, and it won\'t be modified. If the owner name is provided, it should correspond to the real name. The only owner type currently supported is IDENTITY.
|
|
2297
|
+
* @summary Patch an entitlement
|
|
2298
|
+
* @param {EntitlementsV2026ApiPatchEntitlementRequest} requestParameters Request parameters.
|
|
2299
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2300
|
+
* @throws {RequiredError}
|
|
2301
|
+
* @memberof EntitlementsV2026Api
|
|
2302
|
+
*/
|
|
2303
|
+
patchEntitlement(requestParameters: EntitlementsV2026ApiPatchEntitlementRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<EntitlementV2026, any>>;
|
|
2304
|
+
/**
|
|
2305
|
+
* This API applies an update to every entitlement of the list. The number of entitlements to update is limited to 50 items maximum. The JsonPatch update follows the [JSON Patch](https://tools.ietf.org/html/rfc6902) standard. examples of allowed operations : `**{ \"op\": \"replace\", \"path\": \"/requestable\",\"value\": boolean }**` `**{ \"op\": \"replace\", \"path\": \"/privilegeOverride/level\",\"value\": string }**` A token with ORG_ADMIN or API authority is required to call this API.
|
|
2306
|
+
* @summary Bulk update an entitlement list
|
|
2307
|
+
* @param {EntitlementsV2026ApiUpdateEntitlementsInBulkRequest} requestParameters Request parameters.
|
|
2308
|
+
* @param {*} [axiosOptions] Override http request option.
|
|
2309
|
+
* @throws {RequiredError}
|
|
2310
|
+
* @memberof EntitlementsV2026Api
|
|
2311
|
+
*/
|
|
2312
|
+
updateEntitlementsInBulk(requestParameters: EntitlementsV2026ApiUpdateEntitlementsInBulkRequest, axiosOptions?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
|
|
2313
|
+
}
|
|
1423
2314
|
/**
|
|
1424
2315
|
* HumanAccountDeletionApprovalConfigV2026Api - axios parameter creator
|
|
1425
2316
|
* @export
|