@envsync-cloud/envsync-ts-sdk 0.10.4 → 0.20.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/README.md +16 -5
- package/dist/index.d.mts +1332 -51
- package/dist/index.d.ts +1332 -51
- package/dist/index.js +2126 -449
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2097 -449
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -427,13 +427,13 @@ declare class AuthenticationService {
|
|
|
427
427
|
*/
|
|
428
428
|
whoami(): CancelablePromise<WhoAmIResponse>;
|
|
429
429
|
/**
|
|
430
|
-
* Create
|
|
431
|
-
* Create a new
|
|
430
|
+
* Create Organization
|
|
431
|
+
* Create a new organization for the current hosted web session and switch into it. Hosted only; self-host always 403.
|
|
432
432
|
* @param requestBody
|
|
433
|
-
* @returns WhoAmIResponse
|
|
433
|
+
* @returns WhoAmIResponse Organization created successfully
|
|
434
434
|
* @throws ApiError
|
|
435
435
|
*/
|
|
436
|
-
|
|
436
|
+
createOrganization(requestBody?: {
|
|
437
437
|
name: string;
|
|
438
438
|
}): CancelablePromise<WhoAmIResponse>;
|
|
439
439
|
/**
|
|
@@ -827,6 +827,620 @@ declare class ChangeRequestsService {
|
|
|
827
827
|
cancelChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
828
828
|
}
|
|
829
829
|
|
|
830
|
+
type CleanupResponse = {
|
|
831
|
+
cleaned: number;
|
|
832
|
+
};
|
|
833
|
+
|
|
834
|
+
type CreateDynamicSecretEngineRequest = {
|
|
835
|
+
engine_type: CreateDynamicSecretEngineRequest.engine_type;
|
|
836
|
+
name: string;
|
|
837
|
+
config: ({
|
|
838
|
+
host: string;
|
|
839
|
+
port?: number;
|
|
840
|
+
database: string;
|
|
841
|
+
superuser: {
|
|
842
|
+
username: string;
|
|
843
|
+
password: string;
|
|
844
|
+
};
|
|
845
|
+
creation_statements?: Array<string>;
|
|
846
|
+
default_ttl_seconds?: number;
|
|
847
|
+
max_ttl_seconds?: number;
|
|
848
|
+
} | {
|
|
849
|
+
access_key_id: string;
|
|
850
|
+
secret_access_key: string;
|
|
851
|
+
region?: string;
|
|
852
|
+
iam_policy: string;
|
|
853
|
+
default_ttl_seconds?: number;
|
|
854
|
+
max_ttl_seconds?: number;
|
|
855
|
+
} | {
|
|
856
|
+
tenant_id: string;
|
|
857
|
+
client_id: string;
|
|
858
|
+
client_secret: string;
|
|
859
|
+
subscription_id: string;
|
|
860
|
+
roles?: Array<string>;
|
|
861
|
+
default_ttl_seconds?: number;
|
|
862
|
+
max_ttl_seconds?: number;
|
|
863
|
+
});
|
|
864
|
+
enabled?: boolean;
|
|
865
|
+
};
|
|
866
|
+
declare namespace CreateDynamicSecretEngineRequest {
|
|
867
|
+
enum engine_type {
|
|
868
|
+
POSTGRES = "postgres",
|
|
869
|
+
MYSQL = "mysql",
|
|
870
|
+
AWS_IAM = "aws-iam",
|
|
871
|
+
AZURE_SP = "azure-sp"
|
|
872
|
+
}
|
|
873
|
+
}
|
|
874
|
+
|
|
875
|
+
type CreateDynamicSecretLeaseRequest = {
|
|
876
|
+
app_id: string;
|
|
877
|
+
env_type_id: string;
|
|
878
|
+
variable_key: string;
|
|
879
|
+
ttl_seconds?: number;
|
|
880
|
+
};
|
|
881
|
+
|
|
882
|
+
type DynamicSecretEngineResponse = {
|
|
883
|
+
id: string;
|
|
884
|
+
org_id: string;
|
|
885
|
+
engine_type: DynamicSecretEngineResponse.engine_type;
|
|
886
|
+
name: string;
|
|
887
|
+
config: Record<string, any>;
|
|
888
|
+
enabled: boolean;
|
|
889
|
+
created_at: string;
|
|
890
|
+
updated_at: string;
|
|
891
|
+
};
|
|
892
|
+
declare namespace DynamicSecretEngineResponse {
|
|
893
|
+
enum engine_type {
|
|
894
|
+
POSTGRES = "postgres",
|
|
895
|
+
MYSQL = "mysql",
|
|
896
|
+
AWS_IAM = "aws-iam",
|
|
897
|
+
AZURE_SP = "azure-sp"
|
|
898
|
+
}
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
type DynamicSecretEnginesResponse = Array<DynamicSecretEngineResponse>;
|
|
902
|
+
|
|
903
|
+
type DynamicSecretLeaseResponse = {
|
|
904
|
+
id: string;
|
|
905
|
+
engine_id: string;
|
|
906
|
+
app_id: string;
|
|
907
|
+
env_type_id: string;
|
|
908
|
+
variable_key: string;
|
|
909
|
+
credential_data: Record<string, any>;
|
|
910
|
+
expires_at: string;
|
|
911
|
+
revoked_at: string | null;
|
|
912
|
+
created_at: string;
|
|
913
|
+
updated_at: string;
|
|
914
|
+
};
|
|
915
|
+
|
|
916
|
+
type DynamicSecretLeasesResponse = Array<DynamicSecretLeaseResponse>;
|
|
917
|
+
|
|
918
|
+
type ErrorResponse = {
|
|
919
|
+
error: string;
|
|
920
|
+
};
|
|
921
|
+
|
|
922
|
+
type RevokeLeaseResponse = {
|
|
923
|
+
message: string;
|
|
924
|
+
id: string;
|
|
925
|
+
};
|
|
926
|
+
|
|
927
|
+
type UpdateDynamicSecretEngineRequest = {
|
|
928
|
+
name?: string;
|
|
929
|
+
config?: ({
|
|
930
|
+
host: string;
|
|
931
|
+
port?: number;
|
|
932
|
+
database: string;
|
|
933
|
+
superuser: {
|
|
934
|
+
username: string;
|
|
935
|
+
password: string;
|
|
936
|
+
};
|
|
937
|
+
creation_statements?: Array<string>;
|
|
938
|
+
default_ttl_seconds?: number;
|
|
939
|
+
max_ttl_seconds?: number;
|
|
940
|
+
} | {
|
|
941
|
+
access_key_id: string;
|
|
942
|
+
secret_access_key: string;
|
|
943
|
+
region?: string;
|
|
944
|
+
iam_policy: string;
|
|
945
|
+
default_ttl_seconds?: number;
|
|
946
|
+
max_ttl_seconds?: number;
|
|
947
|
+
} | {
|
|
948
|
+
tenant_id: string;
|
|
949
|
+
client_id: string;
|
|
950
|
+
client_secret: string;
|
|
951
|
+
subscription_id: string;
|
|
952
|
+
roles?: Array<string>;
|
|
953
|
+
default_ttl_seconds?: number;
|
|
954
|
+
max_ttl_seconds?: number;
|
|
955
|
+
});
|
|
956
|
+
enabled?: boolean;
|
|
957
|
+
};
|
|
958
|
+
|
|
959
|
+
declare class DynamicSecretsService {
|
|
960
|
+
readonly httpRequest: BaseHttpRequest;
|
|
961
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
962
|
+
/**
|
|
963
|
+
* Create Dynamic Secret Engine
|
|
964
|
+
* Create a new dynamic secret engine for short-lived credential generation
|
|
965
|
+
* @param requestBody
|
|
966
|
+
* @returns DynamicSecretEngineResponse Engine created successfully
|
|
967
|
+
* @throws ApiError
|
|
968
|
+
*/
|
|
969
|
+
createDynamicSecretEngine(requestBody?: CreateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
970
|
+
/**
|
|
971
|
+
* Get All Dynamic Secret Engines
|
|
972
|
+
* Retrieve all dynamic secret engines for the organization
|
|
973
|
+
* @returns DynamicSecretEnginesResponse Engines retrieved successfully
|
|
974
|
+
* @throws ApiError
|
|
975
|
+
*/
|
|
976
|
+
getAllDynamicSecretEngines(): CancelablePromise<DynamicSecretEnginesResponse>;
|
|
977
|
+
/**
|
|
978
|
+
* Get Dynamic Secret Engine
|
|
979
|
+
* Retrieve a specific dynamic secret engine by ID
|
|
980
|
+
* @param id
|
|
981
|
+
* @returns DynamicSecretEngineResponse Engine retrieved successfully
|
|
982
|
+
* @throws ApiError
|
|
983
|
+
*/
|
|
984
|
+
getDynamicSecretEngine(id: string): CancelablePromise<DynamicSecretEngineResponse>;
|
|
985
|
+
/**
|
|
986
|
+
* Update Dynamic Secret Engine
|
|
987
|
+
* Update an existing dynamic secret engine
|
|
988
|
+
* @param id
|
|
989
|
+
* @param requestBody
|
|
990
|
+
* @returns DynamicSecretEngineResponse Engine updated successfully
|
|
991
|
+
* @throws ApiError
|
|
992
|
+
*/
|
|
993
|
+
updateDynamicSecretEngine(id: string, requestBody?: UpdateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
994
|
+
/**
|
|
995
|
+
* Delete Dynamic Secret Engine
|
|
996
|
+
* Delete a dynamic secret engine (must have no active leases)
|
|
997
|
+
* @param id
|
|
998
|
+
* @returns ErrorResponse Engine deleted successfully
|
|
999
|
+
* @throws ApiError
|
|
1000
|
+
*/
|
|
1001
|
+
deleteDynamicSecretEngine(id: string): CancelablePromise<ErrorResponse>;
|
|
1002
|
+
/**
|
|
1003
|
+
* Create Dynamic Secret Lease
|
|
1004
|
+
* Generate short-lived credentials by creating a lease on an engine
|
|
1005
|
+
* @param id
|
|
1006
|
+
* @param requestBody
|
|
1007
|
+
* @returns DynamicSecretLeaseResponse Lease created successfully
|
|
1008
|
+
* @throws ApiError
|
|
1009
|
+
*/
|
|
1010
|
+
createDynamicSecretLease(id: string, requestBody?: CreateDynamicSecretLeaseRequest): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
1011
|
+
/**
|
|
1012
|
+
* Get Leases for Engine
|
|
1013
|
+
* Retrieve all leases for a specific dynamic secret engine
|
|
1014
|
+
* @param id
|
|
1015
|
+
* @returns DynamicSecretLeasesResponse Leases retrieved successfully
|
|
1016
|
+
* @throws ApiError
|
|
1017
|
+
*/
|
|
1018
|
+
getDynamicSecretLeases(id: string): CancelablePromise<DynamicSecretLeasesResponse>;
|
|
1019
|
+
/**
|
|
1020
|
+
* Get Dynamic Secret Lease
|
|
1021
|
+
* Retrieve a specific lease by ID
|
|
1022
|
+
* @param leaseId
|
|
1023
|
+
* @returns DynamicSecretLeaseResponse Lease retrieved successfully
|
|
1024
|
+
* @throws ApiError
|
|
1025
|
+
*/
|
|
1026
|
+
getDynamicSecretLease(leaseId: string): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
1027
|
+
/**
|
|
1028
|
+
* Revoke Dynamic Secret Lease
|
|
1029
|
+
* Revoke a lease and its associated credentials
|
|
1030
|
+
* @param leaseId
|
|
1031
|
+
* @returns RevokeLeaseResponse Lease revoked successfully
|
|
1032
|
+
* @throws ApiError
|
|
1033
|
+
*/
|
|
1034
|
+
revokeDynamicSecretLease(leaseId: string): CancelablePromise<RevokeLeaseResponse>;
|
|
1035
|
+
/**
|
|
1036
|
+
* Cleanup Expired Leases
|
|
1037
|
+
* Mark all expired leases as revoked (admin operation)
|
|
1038
|
+
* @returns CleanupResponse Cleanup completed
|
|
1039
|
+
* @throws ApiError
|
|
1040
|
+
*/
|
|
1041
|
+
cleanupExpiredLeases(): CancelablePromise<CleanupResponse>;
|
|
1042
|
+
}
|
|
1043
|
+
|
|
1044
|
+
type CreateEnvTypeMappingRequest = {
|
|
1045
|
+
env_type_id: string;
|
|
1046
|
+
integration_binding_id: string;
|
|
1047
|
+
target_identifier: string;
|
|
1048
|
+
branch_ref?: string | null;
|
|
1049
|
+
path_prefix?: string | null;
|
|
1050
|
+
metadata?: Record<string, any>;
|
|
1051
|
+
};
|
|
1052
|
+
|
|
1053
|
+
type CreateIntegrationBindingRequest = {
|
|
1054
|
+
provider_connection_id: string;
|
|
1055
|
+
provider_type: CreateIntegrationBindingRequest.provider_type;
|
|
1056
|
+
is_enabled?: boolean;
|
|
1057
|
+
metadata?: Record<string, any>;
|
|
1058
|
+
};
|
|
1059
|
+
declare namespace CreateIntegrationBindingRequest {
|
|
1060
|
+
enum provider_type {
|
|
1061
|
+
GITHUB = "github",
|
|
1062
|
+
GITLAB = "gitlab",
|
|
1063
|
+
AWS_SSM = "aws-ssm",
|
|
1064
|
+
VERCEL = "vercel",
|
|
1065
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1066
|
+
}
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1069
|
+
type CreateManualSyncRunRequest = {
|
|
1070
|
+
app_id?: string | null;
|
|
1071
|
+
provider_type: CreateManualSyncRunRequest.provider_type;
|
|
1072
|
+
metadata?: Record<string, any>;
|
|
1073
|
+
};
|
|
1074
|
+
declare namespace CreateManualSyncRunRequest {
|
|
1075
|
+
enum provider_type {
|
|
1076
|
+
GITHUB = "github",
|
|
1077
|
+
GITLAB = "gitlab",
|
|
1078
|
+
AWS_SSM = "aws-ssm",
|
|
1079
|
+
VERCEL = "vercel",
|
|
1080
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1081
|
+
}
|
|
1082
|
+
}
|
|
1083
|
+
|
|
1084
|
+
type CreateOrgSecretRequest = {
|
|
1085
|
+
key: string;
|
|
1086
|
+
value: string;
|
|
1087
|
+
description?: string | null;
|
|
1088
|
+
metadata?: Record<string, any>;
|
|
1089
|
+
};
|
|
1090
|
+
|
|
1091
|
+
type CreateProviderConnectionRequest = {
|
|
1092
|
+
provider_type: CreateProviderConnectionRequest.provider_type;
|
|
1093
|
+
name: string;
|
|
1094
|
+
status?: CreateProviderConnectionRequest.status;
|
|
1095
|
+
auth_config?: Record<string, any>;
|
|
1096
|
+
metadata?: Record<string, any>;
|
|
1097
|
+
};
|
|
1098
|
+
declare namespace CreateProviderConnectionRequest {
|
|
1099
|
+
enum provider_type {
|
|
1100
|
+
GITHUB = "github",
|
|
1101
|
+
GITLAB = "gitlab",
|
|
1102
|
+
AWS_SSM = "aws-ssm",
|
|
1103
|
+
VERCEL = "vercel",
|
|
1104
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1105
|
+
}
|
|
1106
|
+
enum status {
|
|
1107
|
+
ACTIVE = "active",
|
|
1108
|
+
INACTIVE = "inactive",
|
|
1109
|
+
ERROR = "error"
|
|
1110
|
+
}
|
|
1111
|
+
}
|
|
1112
|
+
|
|
1113
|
+
type EnterpriseProviderProfile = {
|
|
1114
|
+
id: EnterpriseProviderProfile.id;
|
|
1115
|
+
name: string;
|
|
1116
|
+
scope: string;
|
|
1117
|
+
description: string;
|
|
1118
|
+
connection_requirements: Array<string>;
|
|
1119
|
+
binding_metadata_fields: Array<string>;
|
|
1120
|
+
mapping_requirements: Array<string>;
|
|
1121
|
+
};
|
|
1122
|
+
declare namespace EnterpriseProviderProfile {
|
|
1123
|
+
enum id {
|
|
1124
|
+
GITHUB = "github",
|
|
1125
|
+
GITLAB = "gitlab",
|
|
1126
|
+
AWS_SSM = "aws-ssm",
|
|
1127
|
+
VERCEL = "vercel",
|
|
1128
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1129
|
+
}
|
|
1130
|
+
}
|
|
1131
|
+
|
|
1132
|
+
type EnterpriseProvidersResponse = {
|
|
1133
|
+
providers: Array<EnterpriseProviderProfile>;
|
|
1134
|
+
};
|
|
1135
|
+
|
|
1136
|
+
type EnvTypeMapping = {
|
|
1137
|
+
id: string;
|
|
1138
|
+
org_id: string;
|
|
1139
|
+
app_id: string;
|
|
1140
|
+
env_type_id: string;
|
|
1141
|
+
integration_binding_id: string;
|
|
1142
|
+
target_identifier: string;
|
|
1143
|
+
branch_ref?: string | null;
|
|
1144
|
+
path_prefix?: string | null;
|
|
1145
|
+
metadata: Record<string, any>;
|
|
1146
|
+
created_at: string;
|
|
1147
|
+
updated_at: string;
|
|
1148
|
+
};
|
|
1149
|
+
|
|
1150
|
+
type EnvTypeMappingsResponse = Array<EnvTypeMapping>;
|
|
1151
|
+
|
|
1152
|
+
type IntegrationBinding = {
|
|
1153
|
+
id: string;
|
|
1154
|
+
org_id: string;
|
|
1155
|
+
app_id: string;
|
|
1156
|
+
provider_connection_id: string;
|
|
1157
|
+
provider_type: IntegrationBinding.provider_type;
|
|
1158
|
+
is_enabled: boolean;
|
|
1159
|
+
metadata: Record<string, any>;
|
|
1160
|
+
created_at: string;
|
|
1161
|
+
updated_at: string;
|
|
1162
|
+
};
|
|
1163
|
+
declare namespace IntegrationBinding {
|
|
1164
|
+
enum provider_type {
|
|
1165
|
+
GITHUB = "github",
|
|
1166
|
+
GITLAB = "gitlab",
|
|
1167
|
+
AWS_SSM = "aws-ssm",
|
|
1168
|
+
VERCEL = "vercel",
|
|
1169
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1170
|
+
}
|
|
1171
|
+
}
|
|
1172
|
+
|
|
1173
|
+
type IntegrationBindingsResponse = Array<IntegrationBinding>;
|
|
1174
|
+
|
|
1175
|
+
type OrgSecret = {
|
|
1176
|
+
id: string;
|
|
1177
|
+
org_id: string;
|
|
1178
|
+
key: string;
|
|
1179
|
+
value: string;
|
|
1180
|
+
description?: string | null;
|
|
1181
|
+
metadata: Record<string, any>;
|
|
1182
|
+
created_at: string;
|
|
1183
|
+
updated_at: string;
|
|
1184
|
+
};
|
|
1185
|
+
|
|
1186
|
+
type OrgSecretModelResponse = {
|
|
1187
|
+
resource: string;
|
|
1188
|
+
description: string;
|
|
1189
|
+
fields: Array<string>;
|
|
1190
|
+
};
|
|
1191
|
+
|
|
1192
|
+
type OrgSecretsResponse = Array<OrgSecret>;
|
|
1193
|
+
|
|
1194
|
+
type ProviderConnection = {
|
|
1195
|
+
id: string;
|
|
1196
|
+
org_id: string;
|
|
1197
|
+
provider_type: ProviderConnection.provider_type;
|
|
1198
|
+
name: string;
|
|
1199
|
+
status: ProviderConnection.status;
|
|
1200
|
+
auth_config: Record<string, any>;
|
|
1201
|
+
metadata: Record<string, any>;
|
|
1202
|
+
created_at: string;
|
|
1203
|
+
updated_at: string;
|
|
1204
|
+
};
|
|
1205
|
+
declare namespace ProviderConnection {
|
|
1206
|
+
enum provider_type {
|
|
1207
|
+
GITHUB = "github",
|
|
1208
|
+
GITLAB = "gitlab",
|
|
1209
|
+
AWS_SSM = "aws-ssm",
|
|
1210
|
+
VERCEL = "vercel",
|
|
1211
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1212
|
+
}
|
|
1213
|
+
enum status {
|
|
1214
|
+
ACTIVE = "active",
|
|
1215
|
+
INACTIVE = "inactive",
|
|
1216
|
+
ERROR = "error"
|
|
1217
|
+
}
|
|
1218
|
+
}
|
|
1219
|
+
|
|
1220
|
+
type ProviderConnectionsResponse = Array<ProviderConnection>;
|
|
1221
|
+
|
|
1222
|
+
type SyncAuditEvent = {
|
|
1223
|
+
id: string;
|
|
1224
|
+
org_id: string;
|
|
1225
|
+
sync_run_id?: string | null;
|
|
1226
|
+
app_id?: string | null;
|
|
1227
|
+
env_type_id?: string | null;
|
|
1228
|
+
provider_type: SyncAuditEvent.provider_type;
|
|
1229
|
+
action: string;
|
|
1230
|
+
result: SyncAuditEvent.result;
|
|
1231
|
+
actor_user_id?: string | null;
|
|
1232
|
+
details: Record<string, any>;
|
|
1233
|
+
created_at: string;
|
|
1234
|
+
updated_at: string;
|
|
1235
|
+
};
|
|
1236
|
+
declare namespace SyncAuditEvent {
|
|
1237
|
+
enum provider_type {
|
|
1238
|
+
GITHUB = "github",
|
|
1239
|
+
GITLAB = "gitlab",
|
|
1240
|
+
AWS_SSM = "aws-ssm",
|
|
1241
|
+
VERCEL = "vercel",
|
|
1242
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1243
|
+
}
|
|
1244
|
+
enum result {
|
|
1245
|
+
INFO = "info",
|
|
1246
|
+
SUCCESS = "success",
|
|
1247
|
+
ERROR = "error"
|
|
1248
|
+
}
|
|
1249
|
+
}
|
|
1250
|
+
|
|
1251
|
+
type SyncAuditEventsResponse = Array<SyncAuditEvent>;
|
|
1252
|
+
|
|
1253
|
+
type SyncRun = {
|
|
1254
|
+
id: string;
|
|
1255
|
+
org_id: string;
|
|
1256
|
+
app_id?: string | null;
|
|
1257
|
+
provider_type: SyncRun.provider_type;
|
|
1258
|
+
status: SyncRun.status;
|
|
1259
|
+
actor_user_id?: string | null;
|
|
1260
|
+
started_at: string;
|
|
1261
|
+
completed_at?: string | null;
|
|
1262
|
+
error_message?: string | null;
|
|
1263
|
+
metadata: Record<string, any>;
|
|
1264
|
+
created_at: string;
|
|
1265
|
+
updated_at: string;
|
|
1266
|
+
};
|
|
1267
|
+
declare namespace SyncRun {
|
|
1268
|
+
enum provider_type {
|
|
1269
|
+
GITHUB = "github",
|
|
1270
|
+
GITLAB = "gitlab",
|
|
1271
|
+
AWS_SSM = "aws-ssm",
|
|
1272
|
+
VERCEL = "vercel",
|
|
1273
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1274
|
+
}
|
|
1275
|
+
enum status {
|
|
1276
|
+
PENDING = "pending",
|
|
1277
|
+
RUNNING = "running",
|
|
1278
|
+
SUCCEEDED = "succeeded",
|
|
1279
|
+
FAILED = "failed"
|
|
1280
|
+
}
|
|
1281
|
+
}
|
|
1282
|
+
|
|
1283
|
+
type SyncRunsResponse = Array<SyncRun>;
|
|
1284
|
+
|
|
1285
|
+
type UpdateEnvTypeMappingRequest = {
|
|
1286
|
+
target_identifier?: string;
|
|
1287
|
+
branch_ref?: string | null;
|
|
1288
|
+
path_prefix?: string | null;
|
|
1289
|
+
metadata?: Record<string, any>;
|
|
1290
|
+
};
|
|
1291
|
+
|
|
1292
|
+
type UpdateIntegrationBindingRequest = {
|
|
1293
|
+
is_enabled?: boolean;
|
|
1294
|
+
metadata?: Record<string, any>;
|
|
1295
|
+
};
|
|
1296
|
+
|
|
1297
|
+
type UpdateOrgSecretRequest = {
|
|
1298
|
+
value?: string;
|
|
1299
|
+
description?: string | null;
|
|
1300
|
+
metadata?: Record<string, any>;
|
|
1301
|
+
};
|
|
1302
|
+
|
|
1303
|
+
type UpdateProviderConnectionRequest = {
|
|
1304
|
+
name?: string;
|
|
1305
|
+
status?: UpdateProviderConnectionRequest.status;
|
|
1306
|
+
auth_config?: Record<string, any>;
|
|
1307
|
+
metadata?: Record<string, any>;
|
|
1308
|
+
};
|
|
1309
|
+
declare namespace UpdateProviderConnectionRequest {
|
|
1310
|
+
enum status {
|
|
1311
|
+
ACTIVE = "active",
|
|
1312
|
+
INACTIVE = "inactive",
|
|
1313
|
+
ERROR = "error"
|
|
1314
|
+
}
|
|
1315
|
+
}
|
|
1316
|
+
|
|
1317
|
+
declare class EnterpriseService {
|
|
1318
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1319
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1320
|
+
/**
|
|
1321
|
+
* List Enterprise Providers
|
|
1322
|
+
* @returns EnterpriseProvidersResponse Enterprise provider catalog
|
|
1323
|
+
* @throws ApiError
|
|
1324
|
+
*/
|
|
1325
|
+
listEnterpriseProviders(): CancelablePromise<EnterpriseProvidersResponse>;
|
|
1326
|
+
/**
|
|
1327
|
+
* Get Enterprise Org Secret Model
|
|
1328
|
+
* @returns OrgSecretModelResponse Org secret model
|
|
1329
|
+
* @throws ApiError
|
|
1330
|
+
*/
|
|
1331
|
+
getEnterpriseOrgSecretModel(): CancelablePromise<OrgSecretModelResponse>;
|
|
1332
|
+
/**
|
|
1333
|
+
* List Enterprise Provider Connections
|
|
1334
|
+
* @returns ProviderConnectionsResponse Provider connections
|
|
1335
|
+
* @throws ApiError
|
|
1336
|
+
*/
|
|
1337
|
+
listEnterpriseProviderConnections(): CancelablePromise<ProviderConnectionsResponse>;
|
|
1338
|
+
/**
|
|
1339
|
+
* Create Enterprise Provider Connection
|
|
1340
|
+
* @param requestBody
|
|
1341
|
+
* @returns ProviderConnection Provider connection created
|
|
1342
|
+
* @throws ApiError
|
|
1343
|
+
*/
|
|
1344
|
+
createEnterpriseProviderConnection(requestBody?: CreateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
1345
|
+
/**
|
|
1346
|
+
* Update Enterprise Provider Connection
|
|
1347
|
+
* @param id
|
|
1348
|
+
* @param requestBody
|
|
1349
|
+
* @returns ProviderConnection Provider connection updated
|
|
1350
|
+
* @throws ApiError
|
|
1351
|
+
*/
|
|
1352
|
+
updateEnterpriseProviderConnection(id: string, requestBody?: UpdateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
1353
|
+
/**
|
|
1354
|
+
* List Enterprise Org Secrets
|
|
1355
|
+
* @returns OrgSecretsResponse Org secrets
|
|
1356
|
+
* @throws ApiError
|
|
1357
|
+
*/
|
|
1358
|
+
listEnterpriseOrgSecrets(): CancelablePromise<OrgSecretsResponse>;
|
|
1359
|
+
/**
|
|
1360
|
+
* Create Enterprise Org Secret
|
|
1361
|
+
* @param requestBody
|
|
1362
|
+
* @returns OrgSecret Org secret created
|
|
1363
|
+
* @throws ApiError
|
|
1364
|
+
*/
|
|
1365
|
+
createEnterpriseOrgSecret(requestBody?: CreateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
1366
|
+
/**
|
|
1367
|
+
* Update Enterprise Org Secret
|
|
1368
|
+
* @param id
|
|
1369
|
+
* @param requestBody
|
|
1370
|
+
* @returns OrgSecret Org secret updated
|
|
1371
|
+
* @throws ApiError
|
|
1372
|
+
*/
|
|
1373
|
+
updateEnterpriseOrgSecret(id: string, requestBody?: UpdateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
1374
|
+
/**
|
|
1375
|
+
* List Enterprise Integration Bindings
|
|
1376
|
+
* @param appId
|
|
1377
|
+
* @returns IntegrationBindingsResponse Integration bindings
|
|
1378
|
+
* @throws ApiError
|
|
1379
|
+
*/
|
|
1380
|
+
listEnterpriseIntegrationBindings(appId: string): CancelablePromise<IntegrationBindingsResponse>;
|
|
1381
|
+
/**
|
|
1382
|
+
* Create Enterprise Integration Binding
|
|
1383
|
+
* @param appId
|
|
1384
|
+
* @param requestBody
|
|
1385
|
+
* @returns IntegrationBinding Integration binding created
|
|
1386
|
+
* @throws ApiError
|
|
1387
|
+
*/
|
|
1388
|
+
createEnterpriseIntegrationBinding(appId: string, requestBody?: CreateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
1389
|
+
/**
|
|
1390
|
+
* Update Enterprise Integration Binding
|
|
1391
|
+
* @param appId
|
|
1392
|
+
* @param id
|
|
1393
|
+
* @param requestBody
|
|
1394
|
+
* @returns IntegrationBinding Integration binding updated
|
|
1395
|
+
* @throws ApiError
|
|
1396
|
+
*/
|
|
1397
|
+
updateEnterpriseIntegrationBinding(appId: string, id: string, requestBody?: UpdateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
1398
|
+
/**
|
|
1399
|
+
* List Enterprise Env-Type Mappings
|
|
1400
|
+
* @param appId
|
|
1401
|
+
* @returns EnvTypeMappingsResponse Env-type mappings
|
|
1402
|
+
* @throws ApiError
|
|
1403
|
+
*/
|
|
1404
|
+
listEnterpriseEnvTypeMappings(appId: string): CancelablePromise<EnvTypeMappingsResponse>;
|
|
1405
|
+
/**
|
|
1406
|
+
* Create Enterprise Env-Type Mapping
|
|
1407
|
+
* @param appId
|
|
1408
|
+
* @param requestBody
|
|
1409
|
+
* @returns EnvTypeMapping Env-type mapping created
|
|
1410
|
+
* @throws ApiError
|
|
1411
|
+
*/
|
|
1412
|
+
createEnterpriseEnvTypeMapping(appId: string, requestBody?: CreateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
1413
|
+
/**
|
|
1414
|
+
* Update Enterprise Env-Type Mapping
|
|
1415
|
+
* @param appId
|
|
1416
|
+
* @param id
|
|
1417
|
+
* @param requestBody
|
|
1418
|
+
* @returns EnvTypeMapping Env-type mapping updated
|
|
1419
|
+
* @throws ApiError
|
|
1420
|
+
*/
|
|
1421
|
+
updateEnterpriseEnvTypeMapping(appId: string, id: string, requestBody?: UpdateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
1422
|
+
/**
|
|
1423
|
+
* List Enterprise Sync Runs
|
|
1424
|
+
* @returns SyncRunsResponse Sync runs
|
|
1425
|
+
* @throws ApiError
|
|
1426
|
+
*/
|
|
1427
|
+
listEnterpriseSyncRuns(): CancelablePromise<SyncRunsResponse>;
|
|
1428
|
+
/**
|
|
1429
|
+
* Create Enterprise Manual Sync Run
|
|
1430
|
+
* @param requestBody
|
|
1431
|
+
* @returns SyncRun Sync run created
|
|
1432
|
+
* @throws ApiError
|
|
1433
|
+
*/
|
|
1434
|
+
createEnterpriseManualSyncRun(requestBody?: CreateManualSyncRunRequest): CancelablePromise<SyncRun>;
|
|
1435
|
+
/**
|
|
1436
|
+
* List Enterprise Sync Audit Events
|
|
1437
|
+
* @param syncRunId
|
|
1438
|
+
* @returns SyncAuditEventsResponse Sync audit events
|
|
1439
|
+
* @throws ApiError
|
|
1440
|
+
*/
|
|
1441
|
+
listEnterpriseSyncAuditEvents(syncRunId: string): CancelablePromise<SyncAuditEventsResponse>;
|
|
1442
|
+
}
|
|
1443
|
+
|
|
830
1444
|
type CreateEnvTypeRequest = {
|
|
831
1445
|
name: string;
|
|
832
1446
|
color?: string;
|
|
@@ -1561,6 +2175,246 @@ declare class GpgKeysService {
|
|
|
1561
2175
|
updateGpgKeyTrustLevel(id: string, requestBody?: UpdateTrustLevelRequest): CancelablePromise<GpgKeyDetailResponse>;
|
|
1562
2176
|
}
|
|
1563
2177
|
|
|
2178
|
+
type LicenseState = {
|
|
2179
|
+
status: LicenseState.status;
|
|
2180
|
+
lease_expires_at?: string | null;
|
|
2181
|
+
last_verified_at?: string | null;
|
|
2182
|
+
last_error_code?: string | null;
|
|
2183
|
+
last_error_message?: string | null;
|
|
2184
|
+
validation_mode?: LicenseState.validation_mode;
|
|
2185
|
+
certificate_serial_hex?: string | null;
|
|
2186
|
+
certificate_fingerprint_sha256?: string | null;
|
|
2187
|
+
certificate_subject?: string | null;
|
|
2188
|
+
certificate_issuer?: string | null;
|
|
2189
|
+
certificate_expires_at?: string | null;
|
|
2190
|
+
root_ca_fingerprint_sha256?: string | null;
|
|
2191
|
+
validated_at?: string | null;
|
|
2192
|
+
};
|
|
2193
|
+
declare namespace LicenseState {
|
|
2194
|
+
enum status {
|
|
2195
|
+
UNKNOWN = "unknown",
|
|
2196
|
+
ACTIVE = "active",
|
|
2197
|
+
INACTIVE = "inactive",
|
|
2198
|
+
EXPIRED = "expired",
|
|
2199
|
+
ERROR = "error",
|
|
2200
|
+
LOCKED = "locked"
|
|
2201
|
+
}
|
|
2202
|
+
enum validation_mode {
|
|
2203
|
+
NONE = "none",
|
|
2204
|
+
LEASE = "lease",
|
|
2205
|
+
CERTIFICATE = "certificate"
|
|
2206
|
+
}
|
|
2207
|
+
}
|
|
2208
|
+
|
|
2209
|
+
type LicenseActionResponse = {
|
|
2210
|
+
message: string;
|
|
2211
|
+
state: LicenseState;
|
|
2212
|
+
};
|
|
2213
|
+
|
|
2214
|
+
type LicenseStatusResponse = {
|
|
2215
|
+
required: boolean;
|
|
2216
|
+
locked: boolean;
|
|
2217
|
+
reason?: string | null;
|
|
2218
|
+
state: LicenseState;
|
|
2219
|
+
};
|
|
2220
|
+
|
|
2221
|
+
declare class LicenseService {
|
|
2222
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2223
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2224
|
+
/**
|
|
2225
|
+
* Get Management License Status
|
|
2226
|
+
* @returns LicenseStatusResponse Current license status
|
|
2227
|
+
* @throws ApiError
|
|
2228
|
+
*/
|
|
2229
|
+
getManagementLicenseStatus(): CancelablePromise<LicenseStatusResponse>;
|
|
2230
|
+
/**
|
|
2231
|
+
* Activate Management License
|
|
2232
|
+
* @returns LicenseActionResponse License activated
|
|
2233
|
+
* @throws ApiError
|
|
2234
|
+
*/
|
|
2235
|
+
activateManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
2236
|
+
/**
|
|
2237
|
+
* Verify Management License
|
|
2238
|
+
* @returns LicenseActionResponse License verified
|
|
2239
|
+
* @throws ApiError
|
|
2240
|
+
*/
|
|
2241
|
+
verifyManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
2242
|
+
}
|
|
2243
|
+
|
|
2244
|
+
type CreateLogForwardingRequest = {
|
|
2245
|
+
name: string;
|
|
2246
|
+
provider_type: CreateLogForwardingRequest.provider_type;
|
|
2247
|
+
config: Record<string, any>;
|
|
2248
|
+
enabled?: boolean;
|
|
2249
|
+
};
|
|
2250
|
+
declare namespace CreateLogForwardingRequest {
|
|
2251
|
+
enum provider_type {
|
|
2252
|
+
DATADOG = "datadog",
|
|
2253
|
+
SPLUNK = "splunk",
|
|
2254
|
+
SUMO_LOGIC = "sumo-logic"
|
|
2255
|
+
}
|
|
2256
|
+
}
|
|
2257
|
+
|
|
2258
|
+
type LogForwardingResponse = {
|
|
2259
|
+
id: string;
|
|
2260
|
+
org_id: string;
|
|
2261
|
+
name: string;
|
|
2262
|
+
provider_type: LogForwardingResponse.provider_type;
|
|
2263
|
+
config: Record<string, any>;
|
|
2264
|
+
enabled: boolean;
|
|
2265
|
+
created_at: string;
|
|
2266
|
+
updated_at: string;
|
|
2267
|
+
};
|
|
2268
|
+
declare namespace LogForwardingResponse {
|
|
2269
|
+
enum provider_type {
|
|
2270
|
+
DATADOG = "datadog",
|
|
2271
|
+
SPLUNK = "splunk",
|
|
2272
|
+
SUMO_LOGIC = "sumo-logic"
|
|
2273
|
+
}
|
|
2274
|
+
}
|
|
2275
|
+
|
|
2276
|
+
type LogForwardingsResponse = Array<LogForwardingResponse>;
|
|
2277
|
+
|
|
2278
|
+
declare class LogForwardingService {
|
|
2279
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2280
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2281
|
+
/**
|
|
2282
|
+
* Create Log Forwarding Config
|
|
2283
|
+
* Create a new log forwarding configuration for the organization
|
|
2284
|
+
* @param requestBody
|
|
2285
|
+
* @returns LogForwardingResponse Log forwarding config created successfully
|
|
2286
|
+
* @throws ApiError
|
|
2287
|
+
*/
|
|
2288
|
+
createLogForwardingConfig(requestBody?: CreateLogForwardingRequest): CancelablePromise<LogForwardingResponse>;
|
|
2289
|
+
/**
|
|
2290
|
+
* Get All Log Forwarding Configs
|
|
2291
|
+
* Retrieve all log forwarding configurations for the organization
|
|
2292
|
+
* @returns LogForwardingsResponse Log forwarding configs retrieved successfully
|
|
2293
|
+
* @throws ApiError
|
|
2294
|
+
*/
|
|
2295
|
+
getLogForwardingConfigs(): CancelablePromise<LogForwardingsResponse>;
|
|
2296
|
+
/**
|
|
2297
|
+
* Get Log Forwarding Config
|
|
2298
|
+
* Retrieve a specific log forwarding configuration
|
|
2299
|
+
* @param id
|
|
2300
|
+
* @returns LogForwardingResponse Log forwarding config retrieved successfully
|
|
2301
|
+
* @throws ApiError
|
|
2302
|
+
*/
|
|
2303
|
+
getLogForwardingConfig(id: string): CancelablePromise<LogForwardingResponse>;
|
|
2304
|
+
/**
|
|
2305
|
+
* Delete Log Forwarding Config
|
|
2306
|
+
* Delete a log forwarding configuration
|
|
2307
|
+
* @param id
|
|
2308
|
+
* @returns ErrorResponse Log forwarding config deleted successfully
|
|
2309
|
+
* @throws ApiError
|
|
2310
|
+
*/
|
|
2311
|
+
deleteLogForwardingConfig(id: string): CancelablePromise<ErrorResponse>;
|
|
2312
|
+
}
|
|
2313
|
+
|
|
2314
|
+
type CreateOidcProviderRequest = {
|
|
2315
|
+
/**
|
|
2316
|
+
* CI/CD platform type
|
|
2317
|
+
*/
|
|
2318
|
+
provider_type: CreateOidcProviderRequest.provider_type;
|
|
2319
|
+
/**
|
|
2320
|
+
* OIDC issuer URL
|
|
2321
|
+
*/
|
|
2322
|
+
issuer_url: string;
|
|
2323
|
+
/**
|
|
2324
|
+
* Expected audience claim value
|
|
2325
|
+
*/
|
|
2326
|
+
audience: string;
|
|
2327
|
+
/**
|
|
2328
|
+
* Subject patterns to allow (glob matching). Empty = allow all subjects from this issuer.
|
|
2329
|
+
*/
|
|
2330
|
+
allowed_subjects?: Array<string>;
|
|
2331
|
+
};
|
|
2332
|
+
declare namespace CreateOidcProviderRequest {
|
|
2333
|
+
/**
|
|
2334
|
+
* CI/CD platform type
|
|
2335
|
+
*/
|
|
2336
|
+
enum provider_type {
|
|
2337
|
+
GITHUB_ACTIONS = "github_actions",
|
|
2338
|
+
GITLAB_CI = "gitlab_ci",
|
|
2339
|
+
KUBERNETES = "kubernetes",
|
|
2340
|
+
GENERIC = "generic"
|
|
2341
|
+
}
|
|
2342
|
+
}
|
|
2343
|
+
|
|
2344
|
+
type OidcProviderResponse = {
|
|
2345
|
+
id: string;
|
|
2346
|
+
org_id: string;
|
|
2347
|
+
provider_type: OidcProviderResponse.provider_type;
|
|
2348
|
+
issuer_url: string;
|
|
2349
|
+
audience: string;
|
|
2350
|
+
enabled: boolean;
|
|
2351
|
+
allowed_subjects: Array<string>;
|
|
2352
|
+
machine_user_id: string | null;
|
|
2353
|
+
created_at: string;
|
|
2354
|
+
updated_at: string;
|
|
2355
|
+
};
|
|
2356
|
+
declare namespace OidcProviderResponse {
|
|
2357
|
+
enum provider_type {
|
|
2358
|
+
GITHUB_ACTIONS = "github_actions",
|
|
2359
|
+
GITLAB_CI = "gitlab_ci",
|
|
2360
|
+
KUBERNETES = "kubernetes",
|
|
2361
|
+
GENERIC = "generic"
|
|
2362
|
+
}
|
|
2363
|
+
}
|
|
2364
|
+
|
|
2365
|
+
type OidcProvidersResponse = Array<OidcProviderResponse>;
|
|
2366
|
+
|
|
2367
|
+
type UpdateOidcProviderRequest = {
|
|
2368
|
+
audience?: string;
|
|
2369
|
+
enabled?: boolean;
|
|
2370
|
+
allowed_subjects?: Array<string>;
|
|
2371
|
+
};
|
|
2372
|
+
|
|
2373
|
+
declare class OidcProvidersService {
|
|
2374
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2375
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2376
|
+
/**
|
|
2377
|
+
* Register OIDC Provider
|
|
2378
|
+
* Register a new OIDC provider for CI/CD machine authentication
|
|
2379
|
+
* @param requestBody
|
|
2380
|
+
* @returns OidcProviderResponse OIDC provider created successfully
|
|
2381
|
+
* @throws ApiError
|
|
2382
|
+
*/
|
|
2383
|
+
createOidcProvider(requestBody?: CreateOidcProviderRequest): CancelablePromise<OidcProviderResponse>;
|
|
2384
|
+
/**
|
|
2385
|
+
* Get All OIDC Providers
|
|
2386
|
+
* Retrieve all OIDC providers for the organization
|
|
2387
|
+
* @returns OidcProvidersResponse OIDC providers retrieved successfully
|
|
2388
|
+
* @throws ApiError
|
|
2389
|
+
*/
|
|
2390
|
+
getAllOidcProviders(): CancelablePromise<OidcProvidersResponse>;
|
|
2391
|
+
/**
|
|
2392
|
+
* Get OIDC Provider
|
|
2393
|
+
* Retrieve a specific OIDC provider
|
|
2394
|
+
* @param id
|
|
2395
|
+
* @returns OidcProviderResponse OIDC provider retrieved successfully
|
|
2396
|
+
* @throws ApiError
|
|
2397
|
+
*/
|
|
2398
|
+
getOidcProvider(id: string): CancelablePromise<OidcProviderResponse>;
|
|
2399
|
+
/**
|
|
2400
|
+
* Update OIDC Provider
|
|
2401
|
+
* Update an existing OIDC provider
|
|
2402
|
+
* @param id
|
|
2403
|
+
* @param requestBody
|
|
2404
|
+
* @returns ErrorResponse OIDC provider updated successfully
|
|
2405
|
+
* @throws ApiError
|
|
2406
|
+
*/
|
|
2407
|
+
updateOidcProvider(id: string, requestBody?: UpdateOidcProviderRequest): CancelablePromise<ErrorResponse>;
|
|
2408
|
+
/**
|
|
2409
|
+
* Delete OIDC Provider
|
|
2410
|
+
* Delete an existing OIDC provider
|
|
2411
|
+
* @param id
|
|
2412
|
+
* @returns ErrorResponse OIDC provider deleted successfully
|
|
2413
|
+
* @throws ApiError
|
|
2414
|
+
*/
|
|
2415
|
+
deleteOidcProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
2416
|
+
}
|
|
2417
|
+
|
|
1564
2418
|
type AcceptOrgInviteRequest = {
|
|
1565
2419
|
org_data: {
|
|
1566
2420
|
name: string;
|
|
@@ -1665,7 +2519,81 @@ declare class OnboardingService {
|
|
|
1665
2519
|
* @returns CreateOrgInviteResponse Successful greeting response
|
|
1666
2520
|
* @throws ApiError
|
|
1667
2521
|
*/
|
|
1668
|
-
createOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
2522
|
+
createOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
2523
|
+
/**
|
|
2524
|
+
* Get Organization Invite by Code
|
|
2525
|
+
* Get organization invite by code
|
|
2526
|
+
* @param inviteCode
|
|
2527
|
+
* @returns GetOrgInviteByCodeResponse Organization invite retrieved successfully
|
|
2528
|
+
* @throws ApiError
|
|
2529
|
+
*/
|
|
2530
|
+
getOrgInviteByCode(inviteCode: string): CancelablePromise<GetOrgInviteByCodeResponse>;
|
|
2531
|
+
/**
|
|
2532
|
+
* Accept Organization Invite
|
|
2533
|
+
* Accept organization invite
|
|
2534
|
+
* @param inviteCode
|
|
2535
|
+
* @param requestBody
|
|
2536
|
+
* @returns AcceptOrgInviteResponse Organization invite accepted successfully
|
|
2537
|
+
* @throws ApiError
|
|
2538
|
+
*/
|
|
2539
|
+
acceptOrgInvite(inviteCode: string, requestBody?: AcceptOrgInviteRequest): CancelablePromise<AcceptOrgInviteResponse>;
|
|
2540
|
+
/**
|
|
2541
|
+
* Get User Invite by Code
|
|
2542
|
+
* Get user invite by code
|
|
2543
|
+
* @param inviteCode
|
|
2544
|
+
* @returns GetUserInviteByTokenResponse User invite retrieved successfully
|
|
2545
|
+
* @throws ApiError
|
|
2546
|
+
*/
|
|
2547
|
+
getUserInviteByCode(inviteCode: string): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
2548
|
+
/**
|
|
2549
|
+
* Update User Invite
|
|
2550
|
+
* Update user invite
|
|
2551
|
+
* @param inviteCode
|
|
2552
|
+
* @param requestBody
|
|
2553
|
+
* @returns UpdateUserInviteResponse User invite updated successfully
|
|
2554
|
+
* @throws ApiError
|
|
2555
|
+
*/
|
|
2556
|
+
updateUserInvite(inviteCode: string, requestBody?: UpdateUserInviteRequest): CancelablePromise<UpdateUserInviteResponse>;
|
|
2557
|
+
/**
|
|
2558
|
+
* Accept User Invite
|
|
2559
|
+
* Accept user invite
|
|
2560
|
+
* @param inviteCode
|
|
2561
|
+
* @param requestBody
|
|
2562
|
+
* @returns AcceptUserInviteResponse User invite accepted successfully
|
|
2563
|
+
* @throws ApiError
|
|
2564
|
+
*/
|
|
2565
|
+
acceptUserInvite(inviteCode: string, requestBody?: AcceptUserInviteRequest): CancelablePromise<AcceptUserInviteResponse>;
|
|
2566
|
+
/**
|
|
2567
|
+
* Create User Invite
|
|
2568
|
+
* Create a user invite
|
|
2569
|
+
* @param requestBody
|
|
2570
|
+
* @returns CreateUserInviteResponse User invite created successfully
|
|
2571
|
+
* @throws ApiError
|
|
2572
|
+
*/
|
|
2573
|
+
createUserInvite(requestBody?: CreateUserInviteRequest): CancelablePromise<CreateUserInviteResponse>;
|
|
2574
|
+
/**
|
|
2575
|
+
* Get All User Invites
|
|
2576
|
+
* Get all user invites
|
|
2577
|
+
* @returns GetUserInviteByTokenResponse User invites retrieved successfully
|
|
2578
|
+
* @throws ApiError
|
|
2579
|
+
*/
|
|
2580
|
+
getAllUserInvites(): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
2581
|
+
/**
|
|
2582
|
+
* Delete User Invite
|
|
2583
|
+
* Delete user invite
|
|
2584
|
+
* @param inviteId
|
|
2585
|
+
* @returns DeleteUserInviteResponse User invite deleted successfully
|
|
2586
|
+
* @throws ApiError
|
|
2587
|
+
*/
|
|
2588
|
+
deleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
2589
|
+
/**
|
|
2590
|
+
* Create Organization Invite
|
|
2591
|
+
* Create an organization invite
|
|
2592
|
+
* @param requestBody
|
|
2593
|
+
* @returns CreateOrgInviteResponse Successful greeting response
|
|
2594
|
+
* @throws ApiError
|
|
2595
|
+
*/
|
|
2596
|
+
manageCreateOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
1669
2597
|
/**
|
|
1670
2598
|
* Get Organization Invite by Code
|
|
1671
2599
|
* Get organization invite by code
|
|
@@ -1673,7 +2601,7 @@ declare class OnboardingService {
|
|
|
1673
2601
|
* @returns GetOrgInviteByCodeResponse Organization invite retrieved successfully
|
|
1674
2602
|
* @throws ApiError
|
|
1675
2603
|
*/
|
|
1676
|
-
|
|
2604
|
+
manageGetOrgInviteByCode(inviteCode: string): CancelablePromise<GetOrgInviteByCodeResponse>;
|
|
1677
2605
|
/**
|
|
1678
2606
|
* Accept Organization Invite
|
|
1679
2607
|
* Accept organization invite
|
|
@@ -1682,7 +2610,7 @@ declare class OnboardingService {
|
|
|
1682
2610
|
* @returns AcceptOrgInviteResponse Organization invite accepted successfully
|
|
1683
2611
|
* @throws ApiError
|
|
1684
2612
|
*/
|
|
1685
|
-
|
|
2613
|
+
manageAcceptOrgInvite(inviteCode: string, requestBody?: AcceptOrgInviteRequest): CancelablePromise<AcceptOrgInviteResponse>;
|
|
1686
2614
|
/**
|
|
1687
2615
|
* Get User Invite by Code
|
|
1688
2616
|
* Get user invite by code
|
|
@@ -1690,7 +2618,7 @@ declare class OnboardingService {
|
|
|
1690
2618
|
* @returns GetUserInviteByTokenResponse User invite retrieved successfully
|
|
1691
2619
|
* @throws ApiError
|
|
1692
2620
|
*/
|
|
1693
|
-
|
|
2621
|
+
manageGetUserInviteByCode(inviteCode: string): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
1694
2622
|
/**
|
|
1695
2623
|
* Update User Invite
|
|
1696
2624
|
* Update user invite
|
|
@@ -1699,7 +2627,7 @@ declare class OnboardingService {
|
|
|
1699
2627
|
* @returns UpdateUserInviteResponse User invite updated successfully
|
|
1700
2628
|
* @throws ApiError
|
|
1701
2629
|
*/
|
|
1702
|
-
|
|
2630
|
+
manageUpdateUserInvite(inviteCode: string, requestBody?: UpdateUserInviteRequest): CancelablePromise<UpdateUserInviteResponse>;
|
|
1703
2631
|
/**
|
|
1704
2632
|
* Accept User Invite
|
|
1705
2633
|
* Accept user invite
|
|
@@ -1708,7 +2636,7 @@ declare class OnboardingService {
|
|
|
1708
2636
|
* @returns AcceptUserInviteResponse User invite accepted successfully
|
|
1709
2637
|
* @throws ApiError
|
|
1710
2638
|
*/
|
|
1711
|
-
|
|
2639
|
+
manageAcceptUserInvite(inviteCode: string, requestBody?: AcceptUserInviteRequest): CancelablePromise<AcceptUserInviteResponse>;
|
|
1712
2640
|
/**
|
|
1713
2641
|
* Create User Invite
|
|
1714
2642
|
* Create a user invite
|
|
@@ -1716,14 +2644,14 @@ declare class OnboardingService {
|
|
|
1716
2644
|
* @returns CreateUserInviteResponse User invite created successfully
|
|
1717
2645
|
* @throws ApiError
|
|
1718
2646
|
*/
|
|
1719
|
-
|
|
2647
|
+
manageCreateUserInvite(requestBody?: CreateUserInviteRequest): CancelablePromise<CreateUserInviteResponse>;
|
|
1720
2648
|
/**
|
|
1721
2649
|
* Get All User Invites
|
|
1722
2650
|
* Get all user invites
|
|
1723
2651
|
* @returns GetUserInviteByTokenResponse User invites retrieved successfully
|
|
1724
2652
|
* @throws ApiError
|
|
1725
2653
|
*/
|
|
1726
|
-
|
|
2654
|
+
manageGetAllUserInvites(): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
1727
2655
|
/**
|
|
1728
2656
|
* Delete User Invite
|
|
1729
2657
|
* Delete user invite
|
|
@@ -1731,7 +2659,7 @@ declare class OnboardingService {
|
|
|
1731
2659
|
* @returns DeleteUserInviteResponse User invite deleted successfully
|
|
1732
2660
|
* @throws ApiError
|
|
1733
2661
|
*/
|
|
1734
|
-
|
|
2662
|
+
manageDeleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
1735
2663
|
}
|
|
1736
2664
|
|
|
1737
2665
|
type CheckSlugResponse = {
|
|
@@ -2069,6 +2997,326 @@ declare class RolesService {
|
|
|
2069
2997
|
deleteRole(id: string): CancelablePromise<RoleResponse>;
|
|
2070
2998
|
}
|
|
2071
2999
|
|
|
3000
|
+
type CreateRotationPolicyRequest = {
|
|
3001
|
+
app_id: string;
|
|
3002
|
+
env_type_id: string;
|
|
3003
|
+
variable_key: string;
|
|
3004
|
+
engine_type: CreateRotationPolicyRequest.engine_type;
|
|
3005
|
+
schedule_cron: string;
|
|
3006
|
+
dual_window_minutes?: number;
|
|
3007
|
+
enabled?: boolean;
|
|
3008
|
+
connection_config: Record<string, any>;
|
|
3009
|
+
};
|
|
3010
|
+
declare namespace CreateRotationPolicyRequest {
|
|
3011
|
+
enum engine_type {
|
|
3012
|
+
POSTGRES = "postgres",
|
|
3013
|
+
MYSQL = "mysql",
|
|
3014
|
+
AWS_IAM = "aws-iam",
|
|
3015
|
+
AZURE_SP = "azure-sp",
|
|
3016
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
3017
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
3018
|
+
SENDGRID = "sendgrid",
|
|
3019
|
+
TWILIO = "twilio"
|
|
3020
|
+
}
|
|
3021
|
+
}
|
|
3022
|
+
|
|
3023
|
+
type RevokeOldCredentialResponse = {
|
|
3024
|
+
message: string;
|
|
3025
|
+
revoked_at: string;
|
|
3026
|
+
};
|
|
3027
|
+
|
|
3028
|
+
type RotationPolicyResponse = {
|
|
3029
|
+
id: string;
|
|
3030
|
+
org_id: string;
|
|
3031
|
+
app_id: string;
|
|
3032
|
+
env_type_id: string;
|
|
3033
|
+
variable_key: string;
|
|
3034
|
+
engine_type: RotationPolicyResponse.engine_type;
|
|
3035
|
+
schedule_cron: string;
|
|
3036
|
+
dual_window_minutes: number;
|
|
3037
|
+
enabled: boolean;
|
|
3038
|
+
last_rotated_at: string | null;
|
|
3039
|
+
next_rotation_at: string | null;
|
|
3040
|
+
created_at: string;
|
|
3041
|
+
updated_at: string;
|
|
3042
|
+
};
|
|
3043
|
+
declare namespace RotationPolicyResponse {
|
|
3044
|
+
enum engine_type {
|
|
3045
|
+
POSTGRES = "postgres",
|
|
3046
|
+
MYSQL = "mysql",
|
|
3047
|
+
AWS_IAM = "aws-iam",
|
|
3048
|
+
AZURE_SP = "azure-sp",
|
|
3049
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
3050
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
3051
|
+
SENDGRID = "sendgrid",
|
|
3052
|
+
TWILIO = "twilio"
|
|
3053
|
+
}
|
|
3054
|
+
}
|
|
3055
|
+
|
|
3056
|
+
type RotationPoliciesResponse = Array<RotationPolicyResponse>;
|
|
3057
|
+
|
|
3058
|
+
type RotationStateResponse = {
|
|
3059
|
+
id: string;
|
|
3060
|
+
rotation_policy_id: string;
|
|
3061
|
+
rotated_at: string;
|
|
3062
|
+
old_credential_expires_at: string;
|
|
3063
|
+
old_credential_revoked: boolean;
|
|
3064
|
+
revoked_at: string | null;
|
|
3065
|
+
created_at: string;
|
|
3066
|
+
};
|
|
3067
|
+
|
|
3068
|
+
type RotationStatesResponse = Array<RotationStateResponse>;
|
|
3069
|
+
|
|
3070
|
+
type TriggerRotationResponse = {
|
|
3071
|
+
message: string;
|
|
3072
|
+
rotation_state_id: string;
|
|
3073
|
+
new_credential_stored: boolean;
|
|
3074
|
+
old_credential_expires_at: string;
|
|
3075
|
+
};
|
|
3076
|
+
|
|
3077
|
+
type UpdateRotationPolicyRequest = {
|
|
3078
|
+
schedule_cron?: string;
|
|
3079
|
+
dual_window_minutes?: number;
|
|
3080
|
+
enabled?: boolean;
|
|
3081
|
+
connection_config?: Record<string, any>;
|
|
3082
|
+
};
|
|
3083
|
+
|
|
3084
|
+
declare class RotationService {
|
|
3085
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3086
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3087
|
+
/**
|
|
3088
|
+
* Create Rotation Policy
|
|
3089
|
+
* Create a new secret rotation policy for a variable
|
|
3090
|
+
* @param requestBody
|
|
3091
|
+
* @returns RotationPolicyResponse Rotation policy created successfully
|
|
3092
|
+
* @throws ApiError
|
|
3093
|
+
*/
|
|
3094
|
+
createRotationPolicy(requestBody?: CreateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
3095
|
+
/**
|
|
3096
|
+
* Get Rotation Policies
|
|
3097
|
+
* List all rotation policies for the organization
|
|
3098
|
+
* @param appId
|
|
3099
|
+
* @param envTypeId
|
|
3100
|
+
* @param enabled
|
|
3101
|
+
* @returns RotationPoliciesResponse Rotation policies retrieved successfully
|
|
3102
|
+
* @throws ApiError
|
|
3103
|
+
*/
|
|
3104
|
+
getRotationPolicies(appId?: string, envTypeId?: string, enabled?: 'true' | 'false'): CancelablePromise<RotationPoliciesResponse>;
|
|
3105
|
+
/**
|
|
3106
|
+
* Get Rotation Policy
|
|
3107
|
+
* Get a specific rotation policy by ID
|
|
3108
|
+
* @param id
|
|
3109
|
+
* @returns RotationPolicyResponse Rotation policy retrieved successfully
|
|
3110
|
+
* @throws ApiError
|
|
3111
|
+
*/
|
|
3112
|
+
getRotationPolicy(id: string): CancelablePromise<RotationPolicyResponse>;
|
|
3113
|
+
/**
|
|
3114
|
+
* Update Rotation Policy
|
|
3115
|
+
* Update an existing rotation policy
|
|
3116
|
+
* @param id
|
|
3117
|
+
* @param requestBody
|
|
3118
|
+
* @returns RotationPolicyResponse Rotation policy updated successfully
|
|
3119
|
+
* @throws ApiError
|
|
3120
|
+
*/
|
|
3121
|
+
updateRotationPolicy(id: string, requestBody?: UpdateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
3122
|
+
/**
|
|
3123
|
+
* Delete Rotation Policy
|
|
3124
|
+
* Delete a rotation policy
|
|
3125
|
+
* @param id
|
|
3126
|
+
* @returns ErrorResponse Rotation policy deleted successfully
|
|
3127
|
+
* @throws ApiError
|
|
3128
|
+
*/
|
|
3129
|
+
deleteRotationPolicy(id: string): CancelablePromise<ErrorResponse>;
|
|
3130
|
+
/**
|
|
3131
|
+
* Trigger Rotation
|
|
3132
|
+
* Manually trigger a secret rotation for a policy
|
|
3133
|
+
* @param id
|
|
3134
|
+
* @returns TriggerRotationResponse Rotation executed successfully
|
|
3135
|
+
* @throws ApiError
|
|
3136
|
+
*/
|
|
3137
|
+
triggerRotation(id: string): CancelablePromise<TriggerRotationResponse>;
|
|
3138
|
+
/**
|
|
3139
|
+
* Get Rotation States
|
|
3140
|
+
* Get the rotation state history for a policy
|
|
3141
|
+
* @param id
|
|
3142
|
+
* @returns RotationStatesResponse Rotation states retrieved successfully
|
|
3143
|
+
* @throws ApiError
|
|
3144
|
+
*/
|
|
3145
|
+
getRotationStates(id: string): CancelablePromise<RotationStatesResponse>;
|
|
3146
|
+
/**
|
|
3147
|
+
* Revoke Expired Credentials
|
|
3148
|
+
* Revoke old credentials that have passed their dual-credential window
|
|
3149
|
+
* @returns RevokeOldCredentialResponse Expired credentials revoked successfully
|
|
3150
|
+
* @throws ApiError
|
|
3151
|
+
*/
|
|
3152
|
+
revokeExpiredCredentials(): CancelablePromise<RevokeOldCredentialResponse>;
|
|
3153
|
+
}
|
|
3154
|
+
|
|
3155
|
+
type CreateSamlProviderRequest = {
|
|
3156
|
+
/**
|
|
3157
|
+
* SAML identity provider type
|
|
3158
|
+
*/
|
|
3159
|
+
provider_type: CreateSamlProviderRequest.provider_type;
|
|
3160
|
+
/**
|
|
3161
|
+
* Human-readable name for this provider
|
|
3162
|
+
*/
|
|
3163
|
+
name: string;
|
|
3164
|
+
/**
|
|
3165
|
+
* SAML entity ID (issuer) from the IdP metadata
|
|
3166
|
+
*/
|
|
3167
|
+
entity_id: string;
|
|
3168
|
+
/**
|
|
3169
|
+
* IdP SSO login URL
|
|
3170
|
+
*/
|
|
3171
|
+
sso_url: string;
|
|
3172
|
+
/**
|
|
3173
|
+
* IdP X.509 certificate (PEM format) for signature validation
|
|
3174
|
+
*/
|
|
3175
|
+
certificate: string;
|
|
3176
|
+
};
|
|
3177
|
+
declare namespace CreateSamlProviderRequest {
|
|
3178
|
+
/**
|
|
3179
|
+
* SAML identity provider type
|
|
3180
|
+
*/
|
|
3181
|
+
enum provider_type {
|
|
3182
|
+
OKTA = "okta",
|
|
3183
|
+
ONELOGIN = "onelogin",
|
|
3184
|
+
AZURE_AD = "azure-ad",
|
|
3185
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
3186
|
+
DUO = "duo",
|
|
3187
|
+
RIPPLING = "rippling",
|
|
3188
|
+
ORACLE = "oracle",
|
|
3189
|
+
PING_IDENTITY = "ping-identity"
|
|
3190
|
+
}
|
|
3191
|
+
}
|
|
3192
|
+
|
|
3193
|
+
type SamlProviderResponse = {
|
|
3194
|
+
id: string;
|
|
3195
|
+
org_id: string;
|
|
3196
|
+
provider_type: SamlProviderResponse.provider_type;
|
|
3197
|
+
name: string;
|
|
3198
|
+
entity_id: string;
|
|
3199
|
+
sso_url: string;
|
|
3200
|
+
certificate: string;
|
|
3201
|
+
enabled: boolean;
|
|
3202
|
+
created_at: string;
|
|
3203
|
+
updated_at: string;
|
|
3204
|
+
};
|
|
3205
|
+
declare namespace SamlProviderResponse {
|
|
3206
|
+
enum provider_type {
|
|
3207
|
+
OKTA = "okta",
|
|
3208
|
+
ONELOGIN = "onelogin",
|
|
3209
|
+
AZURE_AD = "azure-ad",
|
|
3210
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
3211
|
+
DUO = "duo",
|
|
3212
|
+
RIPPLING = "rippling",
|
|
3213
|
+
ORACLE = "oracle",
|
|
3214
|
+
PING_IDENTITY = "ping-identity"
|
|
3215
|
+
}
|
|
3216
|
+
}
|
|
3217
|
+
|
|
3218
|
+
type SamlProvidersResponse = Array<SamlProviderResponse>;
|
|
3219
|
+
|
|
3220
|
+
type UpdateSamlProviderRequest = {
|
|
3221
|
+
name?: string;
|
|
3222
|
+
entity_id?: string;
|
|
3223
|
+
sso_url?: string;
|
|
3224
|
+
certificate?: string;
|
|
3225
|
+
enabled?: boolean;
|
|
3226
|
+
};
|
|
3227
|
+
|
|
3228
|
+
declare class SamlProvidersService {
|
|
3229
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3230
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3231
|
+
/**
|
|
3232
|
+
* Register SAML Provider
|
|
3233
|
+
* Register a new SAML identity provider for SSO authentication
|
|
3234
|
+
* @param requestBody
|
|
3235
|
+
* @returns SamlProviderResponse SAML provider created successfully
|
|
3236
|
+
* @throws ApiError
|
|
3237
|
+
*/
|
|
3238
|
+
createSamlProvider(requestBody?: CreateSamlProviderRequest): CancelablePromise<SamlProviderResponse>;
|
|
3239
|
+
/**
|
|
3240
|
+
* Get All SAML Providers
|
|
3241
|
+
* Retrieve all SAML providers for the organization
|
|
3242
|
+
* @returns SamlProvidersResponse SAML providers retrieved successfully
|
|
3243
|
+
* @throws ApiError
|
|
3244
|
+
*/
|
|
3245
|
+
getAllSamlProviders(): CancelablePromise<SamlProvidersResponse>;
|
|
3246
|
+
/**
|
|
3247
|
+
* Get SAML Provider
|
|
3248
|
+
* Retrieve a specific SAML provider
|
|
3249
|
+
* @param id
|
|
3250
|
+
* @returns SamlProviderResponse SAML provider retrieved successfully
|
|
3251
|
+
* @throws ApiError
|
|
3252
|
+
*/
|
|
3253
|
+
getSamlProvider(id: string): CancelablePromise<SamlProviderResponse>;
|
|
3254
|
+
/**
|
|
3255
|
+
* Update SAML Provider
|
|
3256
|
+
* Update an existing SAML provider
|
|
3257
|
+
* @param id
|
|
3258
|
+
* @param requestBody
|
|
3259
|
+
* @returns ErrorResponse SAML provider updated successfully
|
|
3260
|
+
* @throws ApiError
|
|
3261
|
+
*/
|
|
3262
|
+
updateSamlProvider(id: string, requestBody?: UpdateSamlProviderRequest): CancelablePromise<ErrorResponse>;
|
|
3263
|
+
/**
|
|
3264
|
+
* Delete SAML Provider
|
|
3265
|
+
* Delete an existing SAML provider
|
|
3266
|
+
* @param id
|
|
3267
|
+
* @returns ErrorResponse SAML provider deleted successfully
|
|
3268
|
+
* @throws ApiError
|
|
3269
|
+
*/
|
|
3270
|
+
deleteSamlProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
3271
|
+
/**
|
|
3272
|
+
* Get SAML SP Metadata
|
|
3273
|
+
* Retrieve SAML Service Provider metadata XML for the organization
|
|
3274
|
+
* @param id
|
|
3275
|
+
* @returns string SP metadata XML
|
|
3276
|
+
* @throws ApiError
|
|
3277
|
+
*/
|
|
3278
|
+
getSamlMetadata(id: string): CancelablePromise<string>;
|
|
3279
|
+
}
|
|
3280
|
+
|
|
3281
|
+
type SamlSsoRequest = {
|
|
3282
|
+
/**
|
|
3283
|
+
* SAML provider ID to initiate SSO with
|
|
3284
|
+
*/
|
|
3285
|
+
provider_id: string;
|
|
3286
|
+
};
|
|
3287
|
+
|
|
3288
|
+
type SamlSsoResponse = {
|
|
3289
|
+
/**
|
|
3290
|
+
* URL to redirect the user to for IdP authentication
|
|
3291
|
+
*/
|
|
3292
|
+
redirect_url: string;
|
|
3293
|
+
/**
|
|
3294
|
+
* AuthnRequest ID for tracking
|
|
3295
|
+
*/
|
|
3296
|
+
request_id: string;
|
|
3297
|
+
};
|
|
3298
|
+
|
|
3299
|
+
declare class SamlSsoService {
|
|
3300
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3301
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3302
|
+
/**
|
|
3303
|
+
* Initiate SAML SSO
|
|
3304
|
+
* Start SP-initiated SAML SSO flow by generating an AuthnRequest redirect URL
|
|
3305
|
+
* @param requestBody
|
|
3306
|
+
* @returns SamlSsoResponse Redirect URL generated
|
|
3307
|
+
* @throws ApiError
|
|
3308
|
+
*/
|
|
3309
|
+
initiateSamlSso(requestBody?: SamlSsoRequest): CancelablePromise<SamlSsoResponse>;
|
|
3310
|
+
/**
|
|
3311
|
+
* SAML Assertion Consumer Service
|
|
3312
|
+
* Receive and validate SAML Response from the identity provider (ACS endpoint)
|
|
3313
|
+
* @param orgId
|
|
3314
|
+
* @returns any Authentication successful
|
|
3315
|
+
* @throws ApiError
|
|
3316
|
+
*/
|
|
3317
|
+
handleSamlAcs(orgId: string): CancelablePromise<any>;
|
|
3318
|
+
}
|
|
3319
|
+
|
|
2072
3320
|
type BatchCreateSecretsRequest = {
|
|
2073
3321
|
app_id: string;
|
|
2074
3322
|
env_type_id: string;
|
|
@@ -2482,10 +3730,6 @@ type CreateServiceTokenResponse = {
|
|
|
2482
3730
|
created_at: string;
|
|
2483
3731
|
};
|
|
2484
3732
|
|
|
2485
|
-
type ErrorResponse = {
|
|
2486
|
-
error: string;
|
|
2487
|
-
};
|
|
2488
|
-
|
|
2489
3733
|
type ServiceTokenResponse = {
|
|
2490
3734
|
id: string;
|
|
2491
3735
|
name: string;
|
|
@@ -2535,47 +3779,65 @@ declare class ServiceTokensService {
|
|
|
2535
3779
|
deleteServiceToken(id: string): CancelablePromise<ErrorResponse>;
|
|
2536
3780
|
}
|
|
2537
3781
|
|
|
2538
|
-
type
|
|
2539
|
-
|
|
2540
|
-
|
|
2541
|
-
|
|
2542
|
-
|
|
2543
|
-
|
|
2544
|
-
validation_mode?: LicenseState.validation_mode;
|
|
2545
|
-
certificate_serial_hex?: string | null;
|
|
2546
|
-
certificate_fingerprint_sha256?: string | null;
|
|
2547
|
-
certificate_subject?: string | null;
|
|
2548
|
-
certificate_issuer?: string | null;
|
|
2549
|
-
certificate_expires_at?: string | null;
|
|
2550
|
-
root_ca_fingerprint_sha256?: string | null;
|
|
2551
|
-
validated_at?: string | null;
|
|
3782
|
+
type CreateSetupOrgRequest = {
|
|
3783
|
+
org_name: string;
|
|
3784
|
+
org_slug?: string;
|
|
3785
|
+
admin_email: string;
|
|
3786
|
+
admin_full_name?: string;
|
|
3787
|
+
admin_password: string;
|
|
2552
3788
|
};
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
3789
|
+
|
|
3790
|
+
type SetupStatusResponse = {
|
|
3791
|
+
deployment_mode: SetupStatusResponse.deployment_mode;
|
|
3792
|
+
edition: SetupStatusResponse.edition;
|
|
3793
|
+
org_count: number;
|
|
3794
|
+
max_orgs: number | null;
|
|
3795
|
+
can_create_organization: boolean;
|
|
3796
|
+
first_org_ready: boolean;
|
|
3797
|
+
channel: string;
|
|
3798
|
+
};
|
|
3799
|
+
declare namespace SetupStatusResponse {
|
|
3800
|
+
enum deployment_mode {
|
|
3801
|
+
HOSTED = "hosted",
|
|
3802
|
+
SELFHOSTED = "selfhosted"
|
|
2561
3803
|
}
|
|
2562
|
-
enum
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
CERTIFICATE = "certificate"
|
|
3804
|
+
enum edition {
|
|
3805
|
+
OSS = "oss",
|
|
3806
|
+
ENTERPRISE = "enterprise"
|
|
2566
3807
|
}
|
|
2567
3808
|
}
|
|
2568
3809
|
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
3810
|
+
declare class SetupService {
|
|
3811
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3812
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3813
|
+
/**
|
|
3814
|
+
* Operator setup status (self-host)
|
|
3815
|
+
* @returns SetupStatusResponse Setup status
|
|
3816
|
+
* @throws ApiError
|
|
3817
|
+
*/
|
|
3818
|
+
getSetupStatus(): CancelablePromise<SetupStatusResponse>;
|
|
3819
|
+
/**
|
|
3820
|
+
* Create organization via operator setup token (self-host only)
|
|
3821
|
+
* @param requestBody
|
|
3822
|
+
* @returns any Organization created
|
|
3823
|
+
* @throws ApiError
|
|
3824
|
+
*/
|
|
3825
|
+
createSetupOrganization(requestBody?: CreateSetupOrgRequest): CancelablePromise<{
|
|
3826
|
+
message: string;
|
|
3827
|
+
org_id: string;
|
|
3828
|
+
admin_user_id: string;
|
|
3829
|
+
source: string;
|
|
3830
|
+
first_org: boolean;
|
|
3831
|
+
}>;
|
|
3832
|
+
}
|
|
2575
3833
|
|
|
2576
3834
|
type SystemStatusState = {
|
|
2577
3835
|
edition: SystemStatusState.edition;
|
|
3836
|
+
deployment_mode?: SystemStatusState.deployment_mode;
|
|
2578
3837
|
single_org_mode: boolean;
|
|
3838
|
+
max_orgs?: number | null;
|
|
3839
|
+
public_signup_enabled?: boolean;
|
|
3840
|
+
can_create_organization?: boolean;
|
|
2579
3841
|
management_enabled: boolean;
|
|
2580
3842
|
observability_enabled: boolean;
|
|
2581
3843
|
management_web_enabled: boolean;
|
|
@@ -2588,6 +3850,10 @@ declare namespace SystemStatusState {
|
|
|
2588
3850
|
OSS = "oss",
|
|
2589
3851
|
ENTERPRISE = "enterprise"
|
|
2590
3852
|
}
|
|
3853
|
+
enum deployment_mode {
|
|
3854
|
+
HOSTED = "hosted",
|
|
3855
|
+
SELFHOSTED = "selfhosted"
|
|
3856
|
+
}
|
|
2591
3857
|
}
|
|
2592
3858
|
|
|
2593
3859
|
type SystemStatusResponse = {
|
|
@@ -2604,6 +3870,12 @@ declare class SystemService {
|
|
|
2604
3870
|
* @throws ApiError
|
|
2605
3871
|
*/
|
|
2606
3872
|
getManagementSystemStatus(): CancelablePromise<SystemStatusResponse>;
|
|
3873
|
+
/**
|
|
3874
|
+
* Get Management System Status
|
|
3875
|
+
* @returns SystemStatusResponse Management system status
|
|
3876
|
+
* @throws ApiError
|
|
3877
|
+
*/
|
|
3878
|
+
manageGetManagementSystemStatus(): CancelablePromise<SystemStatusResponse>;
|
|
2607
3879
|
}
|
|
2608
3880
|
|
|
2609
3881
|
type AddTeamMemberRequest = {
|
|
@@ -2823,7 +4095,7 @@ declare class UsersService {
|
|
|
2823
4095
|
* @returns UserResponse User role updated successfully
|
|
2824
4096
|
* @throws ApiError
|
|
2825
4097
|
*/
|
|
2826
|
-
|
|
4098
|
+
updateUserRole(id: string, requestBody?: UpdateRoleRequest): CancelablePromise<UserResponse>;
|
|
2827
4099
|
/**
|
|
2828
4100
|
* Update User Password
|
|
2829
4101
|
* Update a user's password (Admin only)
|
|
@@ -2979,20 +4251,29 @@ declare class EnvSyncAPISDK {
|
|
|
2979
4251
|
readonly authentication: AuthenticationService;
|
|
2980
4252
|
readonly certificates: CertificatesService;
|
|
2981
4253
|
readonly changeRequests: ChangeRequestsService;
|
|
4254
|
+
readonly dynamicSecrets: DynamicSecretsService;
|
|
4255
|
+
readonly enterprise: EnterpriseService;
|
|
2982
4256
|
readonly environmentTypes: EnvironmentTypesService;
|
|
2983
4257
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
2984
4258
|
readonly environmentVariablesPointInTime: EnvironmentVariablesPointInTimeService;
|
|
2985
4259
|
readonly environmentVariablesRollback: EnvironmentVariablesRollbackService;
|
|
2986
4260
|
readonly fileUpload: FileUploadService;
|
|
2987
4261
|
readonly gpgKeys: GpgKeysService;
|
|
4262
|
+
readonly license: LicenseService;
|
|
4263
|
+
readonly logForwarding: LogForwardingService;
|
|
4264
|
+
readonly oidcProviders: OidcProvidersService;
|
|
2988
4265
|
readonly onboarding: OnboardingService;
|
|
2989
4266
|
readonly organizations: OrganizationsService;
|
|
2990
4267
|
readonly permissions: PermissionsService;
|
|
2991
4268
|
readonly roles: RolesService;
|
|
4269
|
+
readonly rotation: RotationService;
|
|
4270
|
+
readonly samlProviders: SamlProvidersService;
|
|
4271
|
+
readonly samlSso: SamlSsoService;
|
|
2992
4272
|
readonly secrets: SecretsService;
|
|
2993
4273
|
readonly secretsPointInTime: SecretsPointInTimeService;
|
|
2994
4274
|
readonly secretsRollback: SecretsRollbackService;
|
|
2995
4275
|
readonly serviceTokens: ServiceTokensService;
|
|
4276
|
+
readonly setup: SetupService;
|
|
2996
4277
|
readonly system: SystemService;
|
|
2997
4278
|
readonly teams: TeamsService;
|
|
2998
4279
|
readonly users: UsersService;
|
|
@@ -3027,4 +4308,4 @@ type UploadFileError = {
|
|
|
3027
4308
|
*/
|
|
3028
4309
|
type XEnvSyncOrgIdHeader = string;
|
|
3029
4310
|
|
|
3030
|
-
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, type AddTeamMemberRequest, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, type AssignTeamRoleRequest, AuditLogsService, AuthenticationService, type BaseCertificateResponse, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchCreateSecretsRequest, type BatchDeleteEnvsRequest, type BatchDeleteSecretsRequest, type BatchEnvsResponse, type BatchSecretsResponse, type CRLResponse, type CallbackResponse, CancelError, CancelablePromise, type CertificateListResponse, CertificatesService, type ChangeRequestListResponse, ChangeRequestResponse, ChangeRequestsService, type CheckSlugResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, type CreateEnvRequest, type CreateEnvTypeRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateRoleRequest, type CreateSecretRequest, type CreateServiceTokenRequest, type CreateServiceTokenResponse, type CreateTeamRequest, type CreateTeamResponse, type CreateUserInviteRequest, type CreateUserInviteResponse, CreateWebhookRequest, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteOrgRequest, type DeleteOrgResponse, type DeleteSecretRequest, type DeleteUserInviteResponse, type DirectChangeRequestBody, EffectiveAccessEntry, type EffectiveAccessResponse, type EffectivePermissionsResponse, type EnvDiffRequest, type EnvDiffResponse, type EnvHistoryRequest, type EnvHistoryResponse, type EnvPitRequest, type EnvPitStateResponse, type EnvResponse, EnvSyncAPISDK, type EnvTimestampRangeDiffRequest, type EnvTimestampRequest, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesPointInTimeService, EnvironmentVariablesRollbackService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, ExportEnvRequest, type ExportEnvResponse, type ExportKeyResponse, type ExtendGpgKeyExpiryRequest, FileUploadService, GenerateGpgKeyRequest, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetSecretRequest, type GetTeamResponse, type GetTeamsResponse, type GetUserInviteByTokenResponse, type GpgKeyDetailResponse, type GpgKeyResponse, type GpgKeysResponse, GpgKeysService, GrantAccessRequest, GrantEntry, type GrantsListResponse, type ImportGpgKeyRequest, type InitOrgCARequest, type IssueMemberCertRequest, LicenseState, type LicenseStatusResponse, type LoginUrlResponse, type LogoutUrlResponse, type MemberCertResponse, type MyCertificateBundleResponse, type OCSPResponse, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgCAResponse, type OrgResponse, OrganizationsService, type PermissionMessageResponse, PermissionsService, type PromotionChangeRequestBody, type RegenerateApiKeyResponse, type RejectChangeRequestBody, type RenewCertRequest, type RevealSecretsRequest, type RevealSecretsResponse, RevokeAccessRequest, type RevokeCertRequest, type RevokeCertResponse, type RevokeGpgKeyRequest, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type RollbackResponse, type RollbackSecretsResponse, type RollbackSecretsToPitRequest, type RollbackSecretsToTimestampRequest, type RollbackToPitRequest, type RollbackToTimestampRequest, type RootCAResponse, type RotateCertRequest, RotateGpgKeyRequest, type SecretDiffRequest, type SecretDiffResponse, type SecretHistoryRequest, type SecretHistoryResponse, type SecretPitRequest, type SecretPitStateResponse, type SecretResponse, type SecretTimestampRangeDiffRequest, type SecretTimestampRequest, SecretVariableRollbackResponse, type SecretVariableRollbackToPitRequest, type SecretVariableRollbackToTimestampRequest, type SecretVariableTimelineRequest, type SecretVariableTimelineResponse, SecretsPointInTimeService, type SecretsResponse, SecretsRollbackService, SecretsService, type ServiceTokenPermissions, type ServiceTokenResponse, type ServiceTokensResponse, ServiceTokensService, SignDataRequest, type SignatureResponse, SystemService, type SystemStatusResponse, SystemStatusState, type TeamMessageResponse, TeamsService, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateEnvRequest, type UpdateEnvTypeRequest, type UpdateOrgRequest, type UpdateRoleRequest, type UpdateSecretRequest, type UpdateTeamRequest, UpdateTrustLevelRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, UpdateWebhookRequest, type UploadFileError, type UploadFileResponse, type UserResponse, type UsersResponse, UsersService, VariableRollbackResponse, type VariableRollbackToPitRequest, type VariableRollbackToTimestampRequest, type VariableTimelineRequest, type VariableTimelineResponse, type VerifyResponse, type VerifySignatureRequest, WebhookResponse, type WebhooksResponse, WebhooksService, type WhoAmIResponse, type XEnvSyncOrgIdHeader };
|
|
4311
|
+
export { type AcceptOrgInviteRequest, type AcceptOrgInviteResponse, type AcceptUserInviteRequest, type AcceptUserInviteResponse, AccessService, type AddTeamMemberRequest, ApiError, type ApiKeyResponse, type ApiKeysResponse, ApiKeysService, ApplicationsService, type AssignTeamRoleRequest, AuditLogsService, AuthenticationService, type BaseCertificateResponse, BaseHttpRequest, type BatchCreateEnvsRequest, type BatchCreateSecretsRequest, type BatchDeleteEnvsRequest, type BatchDeleteSecretsRequest, type BatchEnvsResponse, type BatchSecretsResponse, type CRLResponse, type CallbackResponse, CancelError, CancelablePromise, type CertificateListResponse, CertificatesService, type ChangeRequestListResponse, ChangeRequestResponse, ChangeRequestsService, type CheckSlugResponse, type CleanupResponse, type CreateApiKeyRequest, type CreateAppRequest, type CreateAppResponse, CreateDynamicSecretEngineRequest, type CreateDynamicSecretLeaseRequest, type CreateEnvRequest, type CreateEnvTypeMappingRequest, type CreateEnvTypeRequest, CreateIntegrationBindingRequest, CreateLogForwardingRequest, CreateManualSyncRunRequest, CreateOidcProviderRequest, type CreateOrgInviteRequest, type CreateOrgInviteResponse, type CreateOrgSecretRequest, CreateProviderConnectionRequest, type CreateRoleRequest, CreateRotationPolicyRequest, CreateSamlProviderRequest, type CreateSecretRequest, type CreateServiceTokenRequest, type CreateServiceTokenResponse, type CreateSetupOrgRequest, type CreateTeamRequest, type CreateTeamResponse, type CreateUserInviteRequest, type CreateUserInviteResponse, CreateWebhookRequest, type DeleteAppResponse, type DeleteEnvRequest, type DeleteEnvTypeRequest, type DeleteOrgRequest, type DeleteOrgResponse, type DeleteSecretRequest, type DeleteUserInviteResponse, type DirectChangeRequestBody, DynamicSecretEngineResponse, type DynamicSecretEnginesResponse, type DynamicSecretLeaseResponse, type DynamicSecretLeasesResponse, DynamicSecretsService, EffectiveAccessEntry, type EffectiveAccessResponse, type EffectivePermissionsResponse, EnterpriseProviderProfile, type EnterpriseProvidersResponse, EnterpriseService, type EnvDiffRequest, type EnvDiffResponse, type EnvHistoryRequest, type EnvHistoryResponse, type EnvPitRequest, type EnvPitStateResponse, type EnvResponse, EnvSyncAPISDK, type EnvTimestampRangeDiffRequest, type EnvTimestampRequest, type EnvTypeMapping, type EnvTypeMappingsResponse, type EnvTypeResponse, type EnvTypesResponse, EnvironmentTypesService, EnvironmentVariablesPointInTimeService, EnvironmentVariablesRollbackService, EnvironmentVariablesService, type EnvsResponse, type ErrorResponse, ExportEnvRequest, type ExportEnvResponse, type ExportKeyResponse, type ExtendGpgKeyExpiryRequest, FileUploadService, GenerateGpgKeyRequest, type GetAppResponse, type GetAppsResponse, type GetAuditLogsResponse, type GetAuditLogsResponseWrapper, type GetEnvRequest, type GetOrgInviteByCodeResponse, type GetSecretRequest, type GetTeamResponse, type GetTeamsResponse, type GetUserInviteByTokenResponse, type GpgKeyDetailResponse, type GpgKeyResponse, type GpgKeysResponse, GpgKeysService, GrantAccessRequest, GrantEntry, type GrantsListResponse, type ImportGpgKeyRequest, type InitOrgCARequest, IntegrationBinding, type IntegrationBindingsResponse, type IssueMemberCertRequest, type LicenseActionResponse, LicenseService, LicenseState, type LicenseStatusResponse, LogForwardingResponse, LogForwardingService, type LogForwardingsResponse, type LoginUrlResponse, type LogoutUrlResponse, type MemberCertResponse, type MyCertificateBundleResponse, type OCSPResponse, OidcProviderResponse, type OidcProvidersResponse, OidcProvidersService, OnboardingService, OpenAPI, type OpenAPIConfig, type OrgCAResponse, type OrgResponse, type OrgSecret, type OrgSecretModelResponse, type OrgSecretsResponse, OrganizationsService, type PermissionMessageResponse, PermissionsService, type PromotionChangeRequestBody, ProviderConnection, type ProviderConnectionsResponse, type RegenerateApiKeyResponse, type RejectChangeRequestBody, type RenewCertRequest, type RevealSecretsRequest, type RevealSecretsResponse, RevokeAccessRequest, type RevokeCertRequest, type RevokeCertResponse, type RevokeGpgKeyRequest, type RevokeLeaseResponse, type RevokeOldCredentialResponse, type RoleResponse, type RoleStatsResponse, type RolesResponse, RolesService, type RollbackResponse, type RollbackSecretsResponse, type RollbackSecretsToPitRequest, type RollbackSecretsToTimestampRequest, type RollbackToPitRequest, type RollbackToTimestampRequest, type RootCAResponse, type RotateCertRequest, RotateGpgKeyRequest, type RotationPoliciesResponse, RotationPolicyResponse, RotationService, type RotationStateResponse, type RotationStatesResponse, SamlProviderResponse, type SamlProvidersResponse, SamlProvidersService, type SamlSsoRequest, type SamlSsoResponse, SamlSsoService, type SecretDiffRequest, type SecretDiffResponse, type SecretHistoryRequest, type SecretHistoryResponse, type SecretPitRequest, type SecretPitStateResponse, type SecretResponse, type SecretTimestampRangeDiffRequest, type SecretTimestampRequest, SecretVariableRollbackResponse, type SecretVariableRollbackToPitRequest, type SecretVariableRollbackToTimestampRequest, type SecretVariableTimelineRequest, type SecretVariableTimelineResponse, SecretsPointInTimeService, type SecretsResponse, SecretsRollbackService, SecretsService, type ServiceTokenPermissions, type ServiceTokenResponse, type ServiceTokensResponse, ServiceTokensService, SetupService, SetupStatusResponse, SignDataRequest, type SignatureResponse, SyncAuditEvent, type SyncAuditEventsResponse, SyncRun, type SyncRunsResponse, SystemService, type SystemStatusResponse, SystemStatusState, type TeamMessageResponse, TeamsService, type TriggerRotationResponse, type UpdateApiKeyRequest, type UpdateAppRequest, type UpdateAppResponse, type UpdateDynamicSecretEngineRequest, type UpdateEnvRequest, type UpdateEnvTypeMappingRequest, type UpdateEnvTypeRequest, type UpdateIntegrationBindingRequest, type UpdateOidcProviderRequest, type UpdateOrgRequest, type UpdateOrgSecretRequest, UpdateProviderConnectionRequest, type UpdateRoleRequest, type UpdateRotationPolicyRequest, type UpdateSamlProviderRequest, type UpdateSecretRequest, type UpdateTeamRequest, UpdateTrustLevelRequest, type UpdateUserInviteRequest, type UpdateUserInviteResponse, type UpdateUserRequest, UpdateWebhookRequest, type UploadFileError, type UploadFileResponse, type UserResponse, type UsersResponse, UsersService, VariableRollbackResponse, type VariableRollbackToPitRequest, type VariableRollbackToTimestampRequest, type VariableTimelineRequest, type VariableTimelineResponse, type VerifyResponse, type VerifySignatureRequest, WebhookResponse, type WebhooksResponse, WebhooksService, type WhoAmIResponse, type XEnvSyncOrgIdHeader };
|