@envsync-cloud/envsync-management-ts-sdk 0.9.0 → 0.10.0
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/index.d.mts +732 -4
- package/dist/index.d.ts +732 -4
- package/dist/index.js +988 -86
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +972 -86
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -54,6 +54,220 @@ declare abstract class BaseHttpRequest {
|
|
|
54
54
|
abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
|
|
55
55
|
}
|
|
56
56
|
|
|
57
|
+
type CleanupResponse = {
|
|
58
|
+
cleaned: number;
|
|
59
|
+
};
|
|
60
|
+
|
|
61
|
+
type CreateDynamicSecretEngineRequest = {
|
|
62
|
+
engine_type: CreateDynamicSecretEngineRequest.engine_type;
|
|
63
|
+
name: string;
|
|
64
|
+
config: ({
|
|
65
|
+
host: string;
|
|
66
|
+
port?: number;
|
|
67
|
+
database: string;
|
|
68
|
+
superuser: {
|
|
69
|
+
username: string;
|
|
70
|
+
password: string;
|
|
71
|
+
};
|
|
72
|
+
creation_statements?: Array<string>;
|
|
73
|
+
default_ttl_seconds?: number;
|
|
74
|
+
max_ttl_seconds?: number;
|
|
75
|
+
} | {
|
|
76
|
+
access_key_id: string;
|
|
77
|
+
secret_access_key: string;
|
|
78
|
+
region?: string;
|
|
79
|
+
iam_policy: string;
|
|
80
|
+
default_ttl_seconds?: number;
|
|
81
|
+
max_ttl_seconds?: number;
|
|
82
|
+
} | {
|
|
83
|
+
tenant_id: string;
|
|
84
|
+
client_id: string;
|
|
85
|
+
client_secret: string;
|
|
86
|
+
subscription_id: string;
|
|
87
|
+
roles?: Array<string>;
|
|
88
|
+
default_ttl_seconds?: number;
|
|
89
|
+
max_ttl_seconds?: number;
|
|
90
|
+
});
|
|
91
|
+
enabled?: boolean;
|
|
92
|
+
};
|
|
93
|
+
declare namespace CreateDynamicSecretEngineRequest {
|
|
94
|
+
enum engine_type {
|
|
95
|
+
POSTGRES = "postgres",
|
|
96
|
+
MYSQL = "mysql",
|
|
97
|
+
AWS_IAM = "aws-iam",
|
|
98
|
+
AZURE_SP = "azure-sp"
|
|
99
|
+
}
|
|
100
|
+
}
|
|
101
|
+
|
|
102
|
+
type CreateDynamicSecretLeaseRequest = {
|
|
103
|
+
app_id: string;
|
|
104
|
+
env_type_id: string;
|
|
105
|
+
variable_key: string;
|
|
106
|
+
ttl_seconds?: number;
|
|
107
|
+
};
|
|
108
|
+
|
|
109
|
+
type DynamicSecretEngineResponse = {
|
|
110
|
+
id: string;
|
|
111
|
+
org_id: string;
|
|
112
|
+
engine_type: DynamicSecretEngineResponse.engine_type;
|
|
113
|
+
name: string;
|
|
114
|
+
config: Record<string, any>;
|
|
115
|
+
enabled: boolean;
|
|
116
|
+
created_at: string;
|
|
117
|
+
updated_at: string;
|
|
118
|
+
};
|
|
119
|
+
declare namespace DynamicSecretEngineResponse {
|
|
120
|
+
enum engine_type {
|
|
121
|
+
POSTGRES = "postgres",
|
|
122
|
+
MYSQL = "mysql",
|
|
123
|
+
AWS_IAM = "aws-iam",
|
|
124
|
+
AZURE_SP = "azure-sp"
|
|
125
|
+
}
|
|
126
|
+
}
|
|
127
|
+
|
|
128
|
+
type DynamicSecretEnginesResponse = Array<DynamicSecretEngineResponse>;
|
|
129
|
+
|
|
130
|
+
type DynamicSecretLeaseResponse = {
|
|
131
|
+
id: string;
|
|
132
|
+
engine_id: string;
|
|
133
|
+
app_id: string;
|
|
134
|
+
env_type_id: string;
|
|
135
|
+
variable_key: string;
|
|
136
|
+
credential_data: Record<string, any>;
|
|
137
|
+
expires_at: string;
|
|
138
|
+
revoked_at: string | null;
|
|
139
|
+
created_at: string;
|
|
140
|
+
updated_at: string;
|
|
141
|
+
};
|
|
142
|
+
|
|
143
|
+
type DynamicSecretLeasesResponse = Array<DynamicSecretLeaseResponse>;
|
|
144
|
+
|
|
145
|
+
type ErrorResponse = {
|
|
146
|
+
error: string;
|
|
147
|
+
};
|
|
148
|
+
|
|
149
|
+
type RevokeLeaseResponse = {
|
|
150
|
+
message: string;
|
|
151
|
+
id: string;
|
|
152
|
+
};
|
|
153
|
+
|
|
154
|
+
type UpdateDynamicSecretEngineRequest = {
|
|
155
|
+
name?: string;
|
|
156
|
+
config?: ({
|
|
157
|
+
host: string;
|
|
158
|
+
port?: number;
|
|
159
|
+
database: string;
|
|
160
|
+
superuser: {
|
|
161
|
+
username: string;
|
|
162
|
+
password: string;
|
|
163
|
+
};
|
|
164
|
+
creation_statements?: Array<string>;
|
|
165
|
+
default_ttl_seconds?: number;
|
|
166
|
+
max_ttl_seconds?: number;
|
|
167
|
+
} | {
|
|
168
|
+
access_key_id: string;
|
|
169
|
+
secret_access_key: string;
|
|
170
|
+
region?: string;
|
|
171
|
+
iam_policy: string;
|
|
172
|
+
default_ttl_seconds?: number;
|
|
173
|
+
max_ttl_seconds?: number;
|
|
174
|
+
} | {
|
|
175
|
+
tenant_id: string;
|
|
176
|
+
client_id: string;
|
|
177
|
+
client_secret: string;
|
|
178
|
+
subscription_id: string;
|
|
179
|
+
roles?: Array<string>;
|
|
180
|
+
default_ttl_seconds?: number;
|
|
181
|
+
max_ttl_seconds?: number;
|
|
182
|
+
});
|
|
183
|
+
enabled?: boolean;
|
|
184
|
+
};
|
|
185
|
+
|
|
186
|
+
declare class DynamicSecretsService {
|
|
187
|
+
readonly httpRequest: BaseHttpRequest;
|
|
188
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
189
|
+
/**
|
|
190
|
+
* Create Dynamic Secret Engine
|
|
191
|
+
* Create a new dynamic secret engine for short-lived credential generation
|
|
192
|
+
* @param requestBody
|
|
193
|
+
* @returns DynamicSecretEngineResponse Engine created successfully
|
|
194
|
+
* @throws ApiError
|
|
195
|
+
*/
|
|
196
|
+
createDynamicSecretEngine(requestBody?: CreateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
197
|
+
/**
|
|
198
|
+
* Get All Dynamic Secret Engines
|
|
199
|
+
* Retrieve all dynamic secret engines for the organization
|
|
200
|
+
* @returns DynamicSecretEnginesResponse Engines retrieved successfully
|
|
201
|
+
* @throws ApiError
|
|
202
|
+
*/
|
|
203
|
+
getAllDynamicSecretEngines(): CancelablePromise<DynamicSecretEnginesResponse>;
|
|
204
|
+
/**
|
|
205
|
+
* Get Dynamic Secret Engine
|
|
206
|
+
* Retrieve a specific dynamic secret engine by ID
|
|
207
|
+
* @param id
|
|
208
|
+
* @returns DynamicSecretEngineResponse Engine retrieved successfully
|
|
209
|
+
* @throws ApiError
|
|
210
|
+
*/
|
|
211
|
+
getDynamicSecretEngine(id: string): CancelablePromise<DynamicSecretEngineResponse>;
|
|
212
|
+
/**
|
|
213
|
+
* Update Dynamic Secret Engine
|
|
214
|
+
* Update an existing dynamic secret engine
|
|
215
|
+
* @param id
|
|
216
|
+
* @param requestBody
|
|
217
|
+
* @returns DynamicSecretEngineResponse Engine updated successfully
|
|
218
|
+
* @throws ApiError
|
|
219
|
+
*/
|
|
220
|
+
updateDynamicSecretEngine(id: string, requestBody?: UpdateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
221
|
+
/**
|
|
222
|
+
* Delete Dynamic Secret Engine
|
|
223
|
+
* Delete a dynamic secret engine (must have no active leases)
|
|
224
|
+
* @param id
|
|
225
|
+
* @returns ErrorResponse Engine deleted successfully
|
|
226
|
+
* @throws ApiError
|
|
227
|
+
*/
|
|
228
|
+
deleteDynamicSecretEngine(id: string): CancelablePromise<ErrorResponse>;
|
|
229
|
+
/**
|
|
230
|
+
* Create Dynamic Secret Lease
|
|
231
|
+
* Generate short-lived credentials by creating a lease on an engine
|
|
232
|
+
* @param id
|
|
233
|
+
* @param requestBody
|
|
234
|
+
* @returns DynamicSecretLeaseResponse Lease created successfully
|
|
235
|
+
* @throws ApiError
|
|
236
|
+
*/
|
|
237
|
+
createDynamicSecretLease(id: string, requestBody?: CreateDynamicSecretLeaseRequest): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
238
|
+
/**
|
|
239
|
+
* Get Leases for Engine
|
|
240
|
+
* Retrieve all leases for a specific dynamic secret engine
|
|
241
|
+
* @param id
|
|
242
|
+
* @returns DynamicSecretLeasesResponse Leases retrieved successfully
|
|
243
|
+
* @throws ApiError
|
|
244
|
+
*/
|
|
245
|
+
getDynamicSecretLeases(id: string): CancelablePromise<DynamicSecretLeasesResponse>;
|
|
246
|
+
/**
|
|
247
|
+
* Get Dynamic Secret Lease
|
|
248
|
+
* Retrieve a specific lease by ID
|
|
249
|
+
* @param leaseId
|
|
250
|
+
* @returns DynamicSecretLeaseResponse Lease retrieved successfully
|
|
251
|
+
* @throws ApiError
|
|
252
|
+
*/
|
|
253
|
+
getDynamicSecretLease(leaseId: string): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
254
|
+
/**
|
|
255
|
+
* Revoke Dynamic Secret Lease
|
|
256
|
+
* Revoke a lease and its associated credentials
|
|
257
|
+
* @param leaseId
|
|
258
|
+
* @returns RevokeLeaseResponse Lease revoked successfully
|
|
259
|
+
* @throws ApiError
|
|
260
|
+
*/
|
|
261
|
+
revokeDynamicSecretLease(leaseId: string): CancelablePromise<RevokeLeaseResponse>;
|
|
262
|
+
/**
|
|
263
|
+
* Cleanup Expired Leases
|
|
264
|
+
* Mark all expired leases as revoked (admin operation)
|
|
265
|
+
* @returns CleanupResponse Cleanup completed
|
|
266
|
+
* @throws ApiError
|
|
267
|
+
*/
|
|
268
|
+
cleanupExpiredLeases(): CancelablePromise<CleanupResponse>;
|
|
269
|
+
}
|
|
270
|
+
|
|
57
271
|
type CreateEnvTypeMappingRequest = {
|
|
58
272
|
env_type_id: string;
|
|
59
273
|
integration_binding_id: string;
|
|
@@ -460,6 +674,14 @@ type LicenseState = {
|
|
|
460
674
|
last_verified_at?: string | null;
|
|
461
675
|
last_error_code?: string | null;
|
|
462
676
|
last_error_message?: string | null;
|
|
677
|
+
validation_mode?: LicenseState.validation_mode;
|
|
678
|
+
certificate_serial_hex?: string | null;
|
|
679
|
+
certificate_fingerprint_sha256?: string | null;
|
|
680
|
+
certificate_subject?: string | null;
|
|
681
|
+
certificate_issuer?: string | null;
|
|
682
|
+
certificate_expires_at?: string | null;
|
|
683
|
+
root_ca_fingerprint_sha256?: string | null;
|
|
684
|
+
validated_at?: string | null;
|
|
463
685
|
};
|
|
464
686
|
declare namespace LicenseState {
|
|
465
687
|
enum status {
|
|
@@ -470,6 +692,11 @@ declare namespace LicenseState {
|
|
|
470
692
|
ERROR = "error",
|
|
471
693
|
LOCKED = "locked"
|
|
472
694
|
}
|
|
695
|
+
enum validation_mode {
|
|
696
|
+
NONE = "none",
|
|
697
|
+
LEASE = "lease",
|
|
698
|
+
CERTIFICATE = "certificate"
|
|
699
|
+
}
|
|
473
700
|
}
|
|
474
701
|
|
|
475
702
|
type LicenseActionResponse = {
|
|
@@ -507,6 +734,180 @@ declare class LicenseService {
|
|
|
507
734
|
verifyManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
508
735
|
}
|
|
509
736
|
|
|
737
|
+
type CreateLogForwardingRequest = {
|
|
738
|
+
name: string;
|
|
739
|
+
provider_type: CreateLogForwardingRequest.provider_type;
|
|
740
|
+
config: Record<string, any>;
|
|
741
|
+
enabled?: boolean;
|
|
742
|
+
};
|
|
743
|
+
declare namespace CreateLogForwardingRequest {
|
|
744
|
+
enum provider_type {
|
|
745
|
+
DATADOG = "datadog",
|
|
746
|
+
SPLUNK = "splunk",
|
|
747
|
+
SUMO_LOGIC = "sumo-logic"
|
|
748
|
+
}
|
|
749
|
+
}
|
|
750
|
+
|
|
751
|
+
type LogForwardingResponse = {
|
|
752
|
+
id: string;
|
|
753
|
+
org_id: string;
|
|
754
|
+
name: string;
|
|
755
|
+
provider_type: LogForwardingResponse.provider_type;
|
|
756
|
+
config: Record<string, any>;
|
|
757
|
+
enabled: boolean;
|
|
758
|
+
created_at: string;
|
|
759
|
+
updated_at: string;
|
|
760
|
+
};
|
|
761
|
+
declare namespace LogForwardingResponse {
|
|
762
|
+
enum provider_type {
|
|
763
|
+
DATADOG = "datadog",
|
|
764
|
+
SPLUNK = "splunk",
|
|
765
|
+
SUMO_LOGIC = "sumo-logic"
|
|
766
|
+
}
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
type LogForwardingsResponse = Array<LogForwardingResponse>;
|
|
770
|
+
|
|
771
|
+
declare class LogForwardingService {
|
|
772
|
+
readonly httpRequest: BaseHttpRequest;
|
|
773
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
774
|
+
/**
|
|
775
|
+
* Create Log Forwarding Config
|
|
776
|
+
* Create a new log forwarding configuration for the organization
|
|
777
|
+
* @param requestBody
|
|
778
|
+
* @returns LogForwardingResponse Log forwarding config created successfully
|
|
779
|
+
* @throws ApiError
|
|
780
|
+
*/
|
|
781
|
+
createLogForwardingConfig(requestBody?: CreateLogForwardingRequest): CancelablePromise<LogForwardingResponse>;
|
|
782
|
+
/**
|
|
783
|
+
* Get All Log Forwarding Configs
|
|
784
|
+
* Retrieve all log forwarding configurations for the organization
|
|
785
|
+
* @returns LogForwardingsResponse Log forwarding configs retrieved successfully
|
|
786
|
+
* @throws ApiError
|
|
787
|
+
*/
|
|
788
|
+
getLogForwardingConfigs(): CancelablePromise<LogForwardingsResponse>;
|
|
789
|
+
/**
|
|
790
|
+
* Get Log Forwarding Config
|
|
791
|
+
* Retrieve a specific log forwarding configuration
|
|
792
|
+
* @param id
|
|
793
|
+
* @returns LogForwardingResponse Log forwarding config retrieved successfully
|
|
794
|
+
* @throws ApiError
|
|
795
|
+
*/
|
|
796
|
+
getLogForwardingConfig(id: string): CancelablePromise<LogForwardingResponse>;
|
|
797
|
+
/**
|
|
798
|
+
* Delete Log Forwarding Config
|
|
799
|
+
* Delete a log forwarding configuration
|
|
800
|
+
* @param id
|
|
801
|
+
* @returns ErrorResponse Log forwarding config deleted successfully
|
|
802
|
+
* @throws ApiError
|
|
803
|
+
*/
|
|
804
|
+
deleteLogForwardingConfig(id: string): CancelablePromise<ErrorResponse>;
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
type CreateOidcProviderRequest = {
|
|
808
|
+
/**
|
|
809
|
+
* CI/CD platform type
|
|
810
|
+
*/
|
|
811
|
+
provider_type: CreateOidcProviderRequest.provider_type;
|
|
812
|
+
/**
|
|
813
|
+
* OIDC issuer URL
|
|
814
|
+
*/
|
|
815
|
+
issuer_url: string;
|
|
816
|
+
/**
|
|
817
|
+
* Expected audience claim value
|
|
818
|
+
*/
|
|
819
|
+
audience: string;
|
|
820
|
+
/**
|
|
821
|
+
* Subject patterns to allow (glob matching). Empty = allow all subjects from this issuer.
|
|
822
|
+
*/
|
|
823
|
+
allowed_subjects?: Array<string>;
|
|
824
|
+
};
|
|
825
|
+
declare namespace CreateOidcProviderRequest {
|
|
826
|
+
/**
|
|
827
|
+
* CI/CD platform type
|
|
828
|
+
*/
|
|
829
|
+
enum provider_type {
|
|
830
|
+
GITHUB_ACTIONS = "github_actions",
|
|
831
|
+
GITLAB_CI = "gitlab_ci",
|
|
832
|
+
KUBERNETES = "kubernetes",
|
|
833
|
+
GENERIC = "generic"
|
|
834
|
+
}
|
|
835
|
+
}
|
|
836
|
+
|
|
837
|
+
type OidcProviderResponse = {
|
|
838
|
+
id: string;
|
|
839
|
+
org_id: string;
|
|
840
|
+
provider_type: OidcProviderResponse.provider_type;
|
|
841
|
+
issuer_url: string;
|
|
842
|
+
audience: string;
|
|
843
|
+
enabled: boolean;
|
|
844
|
+
allowed_subjects: Array<string>;
|
|
845
|
+
machine_user_id: string | null;
|
|
846
|
+
created_at: string;
|
|
847
|
+
updated_at: string;
|
|
848
|
+
};
|
|
849
|
+
declare namespace OidcProviderResponse {
|
|
850
|
+
enum provider_type {
|
|
851
|
+
GITHUB_ACTIONS = "github_actions",
|
|
852
|
+
GITLAB_CI = "gitlab_ci",
|
|
853
|
+
KUBERNETES = "kubernetes",
|
|
854
|
+
GENERIC = "generic"
|
|
855
|
+
}
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
type OidcProvidersResponse = Array<OidcProviderResponse>;
|
|
859
|
+
|
|
860
|
+
type UpdateOidcProviderRequest = {
|
|
861
|
+
audience?: string;
|
|
862
|
+
enabled?: boolean;
|
|
863
|
+
allowed_subjects?: Array<string>;
|
|
864
|
+
};
|
|
865
|
+
|
|
866
|
+
declare class OidcProvidersService {
|
|
867
|
+
readonly httpRequest: BaseHttpRequest;
|
|
868
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
869
|
+
/**
|
|
870
|
+
* Register OIDC Provider
|
|
871
|
+
* Register a new OIDC provider for CI/CD machine authentication
|
|
872
|
+
* @param requestBody
|
|
873
|
+
* @returns OidcProviderResponse OIDC provider created successfully
|
|
874
|
+
* @throws ApiError
|
|
875
|
+
*/
|
|
876
|
+
createOidcProvider(requestBody?: CreateOidcProviderRequest): CancelablePromise<OidcProviderResponse>;
|
|
877
|
+
/**
|
|
878
|
+
* Get All OIDC Providers
|
|
879
|
+
* Retrieve all OIDC providers for the organization
|
|
880
|
+
* @returns OidcProvidersResponse OIDC providers retrieved successfully
|
|
881
|
+
* @throws ApiError
|
|
882
|
+
*/
|
|
883
|
+
getAllOidcProviders(): CancelablePromise<OidcProvidersResponse>;
|
|
884
|
+
/**
|
|
885
|
+
* Get OIDC Provider
|
|
886
|
+
* Retrieve a specific OIDC provider
|
|
887
|
+
* @param id
|
|
888
|
+
* @returns OidcProviderResponse OIDC provider retrieved successfully
|
|
889
|
+
* @throws ApiError
|
|
890
|
+
*/
|
|
891
|
+
getOidcProvider(id: string): CancelablePromise<OidcProviderResponse>;
|
|
892
|
+
/**
|
|
893
|
+
* Update OIDC Provider
|
|
894
|
+
* Update an existing OIDC provider
|
|
895
|
+
* @param id
|
|
896
|
+
* @param requestBody
|
|
897
|
+
* @returns ErrorResponse OIDC provider updated successfully
|
|
898
|
+
* @throws ApiError
|
|
899
|
+
*/
|
|
900
|
+
updateOidcProvider(id: string, requestBody?: UpdateOidcProviderRequest): CancelablePromise<ErrorResponse>;
|
|
901
|
+
/**
|
|
902
|
+
* Delete OIDC Provider
|
|
903
|
+
* Delete an existing OIDC provider
|
|
904
|
+
* @param id
|
|
905
|
+
* @returns ErrorResponse OIDC provider deleted successfully
|
|
906
|
+
* @throws ApiError
|
|
907
|
+
*/
|
|
908
|
+
deleteOidcProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
909
|
+
}
|
|
910
|
+
|
|
510
911
|
type AcceptOrgInviteRequest = {
|
|
511
912
|
org_data: {
|
|
512
913
|
name: string;
|
|
@@ -680,6 +1081,326 @@ declare class OnboardingService {
|
|
|
680
1081
|
deleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
681
1082
|
}
|
|
682
1083
|
|
|
1084
|
+
type CreateRotationPolicyRequest = {
|
|
1085
|
+
app_id: string;
|
|
1086
|
+
env_type_id: string;
|
|
1087
|
+
variable_key: string;
|
|
1088
|
+
engine_type: CreateRotationPolicyRequest.engine_type;
|
|
1089
|
+
schedule_cron: string;
|
|
1090
|
+
dual_window_minutes?: number;
|
|
1091
|
+
enabled?: boolean;
|
|
1092
|
+
connection_config: Record<string, any>;
|
|
1093
|
+
};
|
|
1094
|
+
declare namespace CreateRotationPolicyRequest {
|
|
1095
|
+
enum engine_type {
|
|
1096
|
+
POSTGRES = "postgres",
|
|
1097
|
+
MYSQL = "mysql",
|
|
1098
|
+
AWS_IAM = "aws-iam",
|
|
1099
|
+
AZURE_SP = "azure-sp",
|
|
1100
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
1101
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
1102
|
+
SENDGRID = "sendgrid",
|
|
1103
|
+
TWILIO = "twilio"
|
|
1104
|
+
}
|
|
1105
|
+
}
|
|
1106
|
+
|
|
1107
|
+
type RevokeOldCredentialResponse = {
|
|
1108
|
+
message: string;
|
|
1109
|
+
revoked_at: string;
|
|
1110
|
+
};
|
|
1111
|
+
|
|
1112
|
+
type RotationPolicyResponse = {
|
|
1113
|
+
id: string;
|
|
1114
|
+
org_id: string;
|
|
1115
|
+
app_id: string;
|
|
1116
|
+
env_type_id: string;
|
|
1117
|
+
variable_key: string;
|
|
1118
|
+
engine_type: RotationPolicyResponse.engine_type;
|
|
1119
|
+
schedule_cron: string;
|
|
1120
|
+
dual_window_minutes: number;
|
|
1121
|
+
enabled: boolean;
|
|
1122
|
+
last_rotated_at: string | null;
|
|
1123
|
+
next_rotation_at: string | null;
|
|
1124
|
+
created_at: string;
|
|
1125
|
+
updated_at: string;
|
|
1126
|
+
};
|
|
1127
|
+
declare namespace RotationPolicyResponse {
|
|
1128
|
+
enum engine_type {
|
|
1129
|
+
POSTGRES = "postgres",
|
|
1130
|
+
MYSQL = "mysql",
|
|
1131
|
+
AWS_IAM = "aws-iam",
|
|
1132
|
+
AZURE_SP = "azure-sp",
|
|
1133
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
1134
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
1135
|
+
SENDGRID = "sendgrid",
|
|
1136
|
+
TWILIO = "twilio"
|
|
1137
|
+
}
|
|
1138
|
+
}
|
|
1139
|
+
|
|
1140
|
+
type RotationPoliciesResponse = Array<RotationPolicyResponse>;
|
|
1141
|
+
|
|
1142
|
+
type RotationStateResponse = {
|
|
1143
|
+
id: string;
|
|
1144
|
+
rotation_policy_id: string;
|
|
1145
|
+
rotated_at: string;
|
|
1146
|
+
old_credential_expires_at: string;
|
|
1147
|
+
old_credential_revoked: boolean;
|
|
1148
|
+
revoked_at: string | null;
|
|
1149
|
+
created_at: string;
|
|
1150
|
+
};
|
|
1151
|
+
|
|
1152
|
+
type RotationStatesResponse = Array<RotationStateResponse>;
|
|
1153
|
+
|
|
1154
|
+
type TriggerRotationResponse = {
|
|
1155
|
+
message: string;
|
|
1156
|
+
rotation_state_id: string;
|
|
1157
|
+
new_credential_stored: boolean;
|
|
1158
|
+
old_credential_expires_at: string;
|
|
1159
|
+
};
|
|
1160
|
+
|
|
1161
|
+
type UpdateRotationPolicyRequest = {
|
|
1162
|
+
schedule_cron?: string;
|
|
1163
|
+
dual_window_minutes?: number;
|
|
1164
|
+
enabled?: boolean;
|
|
1165
|
+
connection_config?: Record<string, any>;
|
|
1166
|
+
};
|
|
1167
|
+
|
|
1168
|
+
declare class RotationService {
|
|
1169
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1170
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1171
|
+
/**
|
|
1172
|
+
* Create Rotation Policy
|
|
1173
|
+
* Create a new secret rotation policy for a variable
|
|
1174
|
+
* @param requestBody
|
|
1175
|
+
* @returns RotationPolicyResponse Rotation policy created successfully
|
|
1176
|
+
* @throws ApiError
|
|
1177
|
+
*/
|
|
1178
|
+
createRotationPolicy(requestBody?: CreateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
1179
|
+
/**
|
|
1180
|
+
* Get Rotation Policies
|
|
1181
|
+
* List all rotation policies for the organization
|
|
1182
|
+
* @param appId
|
|
1183
|
+
* @param envTypeId
|
|
1184
|
+
* @param enabled
|
|
1185
|
+
* @returns RotationPoliciesResponse Rotation policies retrieved successfully
|
|
1186
|
+
* @throws ApiError
|
|
1187
|
+
*/
|
|
1188
|
+
getRotationPolicies(appId?: string, envTypeId?: string, enabled?: 'true' | 'false'): CancelablePromise<RotationPoliciesResponse>;
|
|
1189
|
+
/**
|
|
1190
|
+
* Get Rotation Policy
|
|
1191
|
+
* Get a specific rotation policy by ID
|
|
1192
|
+
* @param id
|
|
1193
|
+
* @returns RotationPolicyResponse Rotation policy retrieved successfully
|
|
1194
|
+
* @throws ApiError
|
|
1195
|
+
*/
|
|
1196
|
+
getRotationPolicy(id: string): CancelablePromise<RotationPolicyResponse>;
|
|
1197
|
+
/**
|
|
1198
|
+
* Update Rotation Policy
|
|
1199
|
+
* Update an existing rotation policy
|
|
1200
|
+
* @param id
|
|
1201
|
+
* @param requestBody
|
|
1202
|
+
* @returns RotationPolicyResponse Rotation policy updated successfully
|
|
1203
|
+
* @throws ApiError
|
|
1204
|
+
*/
|
|
1205
|
+
updateRotationPolicy(id: string, requestBody?: UpdateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
1206
|
+
/**
|
|
1207
|
+
* Delete Rotation Policy
|
|
1208
|
+
* Delete a rotation policy
|
|
1209
|
+
* @param id
|
|
1210
|
+
* @returns ErrorResponse Rotation policy deleted successfully
|
|
1211
|
+
* @throws ApiError
|
|
1212
|
+
*/
|
|
1213
|
+
deleteRotationPolicy(id: string): CancelablePromise<ErrorResponse>;
|
|
1214
|
+
/**
|
|
1215
|
+
* Trigger Rotation
|
|
1216
|
+
* Manually trigger a secret rotation for a policy
|
|
1217
|
+
* @param id
|
|
1218
|
+
* @returns TriggerRotationResponse Rotation executed successfully
|
|
1219
|
+
* @throws ApiError
|
|
1220
|
+
*/
|
|
1221
|
+
triggerRotation(id: string): CancelablePromise<TriggerRotationResponse>;
|
|
1222
|
+
/**
|
|
1223
|
+
* Get Rotation States
|
|
1224
|
+
* Get the rotation state history for a policy
|
|
1225
|
+
* @param id
|
|
1226
|
+
* @returns RotationStatesResponse Rotation states retrieved successfully
|
|
1227
|
+
* @throws ApiError
|
|
1228
|
+
*/
|
|
1229
|
+
getRotationStates(id: string): CancelablePromise<RotationStatesResponse>;
|
|
1230
|
+
/**
|
|
1231
|
+
* Revoke Expired Credentials
|
|
1232
|
+
* Revoke old credentials that have passed their dual-credential window
|
|
1233
|
+
* @returns RevokeOldCredentialResponse Expired credentials revoked successfully
|
|
1234
|
+
* @throws ApiError
|
|
1235
|
+
*/
|
|
1236
|
+
revokeExpiredCredentials(): CancelablePromise<RevokeOldCredentialResponse>;
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
type CreateSamlProviderRequest = {
|
|
1240
|
+
/**
|
|
1241
|
+
* SAML identity provider type
|
|
1242
|
+
*/
|
|
1243
|
+
provider_type: CreateSamlProviderRequest.provider_type;
|
|
1244
|
+
/**
|
|
1245
|
+
* Human-readable name for this provider
|
|
1246
|
+
*/
|
|
1247
|
+
name: string;
|
|
1248
|
+
/**
|
|
1249
|
+
* SAML entity ID (issuer) from the IdP metadata
|
|
1250
|
+
*/
|
|
1251
|
+
entity_id: string;
|
|
1252
|
+
/**
|
|
1253
|
+
* IdP SSO login URL
|
|
1254
|
+
*/
|
|
1255
|
+
sso_url: string;
|
|
1256
|
+
/**
|
|
1257
|
+
* IdP X.509 certificate (PEM format) for signature validation
|
|
1258
|
+
*/
|
|
1259
|
+
certificate: string;
|
|
1260
|
+
};
|
|
1261
|
+
declare namespace CreateSamlProviderRequest {
|
|
1262
|
+
/**
|
|
1263
|
+
* SAML identity provider type
|
|
1264
|
+
*/
|
|
1265
|
+
enum provider_type {
|
|
1266
|
+
OKTA = "okta",
|
|
1267
|
+
ONELOGIN = "onelogin",
|
|
1268
|
+
AZURE_AD = "azure-ad",
|
|
1269
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
1270
|
+
DUO = "duo",
|
|
1271
|
+
RIPPLING = "rippling",
|
|
1272
|
+
ORACLE = "oracle",
|
|
1273
|
+
PING_IDENTITY = "ping-identity"
|
|
1274
|
+
}
|
|
1275
|
+
}
|
|
1276
|
+
|
|
1277
|
+
type SamlProviderResponse = {
|
|
1278
|
+
id: string;
|
|
1279
|
+
org_id: string;
|
|
1280
|
+
provider_type: SamlProviderResponse.provider_type;
|
|
1281
|
+
name: string;
|
|
1282
|
+
entity_id: string;
|
|
1283
|
+
sso_url: string;
|
|
1284
|
+
certificate: string;
|
|
1285
|
+
enabled: boolean;
|
|
1286
|
+
created_at: string;
|
|
1287
|
+
updated_at: string;
|
|
1288
|
+
};
|
|
1289
|
+
declare namespace SamlProviderResponse {
|
|
1290
|
+
enum provider_type {
|
|
1291
|
+
OKTA = "okta",
|
|
1292
|
+
ONELOGIN = "onelogin",
|
|
1293
|
+
AZURE_AD = "azure-ad",
|
|
1294
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
1295
|
+
DUO = "duo",
|
|
1296
|
+
RIPPLING = "rippling",
|
|
1297
|
+
ORACLE = "oracle",
|
|
1298
|
+
PING_IDENTITY = "ping-identity"
|
|
1299
|
+
}
|
|
1300
|
+
}
|
|
1301
|
+
|
|
1302
|
+
type SamlProvidersResponse = Array<SamlProviderResponse>;
|
|
1303
|
+
|
|
1304
|
+
type UpdateSamlProviderRequest = {
|
|
1305
|
+
name?: string;
|
|
1306
|
+
entity_id?: string;
|
|
1307
|
+
sso_url?: string;
|
|
1308
|
+
certificate?: string;
|
|
1309
|
+
enabled?: boolean;
|
|
1310
|
+
};
|
|
1311
|
+
|
|
1312
|
+
declare class SamlProvidersService {
|
|
1313
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1314
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1315
|
+
/**
|
|
1316
|
+
* Register SAML Provider
|
|
1317
|
+
* Register a new SAML identity provider for SSO authentication
|
|
1318
|
+
* @param requestBody
|
|
1319
|
+
* @returns SamlProviderResponse SAML provider created successfully
|
|
1320
|
+
* @throws ApiError
|
|
1321
|
+
*/
|
|
1322
|
+
createSamlProvider(requestBody?: CreateSamlProviderRequest): CancelablePromise<SamlProviderResponse>;
|
|
1323
|
+
/**
|
|
1324
|
+
* Get All SAML Providers
|
|
1325
|
+
* Retrieve all SAML providers for the organization
|
|
1326
|
+
* @returns SamlProvidersResponse SAML providers retrieved successfully
|
|
1327
|
+
* @throws ApiError
|
|
1328
|
+
*/
|
|
1329
|
+
getAllSamlProviders(): CancelablePromise<SamlProvidersResponse>;
|
|
1330
|
+
/**
|
|
1331
|
+
* Get SAML Provider
|
|
1332
|
+
* Retrieve a specific SAML provider
|
|
1333
|
+
* @param id
|
|
1334
|
+
* @returns SamlProviderResponse SAML provider retrieved successfully
|
|
1335
|
+
* @throws ApiError
|
|
1336
|
+
*/
|
|
1337
|
+
getSamlProvider(id: string): CancelablePromise<SamlProviderResponse>;
|
|
1338
|
+
/**
|
|
1339
|
+
* Update SAML Provider
|
|
1340
|
+
* Update an existing SAML provider
|
|
1341
|
+
* @param id
|
|
1342
|
+
* @param requestBody
|
|
1343
|
+
* @returns ErrorResponse SAML provider updated successfully
|
|
1344
|
+
* @throws ApiError
|
|
1345
|
+
*/
|
|
1346
|
+
updateSamlProvider(id: string, requestBody?: UpdateSamlProviderRequest): CancelablePromise<ErrorResponse>;
|
|
1347
|
+
/**
|
|
1348
|
+
* Delete SAML Provider
|
|
1349
|
+
* Delete an existing SAML provider
|
|
1350
|
+
* @param id
|
|
1351
|
+
* @returns ErrorResponse SAML provider deleted successfully
|
|
1352
|
+
* @throws ApiError
|
|
1353
|
+
*/
|
|
1354
|
+
deleteSamlProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
1355
|
+
/**
|
|
1356
|
+
* Get SAML SP Metadata
|
|
1357
|
+
* Retrieve SAML Service Provider metadata XML for the organization
|
|
1358
|
+
* @param id
|
|
1359
|
+
* @returns string SP metadata XML
|
|
1360
|
+
* @throws ApiError
|
|
1361
|
+
*/
|
|
1362
|
+
getSamlMetadata(id: string): CancelablePromise<string>;
|
|
1363
|
+
}
|
|
1364
|
+
|
|
1365
|
+
type SamlSsoRequest = {
|
|
1366
|
+
/**
|
|
1367
|
+
* SAML provider ID to initiate SSO with
|
|
1368
|
+
*/
|
|
1369
|
+
provider_id: string;
|
|
1370
|
+
};
|
|
1371
|
+
|
|
1372
|
+
type SamlSsoResponse = {
|
|
1373
|
+
/**
|
|
1374
|
+
* URL to redirect the user to for IdP authentication
|
|
1375
|
+
*/
|
|
1376
|
+
redirect_url: string;
|
|
1377
|
+
/**
|
|
1378
|
+
* AuthnRequest ID for tracking
|
|
1379
|
+
*/
|
|
1380
|
+
request_id: string;
|
|
1381
|
+
};
|
|
1382
|
+
|
|
1383
|
+
declare class SamlSsoService {
|
|
1384
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1385
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1386
|
+
/**
|
|
1387
|
+
* Initiate SAML SSO
|
|
1388
|
+
* Start SP-initiated SAML SSO flow by generating an AuthnRequest redirect URL
|
|
1389
|
+
* @param requestBody
|
|
1390
|
+
* @returns SamlSsoResponse Redirect URL generated
|
|
1391
|
+
* @throws ApiError
|
|
1392
|
+
*/
|
|
1393
|
+
initiateSamlSso(requestBody?: SamlSsoRequest): CancelablePromise<SamlSsoResponse>;
|
|
1394
|
+
/**
|
|
1395
|
+
* SAML Assertion Consumer Service
|
|
1396
|
+
* Receive and validate SAML Response from the identity provider (ACS endpoint)
|
|
1397
|
+
* @param orgId
|
|
1398
|
+
* @returns any Authentication successful
|
|
1399
|
+
* @throws ApiError
|
|
1400
|
+
*/
|
|
1401
|
+
handleSamlAcs(orgId: string): CancelablePromise<any>;
|
|
1402
|
+
}
|
|
1403
|
+
|
|
683
1404
|
type SystemStatusState = {
|
|
684
1405
|
edition: SystemStatusState.edition;
|
|
685
1406
|
single_org_mode: boolean;
|
|
@@ -715,9 +1436,15 @@ declare class SystemService {
|
|
|
715
1436
|
|
|
716
1437
|
type HttpRequestConstructor = new (config: OpenAPIConfig) => BaseHttpRequest;
|
|
717
1438
|
declare class EnvSyncManagementAPISDK {
|
|
1439
|
+
readonly dynamicSecrets: DynamicSecretsService;
|
|
718
1440
|
readonly enterprise: EnterpriseService;
|
|
719
1441
|
readonly license: LicenseService;
|
|
1442
|
+
readonly logForwarding: LogForwardingService;
|
|
1443
|
+
readonly oidcProviders: OidcProvidersService;
|
|
720
1444
|
readonly onboarding: OnboardingService;
|
|
1445
|
+
readonly rotation: RotationService;
|
|
1446
|
+
readonly samlProviders: SamlProvidersService;
|
|
1447
|
+
readonly samlSso: SamlSsoService;
|
|
721
1448
|
readonly system: SystemService;
|
|
722
1449
|
readonly request: BaseHttpRequest;
|
|
723
1450
|
constructor(config?: Partial<OpenAPIConfig>, HttpRequest?: HttpRequestConstructor);
|
|
@@ -740,8 +1467,9 @@ declare class ApiError extends Error {
|
|
|
740
1467
|
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
741
1468
|
}
|
|
742
1469
|
|
|
743
|
-
|
|
744
|
-
|
|
745
|
-
|
|
1470
|
+
/**
|
|
1471
|
+
* Optional. Bearer-token clients can use this to select the active organization for the request. Ignored for cookie sessions and API keys.
|
|
1472
|
+
*/
|
|
1473
|
+
type XEnvSyncOrgIdHeader = string;
|
|
746
1474
|
|
|
747
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, ApiError, BaseHttpRequest, CancelError, CancelablePromise, type CreateEnvTypeMappingRequest, CreateIntegrationBindingRequest, CreateManualSyncRunRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateOrgSecretRequest, CreateProviderConnectionRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteUserInviteResponse, EnterpriseProviderProfile, type EnterpriseProvidersResponse, EnterpriseService, EnvSyncManagementAPISDK, type EnvTypeMapping, type EnvTypeMappingsResponse, type ErrorResponse, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, IntegrationBinding, type IntegrationBindingsResponse, type LicenseActionResponse, LicenseService, LicenseState, type LicenseStatusResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgSecret, type OrgSecretModelResponse, type OrgSecretsResponse, ProviderConnection, type ProviderConnectionsResponse, SyncAuditEvent, type SyncAuditEventsResponse, SyncRun, type SyncRunsResponse, SystemService, type SystemStatusResponse, SystemStatusState, type UpdateEnvTypeMappingRequest, type UpdateIntegrationBindingRequest, type UpdateOrgSecretRequest, UpdateProviderConnectionRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse };
|
|
1475
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, ApiError, BaseHttpRequest, CancelError, CancelablePromise, type CleanupResponse, CreateDynamicSecretEngineRequest, type CreateDynamicSecretLeaseRequest, type CreateEnvTypeMappingRequest, CreateIntegrationBindingRequest, CreateLogForwardingRequest, CreateManualSyncRunRequest, CreateOidcProviderRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateOrgSecretRequest, CreateProviderConnectionRequest, CreateRotationPolicyRequest, CreateSamlProviderRequest, type CreateUserInviteRequest, type CreateUserInviteResponse, type DeleteUserInviteResponse, DynamicSecretEngineResponse, type DynamicSecretEnginesResponse, type DynamicSecretLeaseResponse, type DynamicSecretLeasesResponse, DynamicSecretsService, EnterpriseProviderProfile, type EnterpriseProvidersResponse, EnterpriseService, EnvSyncManagementAPISDK, type EnvTypeMapping, type EnvTypeMappingsResponse, type ErrorResponse, type GetOrgInviteByCodeResponse, type GetUserInviteByTokenResponse, IntegrationBinding, type IntegrationBindingsResponse, type LicenseActionResponse, LicenseService, LicenseState, type LicenseStatusResponse, LogForwardingResponse, LogForwardingService, type LogForwardingsResponse, OidcProviderResponse, type OidcProvidersResponse, OidcProvidersService, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgSecret, type OrgSecretModelResponse, type OrgSecretsResponse, ProviderConnection, type ProviderConnectionsResponse, type RevokeLeaseResponse, type RevokeOldCredentialResponse, type RotationPoliciesResponse, RotationPolicyResponse, RotationService, type RotationStateResponse, type RotationStatesResponse, SamlProviderResponse, type SamlProvidersResponse, SamlProvidersService, type SamlSsoRequest, type SamlSsoResponse, SamlSsoService, SyncAuditEvent, type SyncAuditEventsResponse, SyncRun, type SyncRunsResponse, SystemService, type SystemStatusResponse, SystemStatusState, type TriggerRotationResponse, type UpdateDynamicSecretEngineRequest, type UpdateEnvTypeMappingRequest, type UpdateIntegrationBindingRequest, type UpdateOidcProviderRequest, type UpdateOrgSecretRequest, UpdateProviderConnectionRequest, type UpdateRotationPolicyRequest, type UpdateSamlProviderRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type XEnvSyncOrgIdHeader };
|