@envsync-cloud/envsync-ts-sdk 0.11.0 → 0.20.2
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 +1687 -85
- package/dist/index.d.ts +1687 -85
- package/dist/index.js +2663 -558
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +2625 -557
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.mts
CHANGED
|
@@ -414,7 +414,18 @@ type WhoAmIResponse = {
|
|
|
414
414
|
is_active: boolean;
|
|
415
415
|
}>;
|
|
416
416
|
active_membership_user_id: string;
|
|
417
|
-
|
|
417
|
+
features: Array<string>;
|
|
418
|
+
install_features: Array<string>;
|
|
419
|
+
auth_type: WhoAmIResponse.auth_type;
|
|
420
|
+
};
|
|
421
|
+
declare namespace WhoAmIResponse {
|
|
422
|
+
enum auth_type {
|
|
423
|
+
JWT = "jwt",
|
|
424
|
+
SAML = "saml",
|
|
425
|
+
OIDC = "oidc",
|
|
426
|
+
API_KEY = "api_key"
|
|
427
|
+
}
|
|
428
|
+
}
|
|
418
429
|
|
|
419
430
|
declare class AuthenticationService {
|
|
420
431
|
readonly httpRequest: BaseHttpRequest;
|
|
@@ -427,13 +438,13 @@ declare class AuthenticationService {
|
|
|
427
438
|
*/
|
|
428
439
|
whoami(): CancelablePromise<WhoAmIResponse>;
|
|
429
440
|
/**
|
|
430
|
-
* Create
|
|
431
|
-
* Create a new
|
|
441
|
+
* Create Organization
|
|
442
|
+
* Create a new organization for the current hosted web session and switch into it. Hosted only; self-host always 403.
|
|
432
443
|
* @param requestBody
|
|
433
|
-
* @returns WhoAmIResponse
|
|
444
|
+
* @returns WhoAmIResponse Organization created successfully
|
|
434
445
|
* @throws ApiError
|
|
435
446
|
*/
|
|
436
|
-
|
|
447
|
+
createOrganization(requestBody?: {
|
|
437
448
|
name: string;
|
|
438
449
|
}): CancelablePromise<WhoAmIResponse>;
|
|
439
450
|
/**
|
|
@@ -766,65 +777,880 @@ type RejectChangeRequestBody = {
|
|
|
766
777
|
rejection_reason: string;
|
|
767
778
|
};
|
|
768
779
|
|
|
769
|
-
declare class ChangeRequestsService {
|
|
780
|
+
declare class ChangeRequestsService {
|
|
781
|
+
readonly httpRequest: BaseHttpRequest;
|
|
782
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
783
|
+
/**
|
|
784
|
+
* Create Direct Change Request
|
|
785
|
+
* Create a protected-environment change request with explicit env and secret changes.
|
|
786
|
+
* @param requestBody
|
|
787
|
+
* @returns ChangeRequestResponse Direct change request created
|
|
788
|
+
* @throws ApiError
|
|
789
|
+
*/
|
|
790
|
+
createDirectChangeRequest(requestBody?: DirectChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
791
|
+
/**
|
|
792
|
+
* Create Promotion Change Request
|
|
793
|
+
* Create a promotion request from one app environment to another protected environment.
|
|
794
|
+
* @param requestBody
|
|
795
|
+
* @returns ChangeRequestResponse Promotion change request created
|
|
796
|
+
* @throws ApiError
|
|
797
|
+
*/
|
|
798
|
+
createPromotionChangeRequest(requestBody?: PromotionChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
799
|
+
/**
|
|
800
|
+
* List Change Requests
|
|
801
|
+
* List change requests for the current organization.
|
|
802
|
+
* @returns ChangeRequestListResponse Change requests listed
|
|
803
|
+
* @throws ApiError
|
|
804
|
+
*/
|
|
805
|
+
listChangeRequests(): CancelablePromise<ChangeRequestListResponse>;
|
|
806
|
+
/**
|
|
807
|
+
* Get Change Request
|
|
808
|
+
* Fetch a single change request including env and secret item diffs.
|
|
809
|
+
* @param id
|
|
810
|
+
* @returns ChangeRequestResponse Change request fetched
|
|
811
|
+
* @throws ApiError
|
|
812
|
+
*/
|
|
813
|
+
getChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
814
|
+
/**
|
|
815
|
+
* Approve Change Request
|
|
816
|
+
* Approve a pending change request and apply it atomically to the target environment.
|
|
817
|
+
* @param id
|
|
818
|
+
* @returns ChangeRequestResponse Change request approved and applied
|
|
819
|
+
* @throws ApiError
|
|
820
|
+
*/
|
|
821
|
+
approveChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
822
|
+
/**
|
|
823
|
+
* Reject Change Request
|
|
824
|
+
* Reject a pending change request without mutating the target environment.
|
|
825
|
+
* @param id
|
|
826
|
+
* @param requestBody
|
|
827
|
+
* @returns ChangeRequestResponse Change request rejected
|
|
828
|
+
* @throws ApiError
|
|
829
|
+
*/
|
|
830
|
+
rejectChangeRequest(id: string, requestBody?: RejectChangeRequestBody): CancelablePromise<ChangeRequestResponse>;
|
|
831
|
+
/**
|
|
832
|
+
* Cancel Change Request
|
|
833
|
+
* Cancel a pending change request created by the current user.
|
|
834
|
+
* @param id
|
|
835
|
+
* @returns ChangeRequestResponse Change request cancelled
|
|
836
|
+
* @throws ApiError
|
|
837
|
+
*/
|
|
838
|
+
cancelChangeRequest(id: string): CancelablePromise<ChangeRequestResponse>;
|
|
839
|
+
}
|
|
840
|
+
|
|
841
|
+
type CleanupResponse = {
|
|
842
|
+
cleaned: number;
|
|
843
|
+
};
|
|
844
|
+
|
|
845
|
+
type CreateDynamicSecretEngineRequest = {
|
|
846
|
+
engine_type: CreateDynamicSecretEngineRequest.engine_type;
|
|
847
|
+
name: string;
|
|
848
|
+
config: ({
|
|
849
|
+
host: string;
|
|
850
|
+
port?: number;
|
|
851
|
+
database: string;
|
|
852
|
+
superuser: {
|
|
853
|
+
username: string;
|
|
854
|
+
password: string;
|
|
855
|
+
};
|
|
856
|
+
creation_statements?: Array<string>;
|
|
857
|
+
default_ttl_seconds?: number;
|
|
858
|
+
max_ttl_seconds?: number;
|
|
859
|
+
} | {
|
|
860
|
+
access_key_id: string;
|
|
861
|
+
secret_access_key: string;
|
|
862
|
+
region?: string;
|
|
863
|
+
iam_policy: string;
|
|
864
|
+
default_ttl_seconds?: number;
|
|
865
|
+
max_ttl_seconds?: number;
|
|
866
|
+
} | {
|
|
867
|
+
tenant_id: string;
|
|
868
|
+
client_id: string;
|
|
869
|
+
client_secret: string;
|
|
870
|
+
subscription_id: string;
|
|
871
|
+
roles?: Array<string>;
|
|
872
|
+
default_ttl_seconds?: number;
|
|
873
|
+
max_ttl_seconds?: number;
|
|
874
|
+
});
|
|
875
|
+
enabled?: boolean;
|
|
876
|
+
};
|
|
877
|
+
declare namespace CreateDynamicSecretEngineRequest {
|
|
878
|
+
enum engine_type {
|
|
879
|
+
POSTGRES = "postgres",
|
|
880
|
+
MYSQL = "mysql",
|
|
881
|
+
AWS_IAM = "aws-iam",
|
|
882
|
+
AZURE_SP = "azure-sp"
|
|
883
|
+
}
|
|
884
|
+
}
|
|
885
|
+
|
|
886
|
+
type CreateDynamicSecretLeaseRequest = {
|
|
887
|
+
app_id: string;
|
|
888
|
+
env_type_id: string;
|
|
889
|
+
variable_key: string;
|
|
890
|
+
ttl_seconds?: number;
|
|
891
|
+
};
|
|
892
|
+
|
|
893
|
+
type DynamicSecretEngineResponse = {
|
|
894
|
+
id: string;
|
|
895
|
+
org_id: string;
|
|
896
|
+
engine_type: DynamicSecretEngineResponse.engine_type;
|
|
897
|
+
name: string;
|
|
898
|
+
config: Record<string, any>;
|
|
899
|
+
enabled: boolean;
|
|
900
|
+
created_at: string;
|
|
901
|
+
updated_at: string;
|
|
902
|
+
};
|
|
903
|
+
declare namespace DynamicSecretEngineResponse {
|
|
904
|
+
enum engine_type {
|
|
905
|
+
POSTGRES = "postgres",
|
|
906
|
+
MYSQL = "mysql",
|
|
907
|
+
AWS_IAM = "aws-iam",
|
|
908
|
+
AZURE_SP = "azure-sp"
|
|
909
|
+
}
|
|
910
|
+
}
|
|
911
|
+
|
|
912
|
+
type DynamicSecretEnginesResponse = Array<DynamicSecretEngineResponse>;
|
|
913
|
+
|
|
914
|
+
type DynamicSecretLeaseResponse = {
|
|
915
|
+
id: string;
|
|
916
|
+
engine_id: string;
|
|
917
|
+
app_id: string;
|
|
918
|
+
env_type_id: string;
|
|
919
|
+
variable_key: string;
|
|
920
|
+
credential_data: Record<string, any>;
|
|
921
|
+
expires_at: string;
|
|
922
|
+
revoked_at: string | null;
|
|
923
|
+
created_at: string;
|
|
924
|
+
updated_at: string;
|
|
925
|
+
};
|
|
926
|
+
|
|
927
|
+
type DynamicSecretLeasesResponse = Array<DynamicSecretLeaseResponse>;
|
|
928
|
+
|
|
929
|
+
type ErrorResponse = {
|
|
930
|
+
error: string;
|
|
931
|
+
};
|
|
932
|
+
|
|
933
|
+
type RevokeLeaseResponse = {
|
|
934
|
+
message: string;
|
|
935
|
+
id: string;
|
|
936
|
+
};
|
|
937
|
+
|
|
938
|
+
type UpdateDynamicSecretEngineRequest = {
|
|
939
|
+
name?: string;
|
|
940
|
+
config?: ({
|
|
941
|
+
host: string;
|
|
942
|
+
port?: number;
|
|
943
|
+
database: string;
|
|
944
|
+
superuser: {
|
|
945
|
+
username: string;
|
|
946
|
+
password: string;
|
|
947
|
+
};
|
|
948
|
+
creation_statements?: Array<string>;
|
|
949
|
+
default_ttl_seconds?: number;
|
|
950
|
+
max_ttl_seconds?: number;
|
|
951
|
+
} | {
|
|
952
|
+
access_key_id: string;
|
|
953
|
+
secret_access_key: string;
|
|
954
|
+
region?: string;
|
|
955
|
+
iam_policy: string;
|
|
956
|
+
default_ttl_seconds?: number;
|
|
957
|
+
max_ttl_seconds?: number;
|
|
958
|
+
} | {
|
|
959
|
+
tenant_id: string;
|
|
960
|
+
client_id: string;
|
|
961
|
+
client_secret: string;
|
|
962
|
+
subscription_id: string;
|
|
963
|
+
roles?: Array<string>;
|
|
964
|
+
default_ttl_seconds?: number;
|
|
965
|
+
max_ttl_seconds?: number;
|
|
966
|
+
});
|
|
967
|
+
enabled?: boolean;
|
|
968
|
+
};
|
|
969
|
+
|
|
970
|
+
declare class DynamicSecretsService {
|
|
971
|
+
readonly httpRequest: BaseHttpRequest;
|
|
972
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
973
|
+
/**
|
|
974
|
+
* Create Dynamic Secret Engine
|
|
975
|
+
* Create a new dynamic secret engine for short-lived credential generation
|
|
976
|
+
* @param requestBody
|
|
977
|
+
* @returns DynamicSecretEngineResponse Engine created successfully
|
|
978
|
+
* @throws ApiError
|
|
979
|
+
*/
|
|
980
|
+
createDynamicSecretEngine(requestBody?: CreateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
981
|
+
/**
|
|
982
|
+
* Get All Dynamic Secret Engines
|
|
983
|
+
* Retrieve all dynamic secret engines for the organization
|
|
984
|
+
* @returns DynamicSecretEnginesResponse Engines retrieved successfully
|
|
985
|
+
* @throws ApiError
|
|
986
|
+
*/
|
|
987
|
+
getAllDynamicSecretEngines(): CancelablePromise<DynamicSecretEnginesResponse>;
|
|
988
|
+
/**
|
|
989
|
+
* Get Dynamic Secret Engine
|
|
990
|
+
* Retrieve a specific dynamic secret engine by ID
|
|
991
|
+
* @param id
|
|
992
|
+
* @returns DynamicSecretEngineResponse Engine retrieved successfully
|
|
993
|
+
* @throws ApiError
|
|
994
|
+
*/
|
|
995
|
+
getDynamicSecretEngine(id: string): CancelablePromise<DynamicSecretEngineResponse>;
|
|
996
|
+
/**
|
|
997
|
+
* Update Dynamic Secret Engine
|
|
998
|
+
* Update an existing dynamic secret engine
|
|
999
|
+
* @param id
|
|
1000
|
+
* @param requestBody
|
|
1001
|
+
* @returns DynamicSecretEngineResponse Engine updated successfully
|
|
1002
|
+
* @throws ApiError
|
|
1003
|
+
*/
|
|
1004
|
+
updateDynamicSecretEngine(id: string, requestBody?: UpdateDynamicSecretEngineRequest): CancelablePromise<DynamicSecretEngineResponse>;
|
|
1005
|
+
/**
|
|
1006
|
+
* Delete Dynamic Secret Engine
|
|
1007
|
+
* Delete a dynamic secret engine (must have no active leases)
|
|
1008
|
+
* @param id
|
|
1009
|
+
* @returns ErrorResponse Engine deleted successfully
|
|
1010
|
+
* @throws ApiError
|
|
1011
|
+
*/
|
|
1012
|
+
deleteDynamicSecretEngine(id: string): CancelablePromise<ErrorResponse>;
|
|
1013
|
+
/**
|
|
1014
|
+
* Create Dynamic Secret Lease
|
|
1015
|
+
* Generate short-lived credentials by creating a lease on an engine
|
|
1016
|
+
* @param id
|
|
1017
|
+
* @param requestBody
|
|
1018
|
+
* @returns DynamicSecretLeaseResponse Lease created successfully
|
|
1019
|
+
* @throws ApiError
|
|
1020
|
+
*/
|
|
1021
|
+
createDynamicSecretLease(id: string, requestBody?: CreateDynamicSecretLeaseRequest): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
1022
|
+
/**
|
|
1023
|
+
* Get Leases for Engine
|
|
1024
|
+
* Retrieve all leases for a specific dynamic secret engine
|
|
1025
|
+
* @param id
|
|
1026
|
+
* @returns DynamicSecretLeasesResponse Leases retrieved successfully
|
|
1027
|
+
* @throws ApiError
|
|
1028
|
+
*/
|
|
1029
|
+
getDynamicSecretLeases(id: string): CancelablePromise<DynamicSecretLeasesResponse>;
|
|
1030
|
+
/**
|
|
1031
|
+
* Get Dynamic Secret Lease
|
|
1032
|
+
* Retrieve a specific lease by ID
|
|
1033
|
+
* @param leaseId
|
|
1034
|
+
* @returns DynamicSecretLeaseResponse Lease retrieved successfully
|
|
1035
|
+
* @throws ApiError
|
|
1036
|
+
*/
|
|
1037
|
+
getDynamicSecretLease(leaseId: string): CancelablePromise<DynamicSecretLeaseResponse>;
|
|
1038
|
+
/**
|
|
1039
|
+
* Revoke Dynamic Secret Lease
|
|
1040
|
+
* Revoke a lease and its associated credentials
|
|
1041
|
+
* @param leaseId
|
|
1042
|
+
* @returns RevokeLeaseResponse Lease revoked successfully
|
|
1043
|
+
* @throws ApiError
|
|
1044
|
+
*/
|
|
1045
|
+
revokeDynamicSecretLease(leaseId: string): CancelablePromise<RevokeLeaseResponse>;
|
|
1046
|
+
/**
|
|
1047
|
+
* Cleanup Expired Leases
|
|
1048
|
+
* Mark all expired leases as revoked (admin operation)
|
|
1049
|
+
* @returns CleanupResponse Cleanup completed
|
|
1050
|
+
* @throws ApiError
|
|
1051
|
+
*/
|
|
1052
|
+
cleanupExpiredLeases(): CancelablePromise<CleanupResponse>;
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
type CreateEnvTypeMappingRequest = {
|
|
1056
|
+
env_type_id: string;
|
|
1057
|
+
integration_binding_id: string;
|
|
1058
|
+
target_identifier: string;
|
|
1059
|
+
branch_ref?: string | null;
|
|
1060
|
+
path_prefix?: string | null;
|
|
1061
|
+
metadata?: Record<string, any>;
|
|
1062
|
+
};
|
|
1063
|
+
|
|
1064
|
+
type CreateIntegrationBindingRequest = {
|
|
1065
|
+
provider_connection_id: string;
|
|
1066
|
+
provider_type: CreateIntegrationBindingRequest.provider_type;
|
|
1067
|
+
is_enabled?: boolean;
|
|
1068
|
+
metadata?: Record<string, any>;
|
|
1069
|
+
};
|
|
1070
|
+
declare namespace CreateIntegrationBindingRequest {
|
|
1071
|
+
enum provider_type {
|
|
1072
|
+
GITHUB = "github",
|
|
1073
|
+
GITLAB = "gitlab",
|
|
1074
|
+
AWS_SSM = "aws-ssm",
|
|
1075
|
+
VERCEL = "vercel",
|
|
1076
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1077
|
+
}
|
|
1078
|
+
}
|
|
1079
|
+
|
|
1080
|
+
type CreateManualSyncRunRequest = {
|
|
1081
|
+
app_id?: string | null;
|
|
1082
|
+
provider_type: CreateManualSyncRunRequest.provider_type;
|
|
1083
|
+
metadata?: Record<string, any>;
|
|
1084
|
+
};
|
|
1085
|
+
declare namespace CreateManualSyncRunRequest {
|
|
1086
|
+
enum provider_type {
|
|
1087
|
+
GITHUB = "github",
|
|
1088
|
+
GITLAB = "gitlab",
|
|
1089
|
+
AWS_SSM = "aws-ssm",
|
|
1090
|
+
VERCEL = "vercel",
|
|
1091
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1092
|
+
}
|
|
1093
|
+
}
|
|
1094
|
+
|
|
1095
|
+
type CreateOrgSecretRequest = {
|
|
1096
|
+
key: string;
|
|
1097
|
+
value: string;
|
|
1098
|
+
description?: string | null;
|
|
1099
|
+
metadata?: Record<string, any>;
|
|
1100
|
+
};
|
|
1101
|
+
|
|
1102
|
+
type CreateProviderConnectionRequest = {
|
|
1103
|
+
provider_type: CreateProviderConnectionRequest.provider_type;
|
|
1104
|
+
name: string;
|
|
1105
|
+
status?: CreateProviderConnectionRequest.status;
|
|
1106
|
+
auth_config?: Record<string, any>;
|
|
1107
|
+
metadata?: Record<string, any>;
|
|
1108
|
+
};
|
|
1109
|
+
declare namespace CreateProviderConnectionRequest {
|
|
1110
|
+
enum provider_type {
|
|
1111
|
+
GITHUB = "github",
|
|
1112
|
+
GITLAB = "gitlab",
|
|
1113
|
+
AWS_SSM = "aws-ssm",
|
|
1114
|
+
VERCEL = "vercel",
|
|
1115
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1116
|
+
}
|
|
1117
|
+
enum status {
|
|
1118
|
+
ACTIVE = "active",
|
|
1119
|
+
INACTIVE = "inactive",
|
|
1120
|
+
ERROR = "error"
|
|
1121
|
+
}
|
|
1122
|
+
}
|
|
1123
|
+
|
|
1124
|
+
type EnterpriseProviderProfile = {
|
|
1125
|
+
id: EnterpriseProviderProfile.id;
|
|
1126
|
+
name: string;
|
|
1127
|
+
scope: string;
|
|
1128
|
+
description: string;
|
|
1129
|
+
connection_requirements: Array<string>;
|
|
1130
|
+
binding_metadata_fields: Array<string>;
|
|
1131
|
+
mapping_requirements: Array<string>;
|
|
1132
|
+
};
|
|
1133
|
+
declare namespace EnterpriseProviderProfile {
|
|
1134
|
+
enum id {
|
|
1135
|
+
GITHUB = "github",
|
|
1136
|
+
GITLAB = "gitlab",
|
|
1137
|
+
AWS_SSM = "aws-ssm",
|
|
1138
|
+
VERCEL = "vercel",
|
|
1139
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1140
|
+
}
|
|
1141
|
+
}
|
|
1142
|
+
|
|
1143
|
+
type EnterpriseProvidersResponse = {
|
|
1144
|
+
providers: Array<EnterpriseProviderProfile>;
|
|
1145
|
+
};
|
|
1146
|
+
|
|
1147
|
+
type EnvTypeMapping = {
|
|
1148
|
+
id: string;
|
|
1149
|
+
org_id: string;
|
|
1150
|
+
app_id: string;
|
|
1151
|
+
env_type_id: string;
|
|
1152
|
+
integration_binding_id: string;
|
|
1153
|
+
target_identifier: string;
|
|
1154
|
+
branch_ref?: string | null;
|
|
1155
|
+
path_prefix?: string | null;
|
|
1156
|
+
metadata: Record<string, any>;
|
|
1157
|
+
created_at: string;
|
|
1158
|
+
updated_at: string;
|
|
1159
|
+
};
|
|
1160
|
+
|
|
1161
|
+
type EnvTypeMappingsResponse = Array<EnvTypeMapping>;
|
|
1162
|
+
|
|
1163
|
+
type IntegrationBinding = {
|
|
1164
|
+
id: string;
|
|
1165
|
+
org_id: string;
|
|
1166
|
+
app_id: string;
|
|
1167
|
+
provider_connection_id: string;
|
|
1168
|
+
provider_type: IntegrationBinding.provider_type;
|
|
1169
|
+
is_enabled: boolean;
|
|
1170
|
+
metadata: Record<string, any>;
|
|
1171
|
+
created_at: string;
|
|
1172
|
+
updated_at: string;
|
|
1173
|
+
};
|
|
1174
|
+
declare namespace IntegrationBinding {
|
|
1175
|
+
enum provider_type {
|
|
1176
|
+
GITHUB = "github",
|
|
1177
|
+
GITLAB = "gitlab",
|
|
1178
|
+
AWS_SSM = "aws-ssm",
|
|
1179
|
+
VERCEL = "vercel",
|
|
1180
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1181
|
+
}
|
|
1182
|
+
}
|
|
1183
|
+
|
|
1184
|
+
type IntegrationBindingsResponse = Array<IntegrationBinding>;
|
|
1185
|
+
|
|
1186
|
+
type OrgSecret = {
|
|
1187
|
+
id: string;
|
|
1188
|
+
org_id: string;
|
|
1189
|
+
key: string;
|
|
1190
|
+
value: string;
|
|
1191
|
+
description?: string | null;
|
|
1192
|
+
metadata: Record<string, any>;
|
|
1193
|
+
created_at: string;
|
|
1194
|
+
updated_at: string;
|
|
1195
|
+
};
|
|
1196
|
+
|
|
1197
|
+
type OrgSecretModelResponse = {
|
|
1198
|
+
resource: string;
|
|
1199
|
+
description: string;
|
|
1200
|
+
fields: Array<string>;
|
|
1201
|
+
};
|
|
1202
|
+
|
|
1203
|
+
type OrgSecretsResponse = Array<OrgSecret>;
|
|
1204
|
+
|
|
1205
|
+
type ProviderConnection = {
|
|
1206
|
+
id: string;
|
|
1207
|
+
org_id: string;
|
|
1208
|
+
provider_type: ProviderConnection.provider_type;
|
|
1209
|
+
name: string;
|
|
1210
|
+
status: ProviderConnection.status;
|
|
1211
|
+
auth_config: Record<string, any>;
|
|
1212
|
+
metadata: Record<string, any>;
|
|
1213
|
+
created_at: string;
|
|
1214
|
+
updated_at: string;
|
|
1215
|
+
};
|
|
1216
|
+
declare namespace ProviderConnection {
|
|
1217
|
+
enum provider_type {
|
|
1218
|
+
GITHUB = "github",
|
|
1219
|
+
GITLAB = "gitlab",
|
|
1220
|
+
AWS_SSM = "aws-ssm",
|
|
1221
|
+
VERCEL = "vercel",
|
|
1222
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1223
|
+
}
|
|
1224
|
+
enum status {
|
|
1225
|
+
ACTIVE = "active",
|
|
1226
|
+
INACTIVE = "inactive",
|
|
1227
|
+
ERROR = "error"
|
|
1228
|
+
}
|
|
1229
|
+
}
|
|
1230
|
+
|
|
1231
|
+
type ProviderConnectionsResponse = Array<ProviderConnection>;
|
|
1232
|
+
|
|
1233
|
+
type SyncAuditEvent = {
|
|
1234
|
+
id: string;
|
|
1235
|
+
org_id: string;
|
|
1236
|
+
sync_run_id?: string | null;
|
|
1237
|
+
app_id?: string | null;
|
|
1238
|
+
env_type_id?: string | null;
|
|
1239
|
+
provider_type: SyncAuditEvent.provider_type;
|
|
1240
|
+
action: string;
|
|
1241
|
+
result: SyncAuditEvent.result;
|
|
1242
|
+
actor_user_id?: string | null;
|
|
1243
|
+
details: Record<string, any>;
|
|
1244
|
+
created_at: string;
|
|
1245
|
+
updated_at: string;
|
|
1246
|
+
};
|
|
1247
|
+
declare namespace SyncAuditEvent {
|
|
1248
|
+
enum provider_type {
|
|
1249
|
+
GITHUB = "github",
|
|
1250
|
+
GITLAB = "gitlab",
|
|
1251
|
+
AWS_SSM = "aws-ssm",
|
|
1252
|
+
VERCEL = "vercel",
|
|
1253
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1254
|
+
}
|
|
1255
|
+
enum result {
|
|
1256
|
+
INFO = "info",
|
|
1257
|
+
SUCCESS = "success",
|
|
1258
|
+
ERROR = "error"
|
|
1259
|
+
}
|
|
1260
|
+
}
|
|
1261
|
+
|
|
1262
|
+
type SyncAuditEventsResponse = Array<SyncAuditEvent>;
|
|
1263
|
+
|
|
1264
|
+
type SyncRun = {
|
|
1265
|
+
id: string;
|
|
1266
|
+
org_id: string;
|
|
1267
|
+
app_id?: string | null;
|
|
1268
|
+
provider_type: SyncRun.provider_type;
|
|
1269
|
+
status: SyncRun.status;
|
|
1270
|
+
actor_user_id?: string | null;
|
|
1271
|
+
started_at: string;
|
|
1272
|
+
completed_at?: string | null;
|
|
1273
|
+
error_message?: string | null;
|
|
1274
|
+
metadata: Record<string, any>;
|
|
1275
|
+
created_at: string;
|
|
1276
|
+
updated_at: string;
|
|
1277
|
+
};
|
|
1278
|
+
declare namespace SyncRun {
|
|
1279
|
+
enum provider_type {
|
|
1280
|
+
GITHUB = "github",
|
|
1281
|
+
GITLAB = "gitlab",
|
|
1282
|
+
AWS_SSM = "aws-ssm",
|
|
1283
|
+
VERCEL = "vercel",
|
|
1284
|
+
GOOGLE_SECRET_MANAGER = "google-secret-manager"
|
|
1285
|
+
}
|
|
1286
|
+
enum status {
|
|
1287
|
+
PENDING = "pending",
|
|
1288
|
+
RUNNING = "running",
|
|
1289
|
+
SUCCEEDED = "succeeded",
|
|
1290
|
+
FAILED = "failed"
|
|
1291
|
+
}
|
|
1292
|
+
}
|
|
1293
|
+
|
|
1294
|
+
type SyncRunsResponse = Array<SyncRun>;
|
|
1295
|
+
|
|
1296
|
+
type UpdateEnvTypeMappingRequest = {
|
|
1297
|
+
target_identifier?: string;
|
|
1298
|
+
branch_ref?: string | null;
|
|
1299
|
+
path_prefix?: string | null;
|
|
1300
|
+
metadata?: Record<string, any>;
|
|
1301
|
+
};
|
|
1302
|
+
|
|
1303
|
+
type UpdateIntegrationBindingRequest = {
|
|
1304
|
+
is_enabled?: boolean;
|
|
1305
|
+
metadata?: Record<string, any>;
|
|
1306
|
+
};
|
|
1307
|
+
|
|
1308
|
+
type UpdateOrgSecretRequest = {
|
|
1309
|
+
value?: string;
|
|
1310
|
+
description?: string | null;
|
|
1311
|
+
metadata?: Record<string, any>;
|
|
1312
|
+
};
|
|
1313
|
+
|
|
1314
|
+
type UpdateProviderConnectionRequest = {
|
|
1315
|
+
name?: string;
|
|
1316
|
+
status?: UpdateProviderConnectionRequest.status;
|
|
1317
|
+
auth_config?: Record<string, any>;
|
|
1318
|
+
metadata?: Record<string, any>;
|
|
1319
|
+
};
|
|
1320
|
+
declare namespace UpdateProviderConnectionRequest {
|
|
1321
|
+
enum status {
|
|
1322
|
+
ACTIVE = "active",
|
|
1323
|
+
INACTIVE = "inactive",
|
|
1324
|
+
ERROR = "error"
|
|
1325
|
+
}
|
|
1326
|
+
}
|
|
1327
|
+
|
|
1328
|
+
declare class EnterpriseService {
|
|
1329
|
+
readonly httpRequest: BaseHttpRequest;
|
|
1330
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
1331
|
+
/**
|
|
1332
|
+
* List Enterprise Providers
|
|
1333
|
+
* @returns EnterpriseProvidersResponse Enterprise provider catalog
|
|
1334
|
+
* @throws ApiError
|
|
1335
|
+
*/
|
|
1336
|
+
listEnterpriseProviders(): CancelablePromise<EnterpriseProvidersResponse>;
|
|
1337
|
+
/**
|
|
1338
|
+
* Get Enterprise Org Secret Model
|
|
1339
|
+
* @returns OrgSecretModelResponse Org secret model
|
|
1340
|
+
* @throws ApiError
|
|
1341
|
+
*/
|
|
1342
|
+
getEnterpriseOrgSecretModel(): CancelablePromise<OrgSecretModelResponse>;
|
|
1343
|
+
/**
|
|
1344
|
+
* List Enterprise Provider Connections
|
|
1345
|
+
* @returns ProviderConnectionsResponse Provider connections
|
|
1346
|
+
* @throws ApiError
|
|
1347
|
+
*/
|
|
1348
|
+
listEnterpriseProviderConnections(): CancelablePromise<ProviderConnectionsResponse>;
|
|
1349
|
+
/**
|
|
1350
|
+
* Create Enterprise Provider Connection
|
|
1351
|
+
* @param requestBody
|
|
1352
|
+
* @returns ProviderConnection Provider connection created
|
|
1353
|
+
* @throws ApiError
|
|
1354
|
+
*/
|
|
1355
|
+
createEnterpriseProviderConnection(requestBody?: CreateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
1356
|
+
/**
|
|
1357
|
+
* Update Enterprise Provider Connection
|
|
1358
|
+
* @param id
|
|
1359
|
+
* @param requestBody
|
|
1360
|
+
* @returns ProviderConnection Provider connection updated
|
|
1361
|
+
* @throws ApiError
|
|
1362
|
+
*/
|
|
1363
|
+
updateEnterpriseProviderConnection(id: string, requestBody?: UpdateProviderConnectionRequest): CancelablePromise<ProviderConnection>;
|
|
1364
|
+
/**
|
|
1365
|
+
* List Enterprise Org Secrets
|
|
1366
|
+
* @returns OrgSecretsResponse Org secrets
|
|
1367
|
+
* @throws ApiError
|
|
1368
|
+
*/
|
|
1369
|
+
listEnterpriseOrgSecrets(): CancelablePromise<OrgSecretsResponse>;
|
|
1370
|
+
/**
|
|
1371
|
+
* Create Enterprise Org Secret
|
|
1372
|
+
* @param requestBody
|
|
1373
|
+
* @returns OrgSecret Org secret created
|
|
1374
|
+
* @throws ApiError
|
|
1375
|
+
*/
|
|
1376
|
+
createEnterpriseOrgSecret(requestBody?: CreateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
1377
|
+
/**
|
|
1378
|
+
* Update Enterprise Org Secret
|
|
1379
|
+
* @param id
|
|
1380
|
+
* @param requestBody
|
|
1381
|
+
* @returns OrgSecret Org secret updated
|
|
1382
|
+
* @throws ApiError
|
|
1383
|
+
*/
|
|
1384
|
+
updateEnterpriseOrgSecret(id: string, requestBody?: UpdateOrgSecretRequest): CancelablePromise<OrgSecret>;
|
|
1385
|
+
/**
|
|
1386
|
+
* List Enterprise Integration Bindings
|
|
1387
|
+
* @param appId
|
|
1388
|
+
* @returns IntegrationBindingsResponse Integration bindings
|
|
1389
|
+
* @throws ApiError
|
|
1390
|
+
*/
|
|
1391
|
+
listEnterpriseIntegrationBindings(appId: string): CancelablePromise<IntegrationBindingsResponse>;
|
|
1392
|
+
/**
|
|
1393
|
+
* Create Enterprise Integration Binding
|
|
1394
|
+
* @param appId
|
|
1395
|
+
* @param requestBody
|
|
1396
|
+
* @returns IntegrationBinding Integration binding created
|
|
1397
|
+
* @throws ApiError
|
|
1398
|
+
*/
|
|
1399
|
+
createEnterpriseIntegrationBinding(appId: string, requestBody?: CreateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
1400
|
+
/**
|
|
1401
|
+
* Update Enterprise Integration Binding
|
|
1402
|
+
* @param appId
|
|
1403
|
+
* @param id
|
|
1404
|
+
* @param requestBody
|
|
1405
|
+
* @returns IntegrationBinding Integration binding updated
|
|
1406
|
+
* @throws ApiError
|
|
1407
|
+
*/
|
|
1408
|
+
updateEnterpriseIntegrationBinding(appId: string, id: string, requestBody?: UpdateIntegrationBindingRequest): CancelablePromise<IntegrationBinding>;
|
|
1409
|
+
/**
|
|
1410
|
+
* List Enterprise Env-Type Mappings
|
|
1411
|
+
* @param appId
|
|
1412
|
+
* @returns EnvTypeMappingsResponse Env-type mappings
|
|
1413
|
+
* @throws ApiError
|
|
1414
|
+
*/
|
|
1415
|
+
listEnterpriseEnvTypeMappings(appId: string): CancelablePromise<EnvTypeMappingsResponse>;
|
|
1416
|
+
/**
|
|
1417
|
+
* Create Enterprise Env-Type Mapping
|
|
1418
|
+
* @param appId
|
|
1419
|
+
* @param requestBody
|
|
1420
|
+
* @returns EnvTypeMapping Env-type mapping created
|
|
1421
|
+
* @throws ApiError
|
|
1422
|
+
*/
|
|
1423
|
+
createEnterpriseEnvTypeMapping(appId: string, requestBody?: CreateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
1424
|
+
/**
|
|
1425
|
+
* Update Enterprise Env-Type Mapping
|
|
1426
|
+
* @param appId
|
|
1427
|
+
* @param id
|
|
1428
|
+
* @param requestBody
|
|
1429
|
+
* @returns EnvTypeMapping Env-type mapping updated
|
|
1430
|
+
* @throws ApiError
|
|
1431
|
+
*/
|
|
1432
|
+
updateEnterpriseEnvTypeMapping(appId: string, id: string, requestBody?: UpdateEnvTypeMappingRequest): CancelablePromise<EnvTypeMapping>;
|
|
1433
|
+
/**
|
|
1434
|
+
* List Enterprise Sync Runs
|
|
1435
|
+
* @returns SyncRunsResponse Sync runs
|
|
1436
|
+
* @throws ApiError
|
|
1437
|
+
*/
|
|
1438
|
+
listEnterpriseSyncRuns(): CancelablePromise<SyncRunsResponse>;
|
|
1439
|
+
/**
|
|
1440
|
+
* Create Enterprise Manual Sync Run
|
|
1441
|
+
* @param requestBody
|
|
1442
|
+
* @returns SyncRun Sync run created
|
|
1443
|
+
* @throws ApiError
|
|
1444
|
+
*/
|
|
1445
|
+
createEnterpriseManualSyncRun(requestBody?: CreateManualSyncRunRequest): CancelablePromise<SyncRun>;
|
|
1446
|
+
/**
|
|
1447
|
+
* List Enterprise Sync Audit Events
|
|
1448
|
+
* @param syncRunId
|
|
1449
|
+
* @returns SyncAuditEventsResponse Sync audit events
|
|
1450
|
+
* @throws ApiError
|
|
1451
|
+
*/
|
|
1452
|
+
listEnterpriseSyncAuditEvents(syncRunId: string): CancelablePromise<SyncAuditEventsResponse>;
|
|
1453
|
+
}
|
|
1454
|
+
|
|
1455
|
+
type CreateOrgKmsCredentialRequest = {
|
|
1456
|
+
key: string;
|
|
1457
|
+
value: string;
|
|
1458
|
+
description?: string | null;
|
|
1459
|
+
};
|
|
1460
|
+
|
|
1461
|
+
type OrgKmsAppKeyInfo = {
|
|
1462
|
+
app_id: string;
|
|
1463
|
+
name: string;
|
|
1464
|
+
key_version_id: string | null;
|
|
1465
|
+
version: number | null;
|
|
1466
|
+
encryption_count: number | null;
|
|
1467
|
+
max_encryptions: number | null;
|
|
1468
|
+
status: string;
|
|
1469
|
+
};
|
|
1470
|
+
|
|
1471
|
+
type OrgKmsAppsResponse = {
|
|
1472
|
+
apps: Array<OrgKmsAppKeyInfo>;
|
|
1473
|
+
};
|
|
1474
|
+
|
|
1475
|
+
type OrgKmsCredentialResponse = {
|
|
1476
|
+
id: string;
|
|
1477
|
+
org_id: string;
|
|
1478
|
+
key: string;
|
|
1479
|
+
description: string | null;
|
|
1480
|
+
configured: boolean;
|
|
1481
|
+
created_at: string;
|
|
1482
|
+
updated_at: string;
|
|
1483
|
+
};
|
|
1484
|
+
|
|
1485
|
+
type OrgKmsConfigResponse = {
|
|
1486
|
+
org_id: string;
|
|
1487
|
+
source: OrgKmsConfigResponse.source;
|
|
1488
|
+
status: OrgKmsConfigResponse.status;
|
|
1489
|
+
key_ref: string | null;
|
|
1490
|
+
region: string | null;
|
|
1491
|
+
credential_secret_id: string | null;
|
|
1492
|
+
kek_version: number;
|
|
1493
|
+
last_verified_at: string | null;
|
|
1494
|
+
last_error: string | null;
|
|
1495
|
+
implicit: boolean;
|
|
1496
|
+
credentials?: Array<OrgKmsCredentialResponse>;
|
|
1497
|
+
};
|
|
1498
|
+
declare namespace OrgKmsConfigResponse {
|
|
1499
|
+
enum source {
|
|
1500
|
+
MANAGED = "managed",
|
|
1501
|
+
AWS_KMS = "aws-kms",
|
|
1502
|
+
GCP_KMS = "gcp-kms",
|
|
1503
|
+
AZURE_KV = "azure-kv"
|
|
1504
|
+
}
|
|
1505
|
+
enum status {
|
|
1506
|
+
ACTIVE = "active",
|
|
1507
|
+
PENDING = "pending",
|
|
1508
|
+
ROTATING = "rotating",
|
|
1509
|
+
UNAVAILABLE = "unavailable",
|
|
1510
|
+
DISABLED = "disabled"
|
|
1511
|
+
}
|
|
1512
|
+
}
|
|
1513
|
+
|
|
1514
|
+
type OrgKmsJobResponse = {
|
|
1515
|
+
id: string;
|
|
1516
|
+
org_id: string;
|
|
1517
|
+
app_id: string | null;
|
|
1518
|
+
kind: OrgKmsJobResponse.kind;
|
|
1519
|
+
status: OrgKmsJobResponse.status;
|
|
1520
|
+
progress: Record<string, any>;
|
|
1521
|
+
error_message: string | null;
|
|
1522
|
+
created_by: string | null;
|
|
1523
|
+
created_at: string;
|
|
1524
|
+
updated_at: string;
|
|
1525
|
+
};
|
|
1526
|
+
declare namespace OrgKmsJobResponse {
|
|
1527
|
+
enum kind {
|
|
1528
|
+
KEK_REWRAP = "kek_rewrap",
|
|
1529
|
+
DEK_REWRAP = "dek_rewrap",
|
|
1530
|
+
DETACH_MANAGED = "detach_managed"
|
|
1531
|
+
}
|
|
1532
|
+
enum status {
|
|
1533
|
+
PENDING = "pending",
|
|
1534
|
+
RUNNING = "running",
|
|
1535
|
+
SUCCEEDED = "succeeded",
|
|
1536
|
+
FAILED = "failed"
|
|
1537
|
+
}
|
|
1538
|
+
}
|
|
1539
|
+
|
|
1540
|
+
type OrgKmsVerifyResponse = {
|
|
1541
|
+
ok: boolean;
|
|
1542
|
+
source: OrgKmsVerifyResponse.source;
|
|
1543
|
+
status: OrgKmsVerifyResponse.status;
|
|
1544
|
+
last_verified_at: string;
|
|
1545
|
+
};
|
|
1546
|
+
declare namespace OrgKmsVerifyResponse {
|
|
1547
|
+
enum source {
|
|
1548
|
+
MANAGED = "managed",
|
|
1549
|
+
AWS_KMS = "aws-kms",
|
|
1550
|
+
GCP_KMS = "gcp-kms",
|
|
1551
|
+
AZURE_KV = "azure-kv"
|
|
1552
|
+
}
|
|
1553
|
+
enum status {
|
|
1554
|
+
ACTIVE = "active",
|
|
1555
|
+
PENDING = "pending",
|
|
1556
|
+
ROTATING = "rotating",
|
|
1557
|
+
UNAVAILABLE = "unavailable",
|
|
1558
|
+
DISABLED = "disabled"
|
|
1559
|
+
}
|
|
1560
|
+
}
|
|
1561
|
+
|
|
1562
|
+
type UpdateOrgKmsConfigRequest = {
|
|
1563
|
+
source: UpdateOrgKmsConfigRequest.source;
|
|
1564
|
+
key_ref?: string | null;
|
|
1565
|
+
region?: string | null;
|
|
1566
|
+
credential_secret_id?: string | null;
|
|
1567
|
+
};
|
|
1568
|
+
declare namespace UpdateOrgKmsConfigRequest {
|
|
1569
|
+
enum source {
|
|
1570
|
+
MANAGED = "managed",
|
|
1571
|
+
AWS_KMS = "aws-kms",
|
|
1572
|
+
GCP_KMS = "gcp-kms",
|
|
1573
|
+
AZURE_KV = "azure-kv"
|
|
1574
|
+
}
|
|
1575
|
+
}
|
|
1576
|
+
|
|
1577
|
+
declare class EnterpriseCmkService {
|
|
770
1578
|
readonly httpRequest: BaseHttpRequest;
|
|
771
1579
|
constructor(httpRequest: BaseHttpRequest);
|
|
772
1580
|
/**
|
|
773
|
-
*
|
|
774
|
-
*
|
|
1581
|
+
* Break-glass detach organization CMK
|
|
1582
|
+
* Hosted platform API. Enqueues detach-to-managed even if the org lost the kms grant or status is unavailable. Does not call ensureTenantKek.
|
|
1583
|
+
* @param xEnvSyncPlatformToken
|
|
1584
|
+
* @param orgId
|
|
1585
|
+
* @returns OrgKmsJobResponse Already on managed wrapping
|
|
1586
|
+
* @throws ApiError
|
|
1587
|
+
*/
|
|
1588
|
+
breakGlassDetachOrgKms(xEnvSyncPlatformToken: string, orgId: string): CancelablePromise<OrgKmsJobResponse>;
|
|
1589
|
+
/**
|
|
1590
|
+
* Get organization KMS config
|
|
1591
|
+
* Returns implicit managed/active when no org_kms_config row exists. Never returns key material.
|
|
1592
|
+
* @returns OrgKmsConfigResponse Organization KMS config
|
|
1593
|
+
* @throws ApiError
|
|
1594
|
+
*/
|
|
1595
|
+
getOrgKmsConfig(): CancelablePromise<OrgKmsConfigResponse>;
|
|
1596
|
+
/**
|
|
1597
|
+
* Update organization KMS config
|
|
1598
|
+
* Self-host cloud sources return 403 CMK_HOSTED_ONLY. Hosted persists cloud source as pending until attach.
|
|
775
1599
|
* @param requestBody
|
|
776
|
-
* @returns
|
|
1600
|
+
* @returns OrgKmsConfigResponse Organization KMS config updated
|
|
777
1601
|
* @throws ApiError
|
|
778
1602
|
*/
|
|
779
|
-
|
|
1603
|
+
updateOrgKmsConfig(requestBody?: UpdateOrgKmsConfigRequest): CancelablePromise<OrgKmsConfigResponse>;
|
|
780
1604
|
/**
|
|
781
|
-
* Create
|
|
782
|
-
*
|
|
1605
|
+
* Create a purpose=kms org secret
|
|
1606
|
+
* Encrypts the value under scope __kms_config__ before insert. Does not require the integrations feature.
|
|
783
1607
|
* @param requestBody
|
|
784
|
-
* @returns
|
|
1608
|
+
* @returns OrgKmsCredentialResponse Credential created (value redacted)
|
|
785
1609
|
* @throws ApiError
|
|
786
1610
|
*/
|
|
787
|
-
|
|
1611
|
+
createOrgKmsCredential(requestBody?: CreateOrgKmsCredentialRequest): CancelablePromise<OrgKmsCredentialResponse>;
|
|
788
1612
|
/**
|
|
789
|
-
*
|
|
790
|
-
*
|
|
791
|
-
* @returns
|
|
1613
|
+
* Verify organization KMS
|
|
1614
|
+
* Managed source succeeds immediately. Cloud verify unwraps or first-wraps the tenant KEK.
|
|
1615
|
+
* @returns OrgKmsVerifyResponse Verify result
|
|
792
1616
|
* @throws ApiError
|
|
793
1617
|
*/
|
|
794
|
-
|
|
1618
|
+
verifyOrgKms(): CancelablePromise<OrgKmsVerifyResponse>;
|
|
795
1619
|
/**
|
|
796
|
-
*
|
|
797
|
-
*
|
|
798
|
-
* @
|
|
799
|
-
* @returns ChangeRequestResponse Change request fetched
|
|
1620
|
+
* Rotate organization KEK
|
|
1621
|
+
* Re-wraps wrapped_kek under the current key_ref. Hosted cloud-only; does not rewrap DEKs.
|
|
1622
|
+
* @returns OrgKmsConfigResponse KEK rotated
|
|
800
1623
|
* @throws ApiError
|
|
801
1624
|
*/
|
|
802
|
-
|
|
1625
|
+
rotateOrgKmsKek(): CancelablePromise<OrgKmsConfigResponse>;
|
|
803
1626
|
/**
|
|
804
|
-
*
|
|
805
|
-
*
|
|
806
|
-
* @
|
|
807
|
-
* @returns ChangeRequestResponse Change request approved and applied
|
|
1627
|
+
* Attach organization CMK
|
|
1628
|
+
* Enqueues DEK rewrap under the tenant KEK with allow_root_unwrap during the attach window. Hosted only.
|
|
1629
|
+
* @returns OrgKmsJobResponse Attach job enqueued
|
|
808
1630
|
* @throws ApiError
|
|
809
1631
|
*/
|
|
810
|
-
|
|
1632
|
+
attachOrgKms(): CancelablePromise<OrgKmsJobResponse>;
|
|
811
1633
|
/**
|
|
812
|
-
*
|
|
813
|
-
*
|
|
814
|
-
* @
|
|
815
|
-
* @param requestBody
|
|
816
|
-
* @returns ChangeRequestResponse Change request rejected
|
|
1634
|
+
* Detach organization CMK to managed
|
|
1635
|
+
* Enqueues detach_managed. Does not call ensureTenantKek when status is unavailable.
|
|
1636
|
+
* @returns OrgKmsJobResponse Detach job enqueued
|
|
817
1637
|
* @throws ApiError
|
|
818
1638
|
*/
|
|
819
|
-
|
|
1639
|
+
detachOrgKms(): CancelablePromise<OrgKmsJobResponse>;
|
|
820
1640
|
/**
|
|
821
|
-
*
|
|
822
|
-
* Cancel a pending change request created by the current user.
|
|
1641
|
+
* Get organization KMS job
|
|
823
1642
|
* @param id
|
|
824
|
-
* @returns
|
|
1643
|
+
* @returns OrgKmsJobResponse KMS job
|
|
825
1644
|
* @throws ApiError
|
|
826
1645
|
*/
|
|
827
|
-
|
|
1646
|
+
getOrgKmsJob(id: string): CancelablePromise<OrgKmsJobResponse>;
|
|
1647
|
+
/**
|
|
1648
|
+
* List per-app KMS key info
|
|
1649
|
+
* Calls GetKeyInfo per app. Never returns key material.
|
|
1650
|
+
* @returns OrgKmsAppsResponse Per-app key metadata
|
|
1651
|
+
* @throws ApiError
|
|
1652
|
+
*/
|
|
1653
|
+
listOrgKmsApps(): CancelablePromise<OrgKmsAppsResponse>;
|
|
828
1654
|
}
|
|
829
1655
|
|
|
830
1656
|
type CreateEnvTypeRequest = {
|
|
@@ -1561,6 +2387,246 @@ declare class GpgKeysService {
|
|
|
1561
2387
|
updateGpgKeyTrustLevel(id: string, requestBody?: UpdateTrustLevelRequest): CancelablePromise<GpgKeyDetailResponse>;
|
|
1562
2388
|
}
|
|
1563
2389
|
|
|
2390
|
+
type LicenseState = {
|
|
2391
|
+
status: LicenseState.status;
|
|
2392
|
+
lease_expires_at?: string | null;
|
|
2393
|
+
last_verified_at?: string | null;
|
|
2394
|
+
last_error_code?: string | null;
|
|
2395
|
+
last_error_message?: string | null;
|
|
2396
|
+
validation_mode?: LicenseState.validation_mode;
|
|
2397
|
+
certificate_serial_hex?: string | null;
|
|
2398
|
+
certificate_fingerprint_sha256?: string | null;
|
|
2399
|
+
certificate_subject?: string | null;
|
|
2400
|
+
certificate_issuer?: string | null;
|
|
2401
|
+
certificate_expires_at?: string | null;
|
|
2402
|
+
root_ca_fingerprint_sha256?: string | null;
|
|
2403
|
+
validated_at?: string | null;
|
|
2404
|
+
};
|
|
2405
|
+
declare namespace LicenseState {
|
|
2406
|
+
enum status {
|
|
2407
|
+
UNKNOWN = "unknown",
|
|
2408
|
+
ACTIVE = "active",
|
|
2409
|
+
INACTIVE = "inactive",
|
|
2410
|
+
EXPIRED = "expired",
|
|
2411
|
+
ERROR = "error",
|
|
2412
|
+
LOCKED = "locked"
|
|
2413
|
+
}
|
|
2414
|
+
enum validation_mode {
|
|
2415
|
+
NONE = "none",
|
|
2416
|
+
LEASE = "lease",
|
|
2417
|
+
CERTIFICATE = "certificate"
|
|
2418
|
+
}
|
|
2419
|
+
}
|
|
2420
|
+
|
|
2421
|
+
type LicenseActionResponse = {
|
|
2422
|
+
message: string;
|
|
2423
|
+
state: LicenseState;
|
|
2424
|
+
};
|
|
2425
|
+
|
|
2426
|
+
type LicenseStatusResponse = {
|
|
2427
|
+
required: boolean;
|
|
2428
|
+
locked: boolean;
|
|
2429
|
+
reason?: string | null;
|
|
2430
|
+
state: LicenseState;
|
|
2431
|
+
};
|
|
2432
|
+
|
|
2433
|
+
declare class LicenseService {
|
|
2434
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2435
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2436
|
+
/**
|
|
2437
|
+
* Get Management License Status
|
|
2438
|
+
* @returns LicenseStatusResponse Current license status
|
|
2439
|
+
* @throws ApiError
|
|
2440
|
+
*/
|
|
2441
|
+
getManagementLicenseStatus(): CancelablePromise<LicenseStatusResponse>;
|
|
2442
|
+
/**
|
|
2443
|
+
* Activate Management License
|
|
2444
|
+
* @returns LicenseActionResponse License activated
|
|
2445
|
+
* @throws ApiError
|
|
2446
|
+
*/
|
|
2447
|
+
activateManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
2448
|
+
/**
|
|
2449
|
+
* Verify Management License
|
|
2450
|
+
* @returns LicenseActionResponse License verified
|
|
2451
|
+
* @throws ApiError
|
|
2452
|
+
*/
|
|
2453
|
+
verifyManagementLicense(): CancelablePromise<LicenseActionResponse>;
|
|
2454
|
+
}
|
|
2455
|
+
|
|
2456
|
+
type CreateLogForwardingRequest = {
|
|
2457
|
+
name: string;
|
|
2458
|
+
provider_type: CreateLogForwardingRequest.provider_type;
|
|
2459
|
+
config: Record<string, any>;
|
|
2460
|
+
enabled?: boolean;
|
|
2461
|
+
};
|
|
2462
|
+
declare namespace CreateLogForwardingRequest {
|
|
2463
|
+
enum provider_type {
|
|
2464
|
+
DATADOG = "datadog",
|
|
2465
|
+
SPLUNK = "splunk",
|
|
2466
|
+
SUMO_LOGIC = "sumo-logic"
|
|
2467
|
+
}
|
|
2468
|
+
}
|
|
2469
|
+
|
|
2470
|
+
type LogForwardingResponse = {
|
|
2471
|
+
id: string;
|
|
2472
|
+
org_id: string;
|
|
2473
|
+
name: string;
|
|
2474
|
+
provider_type: LogForwardingResponse.provider_type;
|
|
2475
|
+
config: Record<string, any>;
|
|
2476
|
+
enabled: boolean;
|
|
2477
|
+
created_at: string;
|
|
2478
|
+
updated_at: string;
|
|
2479
|
+
};
|
|
2480
|
+
declare namespace LogForwardingResponse {
|
|
2481
|
+
enum provider_type {
|
|
2482
|
+
DATADOG = "datadog",
|
|
2483
|
+
SPLUNK = "splunk",
|
|
2484
|
+
SUMO_LOGIC = "sumo-logic"
|
|
2485
|
+
}
|
|
2486
|
+
}
|
|
2487
|
+
|
|
2488
|
+
type LogForwardingsResponse = Array<LogForwardingResponse>;
|
|
2489
|
+
|
|
2490
|
+
declare class LogForwardingService {
|
|
2491
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2492
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2493
|
+
/**
|
|
2494
|
+
* Create Log Forwarding Config
|
|
2495
|
+
* Create a new log forwarding configuration for the organization
|
|
2496
|
+
* @param requestBody
|
|
2497
|
+
* @returns LogForwardingResponse Log forwarding config created successfully
|
|
2498
|
+
* @throws ApiError
|
|
2499
|
+
*/
|
|
2500
|
+
createLogForwardingConfig(requestBody?: CreateLogForwardingRequest): CancelablePromise<LogForwardingResponse>;
|
|
2501
|
+
/**
|
|
2502
|
+
* Get All Log Forwarding Configs
|
|
2503
|
+
* Retrieve all log forwarding configurations for the organization
|
|
2504
|
+
* @returns LogForwardingsResponse Log forwarding configs retrieved successfully
|
|
2505
|
+
* @throws ApiError
|
|
2506
|
+
*/
|
|
2507
|
+
getLogForwardingConfigs(): CancelablePromise<LogForwardingsResponse>;
|
|
2508
|
+
/**
|
|
2509
|
+
* Get Log Forwarding Config
|
|
2510
|
+
* Retrieve a specific log forwarding configuration
|
|
2511
|
+
* @param id
|
|
2512
|
+
* @returns LogForwardingResponse Log forwarding config retrieved successfully
|
|
2513
|
+
* @throws ApiError
|
|
2514
|
+
*/
|
|
2515
|
+
getLogForwardingConfig(id: string): CancelablePromise<LogForwardingResponse>;
|
|
2516
|
+
/**
|
|
2517
|
+
* Delete Log Forwarding Config
|
|
2518
|
+
* Delete a log forwarding configuration
|
|
2519
|
+
* @param id
|
|
2520
|
+
* @returns ErrorResponse Log forwarding config deleted successfully
|
|
2521
|
+
* @throws ApiError
|
|
2522
|
+
*/
|
|
2523
|
+
deleteLogForwardingConfig(id: string): CancelablePromise<ErrorResponse>;
|
|
2524
|
+
}
|
|
2525
|
+
|
|
2526
|
+
type CreateOidcProviderRequest = {
|
|
2527
|
+
/**
|
|
2528
|
+
* CI/CD platform type
|
|
2529
|
+
*/
|
|
2530
|
+
provider_type: CreateOidcProviderRequest.provider_type;
|
|
2531
|
+
/**
|
|
2532
|
+
* OIDC issuer URL
|
|
2533
|
+
*/
|
|
2534
|
+
issuer_url: string;
|
|
2535
|
+
/**
|
|
2536
|
+
* Expected audience claim value
|
|
2537
|
+
*/
|
|
2538
|
+
audience: string;
|
|
2539
|
+
/**
|
|
2540
|
+
* Subject patterns to allow (glob matching). Empty = allow all subjects from this issuer.
|
|
2541
|
+
*/
|
|
2542
|
+
allowed_subjects?: Array<string>;
|
|
2543
|
+
};
|
|
2544
|
+
declare namespace CreateOidcProviderRequest {
|
|
2545
|
+
/**
|
|
2546
|
+
* CI/CD platform type
|
|
2547
|
+
*/
|
|
2548
|
+
enum provider_type {
|
|
2549
|
+
GITHUB_ACTIONS = "github_actions",
|
|
2550
|
+
GITLAB_CI = "gitlab_ci",
|
|
2551
|
+
KUBERNETES = "kubernetes",
|
|
2552
|
+
GENERIC = "generic"
|
|
2553
|
+
}
|
|
2554
|
+
}
|
|
2555
|
+
|
|
2556
|
+
type OidcProviderResponse = {
|
|
2557
|
+
id: string;
|
|
2558
|
+
org_id: string;
|
|
2559
|
+
provider_type: OidcProviderResponse.provider_type;
|
|
2560
|
+
issuer_url: string;
|
|
2561
|
+
audience: string;
|
|
2562
|
+
enabled: boolean;
|
|
2563
|
+
allowed_subjects: Array<string>;
|
|
2564
|
+
machine_user_id: string | null;
|
|
2565
|
+
created_at: string;
|
|
2566
|
+
updated_at: string;
|
|
2567
|
+
};
|
|
2568
|
+
declare namespace OidcProviderResponse {
|
|
2569
|
+
enum provider_type {
|
|
2570
|
+
GITHUB_ACTIONS = "github_actions",
|
|
2571
|
+
GITLAB_CI = "gitlab_ci",
|
|
2572
|
+
KUBERNETES = "kubernetes",
|
|
2573
|
+
GENERIC = "generic"
|
|
2574
|
+
}
|
|
2575
|
+
}
|
|
2576
|
+
|
|
2577
|
+
type OidcProvidersResponse = Array<OidcProviderResponse>;
|
|
2578
|
+
|
|
2579
|
+
type UpdateOidcProviderRequest = {
|
|
2580
|
+
audience?: string;
|
|
2581
|
+
enabled?: boolean;
|
|
2582
|
+
allowed_subjects?: Array<string>;
|
|
2583
|
+
};
|
|
2584
|
+
|
|
2585
|
+
declare class OidcProvidersService {
|
|
2586
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2587
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2588
|
+
/**
|
|
2589
|
+
* Register OIDC Provider
|
|
2590
|
+
* Register a new OIDC provider for CI/CD machine authentication
|
|
2591
|
+
* @param requestBody
|
|
2592
|
+
* @returns OidcProviderResponse OIDC provider created successfully
|
|
2593
|
+
* @throws ApiError
|
|
2594
|
+
*/
|
|
2595
|
+
createOidcProvider(requestBody?: CreateOidcProviderRequest): CancelablePromise<OidcProviderResponse>;
|
|
2596
|
+
/**
|
|
2597
|
+
* Get All OIDC Providers
|
|
2598
|
+
* Retrieve all OIDC providers for the organization
|
|
2599
|
+
* @returns OidcProvidersResponse OIDC providers retrieved successfully
|
|
2600
|
+
* @throws ApiError
|
|
2601
|
+
*/
|
|
2602
|
+
getAllOidcProviders(): CancelablePromise<OidcProvidersResponse>;
|
|
2603
|
+
/**
|
|
2604
|
+
* Get OIDC Provider
|
|
2605
|
+
* Retrieve a specific OIDC provider
|
|
2606
|
+
* @param id
|
|
2607
|
+
* @returns OidcProviderResponse OIDC provider retrieved successfully
|
|
2608
|
+
* @throws ApiError
|
|
2609
|
+
*/
|
|
2610
|
+
getOidcProvider(id: string): CancelablePromise<OidcProviderResponse>;
|
|
2611
|
+
/**
|
|
2612
|
+
* Update OIDC Provider
|
|
2613
|
+
* Update an existing OIDC provider
|
|
2614
|
+
* @param id
|
|
2615
|
+
* @param requestBody
|
|
2616
|
+
* @returns ErrorResponse OIDC provider updated successfully
|
|
2617
|
+
* @throws ApiError
|
|
2618
|
+
*/
|
|
2619
|
+
updateOidcProvider(id: string, requestBody?: UpdateOidcProviderRequest): CancelablePromise<ErrorResponse>;
|
|
2620
|
+
/**
|
|
2621
|
+
* Delete OIDC Provider
|
|
2622
|
+
* Delete an existing OIDC provider
|
|
2623
|
+
* @param id
|
|
2624
|
+
* @returns ErrorResponse OIDC provider deleted successfully
|
|
2625
|
+
* @throws ApiError
|
|
2626
|
+
*/
|
|
2627
|
+
deleteOidcProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
2628
|
+
}
|
|
2629
|
+
|
|
1564
2630
|
type AcceptOrgInviteRequest = {
|
|
1565
2631
|
org_data: {
|
|
1566
2632
|
name: string;
|
|
@@ -1665,7 +2731,81 @@ declare class OnboardingService {
|
|
|
1665
2731
|
* @returns CreateOrgInviteResponse Successful greeting response
|
|
1666
2732
|
* @throws ApiError
|
|
1667
2733
|
*/
|
|
1668
|
-
createOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
2734
|
+
createOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
2735
|
+
/**
|
|
2736
|
+
* Get Organization Invite by Code
|
|
2737
|
+
* Get organization invite by code
|
|
2738
|
+
* @param inviteCode
|
|
2739
|
+
* @returns GetOrgInviteByCodeResponse Organization invite retrieved successfully
|
|
2740
|
+
* @throws ApiError
|
|
2741
|
+
*/
|
|
2742
|
+
getOrgInviteByCode(inviteCode: string): CancelablePromise<GetOrgInviteByCodeResponse>;
|
|
2743
|
+
/**
|
|
2744
|
+
* Accept Organization Invite
|
|
2745
|
+
* Accept organization invite
|
|
2746
|
+
* @param inviteCode
|
|
2747
|
+
* @param requestBody
|
|
2748
|
+
* @returns AcceptOrgInviteResponse Organization invite accepted successfully
|
|
2749
|
+
* @throws ApiError
|
|
2750
|
+
*/
|
|
2751
|
+
acceptOrgInvite(inviteCode: string, requestBody?: AcceptOrgInviteRequest): CancelablePromise<AcceptOrgInviteResponse>;
|
|
2752
|
+
/**
|
|
2753
|
+
* Get User Invite by Code
|
|
2754
|
+
* Get user invite by code
|
|
2755
|
+
* @param inviteCode
|
|
2756
|
+
* @returns GetUserInviteByTokenResponse User invite retrieved successfully
|
|
2757
|
+
* @throws ApiError
|
|
2758
|
+
*/
|
|
2759
|
+
getUserInviteByCode(inviteCode: string): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
2760
|
+
/**
|
|
2761
|
+
* Update User Invite
|
|
2762
|
+
* Update user invite
|
|
2763
|
+
* @param inviteCode
|
|
2764
|
+
* @param requestBody
|
|
2765
|
+
* @returns UpdateUserInviteResponse User invite updated successfully
|
|
2766
|
+
* @throws ApiError
|
|
2767
|
+
*/
|
|
2768
|
+
updateUserInvite(inviteCode: string, requestBody?: UpdateUserInviteRequest): CancelablePromise<UpdateUserInviteResponse>;
|
|
2769
|
+
/**
|
|
2770
|
+
* Accept User Invite
|
|
2771
|
+
* Accept user invite
|
|
2772
|
+
* @param inviteCode
|
|
2773
|
+
* @param requestBody
|
|
2774
|
+
* @returns AcceptUserInviteResponse User invite accepted successfully
|
|
2775
|
+
* @throws ApiError
|
|
2776
|
+
*/
|
|
2777
|
+
acceptUserInvite(inviteCode: string, requestBody?: AcceptUserInviteRequest): CancelablePromise<AcceptUserInviteResponse>;
|
|
2778
|
+
/**
|
|
2779
|
+
* Create User Invite
|
|
2780
|
+
* Create a user invite
|
|
2781
|
+
* @param requestBody
|
|
2782
|
+
* @returns CreateUserInviteResponse User invite created successfully
|
|
2783
|
+
* @throws ApiError
|
|
2784
|
+
*/
|
|
2785
|
+
createUserInvite(requestBody?: CreateUserInviteRequest): CancelablePromise<CreateUserInviteResponse>;
|
|
2786
|
+
/**
|
|
2787
|
+
* Get All User Invites
|
|
2788
|
+
* Get all user invites
|
|
2789
|
+
* @returns GetUserInviteByTokenResponse User invites retrieved successfully
|
|
2790
|
+
* @throws ApiError
|
|
2791
|
+
*/
|
|
2792
|
+
getAllUserInvites(): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
2793
|
+
/**
|
|
2794
|
+
* Delete User Invite
|
|
2795
|
+
* Delete user invite
|
|
2796
|
+
* @param inviteId
|
|
2797
|
+
* @returns DeleteUserInviteResponse User invite deleted successfully
|
|
2798
|
+
* @throws ApiError
|
|
2799
|
+
*/
|
|
2800
|
+
deleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
2801
|
+
/**
|
|
2802
|
+
* Create Organization Invite
|
|
2803
|
+
* Create an organization invite
|
|
2804
|
+
* @param requestBody
|
|
2805
|
+
* @returns CreateOrgInviteResponse Successful greeting response
|
|
2806
|
+
* @throws ApiError
|
|
2807
|
+
*/
|
|
2808
|
+
manageCreateOrgInvite(requestBody?: CreateOrgInviteRequest): CancelablePromise<CreateOrgInviteResponse>;
|
|
1669
2809
|
/**
|
|
1670
2810
|
* Get Organization Invite by Code
|
|
1671
2811
|
* Get organization invite by code
|
|
@@ -1673,7 +2813,7 @@ declare class OnboardingService {
|
|
|
1673
2813
|
* @returns GetOrgInviteByCodeResponse Organization invite retrieved successfully
|
|
1674
2814
|
* @throws ApiError
|
|
1675
2815
|
*/
|
|
1676
|
-
|
|
2816
|
+
manageGetOrgInviteByCode(inviteCode: string): CancelablePromise<GetOrgInviteByCodeResponse>;
|
|
1677
2817
|
/**
|
|
1678
2818
|
* Accept Organization Invite
|
|
1679
2819
|
* Accept organization invite
|
|
@@ -1682,7 +2822,7 @@ declare class OnboardingService {
|
|
|
1682
2822
|
* @returns AcceptOrgInviteResponse Organization invite accepted successfully
|
|
1683
2823
|
* @throws ApiError
|
|
1684
2824
|
*/
|
|
1685
|
-
|
|
2825
|
+
manageAcceptOrgInvite(inviteCode: string, requestBody?: AcceptOrgInviteRequest): CancelablePromise<AcceptOrgInviteResponse>;
|
|
1686
2826
|
/**
|
|
1687
2827
|
* Get User Invite by Code
|
|
1688
2828
|
* Get user invite by code
|
|
@@ -1690,7 +2830,7 @@ declare class OnboardingService {
|
|
|
1690
2830
|
* @returns GetUserInviteByTokenResponse User invite retrieved successfully
|
|
1691
2831
|
* @throws ApiError
|
|
1692
2832
|
*/
|
|
1693
|
-
|
|
2833
|
+
manageGetUserInviteByCode(inviteCode: string): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
1694
2834
|
/**
|
|
1695
2835
|
* Update User Invite
|
|
1696
2836
|
* Update user invite
|
|
@@ -1699,7 +2839,7 @@ declare class OnboardingService {
|
|
|
1699
2839
|
* @returns UpdateUserInviteResponse User invite updated successfully
|
|
1700
2840
|
* @throws ApiError
|
|
1701
2841
|
*/
|
|
1702
|
-
|
|
2842
|
+
manageUpdateUserInvite(inviteCode: string, requestBody?: UpdateUserInviteRequest): CancelablePromise<UpdateUserInviteResponse>;
|
|
1703
2843
|
/**
|
|
1704
2844
|
* Accept User Invite
|
|
1705
2845
|
* Accept user invite
|
|
@@ -1708,7 +2848,7 @@ declare class OnboardingService {
|
|
|
1708
2848
|
* @returns AcceptUserInviteResponse User invite accepted successfully
|
|
1709
2849
|
* @throws ApiError
|
|
1710
2850
|
*/
|
|
1711
|
-
|
|
2851
|
+
manageAcceptUserInvite(inviteCode: string, requestBody?: AcceptUserInviteRequest): CancelablePromise<AcceptUserInviteResponse>;
|
|
1712
2852
|
/**
|
|
1713
2853
|
* Create User Invite
|
|
1714
2854
|
* Create a user invite
|
|
@@ -1716,14 +2856,14 @@ declare class OnboardingService {
|
|
|
1716
2856
|
* @returns CreateUserInviteResponse User invite created successfully
|
|
1717
2857
|
* @throws ApiError
|
|
1718
2858
|
*/
|
|
1719
|
-
|
|
2859
|
+
manageCreateUserInvite(requestBody?: CreateUserInviteRequest): CancelablePromise<CreateUserInviteResponse>;
|
|
1720
2860
|
/**
|
|
1721
2861
|
* Get All User Invites
|
|
1722
2862
|
* Get all user invites
|
|
1723
2863
|
* @returns GetUserInviteByTokenResponse User invites retrieved successfully
|
|
1724
2864
|
* @throws ApiError
|
|
1725
2865
|
*/
|
|
1726
|
-
|
|
2866
|
+
manageGetAllUserInvites(): CancelablePromise<GetUserInviteByTokenResponse>;
|
|
1727
2867
|
/**
|
|
1728
2868
|
* Delete User Invite
|
|
1729
2869
|
* Delete user invite
|
|
@@ -1731,7 +2871,7 @@ declare class OnboardingService {
|
|
|
1731
2871
|
* @returns DeleteUserInviteResponse User invite deleted successfully
|
|
1732
2872
|
* @throws ApiError
|
|
1733
2873
|
*/
|
|
1734
|
-
|
|
2874
|
+
manageDeleteUserInvite(inviteId: string): CancelablePromise<DeleteUserInviteResponse>;
|
|
1735
2875
|
}
|
|
1736
2876
|
|
|
1737
2877
|
type CheckSlugResponse = {
|
|
@@ -1802,6 +2942,62 @@ declare class OrganizationsService {
|
|
|
1802
2942
|
checkIfSlugExists(slug: string): CancelablePromise<CheckSlugResponse>;
|
|
1803
2943
|
}
|
|
1804
2944
|
|
|
2945
|
+
type OrgFeatureGrantResponse = {
|
|
2946
|
+
org_id: string;
|
|
2947
|
+
unrestricted: boolean;
|
|
2948
|
+
features: Array<string>;
|
|
2949
|
+
source: string | null;
|
|
2950
|
+
updated_by: string | null;
|
|
2951
|
+
created_at: string | null;
|
|
2952
|
+
updated_at: string | null;
|
|
2953
|
+
};
|
|
2954
|
+
|
|
2955
|
+
type PutOrgFeatureGrantRequest = {
|
|
2956
|
+
features: Array<string>;
|
|
2957
|
+
source?: PutOrgFeatureGrantRequest.source;
|
|
2958
|
+
updated_by?: string;
|
|
2959
|
+
};
|
|
2960
|
+
declare namespace PutOrgFeatureGrantRequest {
|
|
2961
|
+
enum source {
|
|
2962
|
+
BILLING = "billing",
|
|
2963
|
+
SUPPORT = "support",
|
|
2964
|
+
SEED = "seed"
|
|
2965
|
+
}
|
|
2966
|
+
}
|
|
2967
|
+
|
|
2968
|
+
declare class OrgFeaturesService {
|
|
2969
|
+
readonly httpRequest: BaseHttpRequest;
|
|
2970
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
2971
|
+
/**
|
|
2972
|
+
* Get Organization Feature Grant
|
|
2973
|
+
* Hosted platform API. No row means unrestricted (full catalog).
|
|
2974
|
+
* @param xEnvSyncPlatformToken
|
|
2975
|
+
* @param orgId
|
|
2976
|
+
* @returns OrgFeatureGrantResponse Organization feature grant
|
|
2977
|
+
* @throws ApiError
|
|
2978
|
+
*/
|
|
2979
|
+
getOrgFeatureGrant(xEnvSyncPlatformToken: string, orgId: string): CancelablePromise<OrgFeatureGrantResponse>;
|
|
2980
|
+
/**
|
|
2981
|
+
* Replace Organization Feature Grant
|
|
2982
|
+
* Full replace. Empty features[] denies every EE feature. Unknown catalog keys are dropped.
|
|
2983
|
+
* @param xEnvSyncPlatformToken
|
|
2984
|
+
* @param orgId
|
|
2985
|
+
* @param requestBody
|
|
2986
|
+
* @returns OrgFeatureGrantResponse Organization feature grant replaced
|
|
2987
|
+
* @throws ApiError
|
|
2988
|
+
*/
|
|
2989
|
+
putOrgFeatureGrant(xEnvSyncPlatformToken: string, orgId: string, requestBody?: PutOrgFeatureGrantRequest): CancelablePromise<OrgFeatureGrantResponse>;
|
|
2990
|
+
/**
|
|
2991
|
+
* Delete Organization Feature Grant
|
|
2992
|
+
* Drops the grant row so the organization is unrestricted.
|
|
2993
|
+
* @param xEnvSyncPlatformToken
|
|
2994
|
+
* @param orgId
|
|
2995
|
+
* @returns OrgFeatureGrantResponse Grant deleted; organization unrestricted
|
|
2996
|
+
* @throws ApiError
|
|
2997
|
+
*/
|
|
2998
|
+
deleteOrgFeatureGrant(xEnvSyncPlatformToken: string, orgId: string): CancelablePromise<OrgFeatureGrantResponse>;
|
|
2999
|
+
}
|
|
3000
|
+
|
|
1805
3001
|
type EffectiveAccessEntry = {
|
|
1806
3002
|
user_id: string;
|
|
1807
3003
|
email: string;
|
|
@@ -2069,6 +3265,357 @@ declare class RolesService {
|
|
|
2069
3265
|
deleteRole(id: string): CancelablePromise<RoleResponse>;
|
|
2070
3266
|
}
|
|
2071
3267
|
|
|
3268
|
+
type CreateRotationPolicyRequest = {
|
|
3269
|
+
app_id: string;
|
|
3270
|
+
env_type_id: string;
|
|
3271
|
+
variable_key: string;
|
|
3272
|
+
engine_type: CreateRotationPolicyRequest.engine_type;
|
|
3273
|
+
schedule_cron: string;
|
|
3274
|
+
dual_window_minutes?: number;
|
|
3275
|
+
enabled?: boolean;
|
|
3276
|
+
connection_config: Record<string, any>;
|
|
3277
|
+
};
|
|
3278
|
+
declare namespace CreateRotationPolicyRequest {
|
|
3279
|
+
enum engine_type {
|
|
3280
|
+
POSTGRES = "postgres",
|
|
3281
|
+
MYSQL = "mysql",
|
|
3282
|
+
AWS_IAM = "aws-iam",
|
|
3283
|
+
AZURE_SP = "azure-sp",
|
|
3284
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
3285
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
3286
|
+
SENDGRID = "sendgrid",
|
|
3287
|
+
TWILIO = "twilio"
|
|
3288
|
+
}
|
|
3289
|
+
}
|
|
3290
|
+
|
|
3291
|
+
type RevokeOldCredentialResponse = {
|
|
3292
|
+
message: string;
|
|
3293
|
+
revoked_at: string;
|
|
3294
|
+
};
|
|
3295
|
+
|
|
3296
|
+
type RotationPolicyResponse = {
|
|
3297
|
+
id: string;
|
|
3298
|
+
org_id: string;
|
|
3299
|
+
app_id: string;
|
|
3300
|
+
env_type_id: string;
|
|
3301
|
+
variable_key: string;
|
|
3302
|
+
engine_type: RotationPolicyResponse.engine_type;
|
|
3303
|
+
schedule_cron: string;
|
|
3304
|
+
dual_window_minutes: number;
|
|
3305
|
+
enabled: boolean;
|
|
3306
|
+
last_rotated_at: string | null;
|
|
3307
|
+
next_rotation_at: string | null;
|
|
3308
|
+
created_at: string;
|
|
3309
|
+
updated_at: string;
|
|
3310
|
+
};
|
|
3311
|
+
declare namespace RotationPolicyResponse {
|
|
3312
|
+
enum engine_type {
|
|
3313
|
+
POSTGRES = "postgres",
|
|
3314
|
+
MYSQL = "mysql",
|
|
3315
|
+
AWS_IAM = "aws-iam",
|
|
3316
|
+
AZURE_SP = "azure-sp",
|
|
3317
|
+
GCP_SERVICE_ACCOUNT = "gcp-service-account",
|
|
3318
|
+
CLOUDFLARE_PAGES = "cloudflare-pages",
|
|
3319
|
+
SENDGRID = "sendgrid",
|
|
3320
|
+
TWILIO = "twilio"
|
|
3321
|
+
}
|
|
3322
|
+
}
|
|
3323
|
+
|
|
3324
|
+
type RotationPoliciesResponse = Array<RotationPolicyResponse>;
|
|
3325
|
+
|
|
3326
|
+
type RotationStateResponse = {
|
|
3327
|
+
id: string;
|
|
3328
|
+
rotation_policy_id: string;
|
|
3329
|
+
rotated_at: string;
|
|
3330
|
+
old_credential_expires_at: string;
|
|
3331
|
+
old_credential_revoked: boolean;
|
|
3332
|
+
revoked_at: string | null;
|
|
3333
|
+
created_at: string;
|
|
3334
|
+
};
|
|
3335
|
+
|
|
3336
|
+
type RotationStatesResponse = Array<RotationStateResponse>;
|
|
3337
|
+
|
|
3338
|
+
type TriggerRotationResponse = {
|
|
3339
|
+
message: string;
|
|
3340
|
+
rotation_state_id: string;
|
|
3341
|
+
new_credential_stored: boolean;
|
|
3342
|
+
old_credential_expires_at: string;
|
|
3343
|
+
};
|
|
3344
|
+
|
|
3345
|
+
type UpdateRotationPolicyRequest = {
|
|
3346
|
+
schedule_cron?: string;
|
|
3347
|
+
dual_window_minutes?: number;
|
|
3348
|
+
enabled?: boolean;
|
|
3349
|
+
connection_config?: Record<string, any>;
|
|
3350
|
+
};
|
|
3351
|
+
|
|
3352
|
+
declare class RotationService {
|
|
3353
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3354
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3355
|
+
/**
|
|
3356
|
+
* Create Rotation Policy
|
|
3357
|
+
* Create a new secret rotation policy for a variable
|
|
3358
|
+
* @param requestBody
|
|
3359
|
+
* @returns RotationPolicyResponse Rotation policy created successfully
|
|
3360
|
+
* @throws ApiError
|
|
3361
|
+
*/
|
|
3362
|
+
createRotationPolicy(requestBody?: CreateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
3363
|
+
/**
|
|
3364
|
+
* Get Rotation Policies
|
|
3365
|
+
* List all rotation policies for the organization
|
|
3366
|
+
* @param appId
|
|
3367
|
+
* @param envTypeId
|
|
3368
|
+
* @param enabled
|
|
3369
|
+
* @returns RotationPoliciesResponse Rotation policies retrieved successfully
|
|
3370
|
+
* @throws ApiError
|
|
3371
|
+
*/
|
|
3372
|
+
getRotationPolicies(appId?: string, envTypeId?: string, enabled?: 'true' | 'false'): CancelablePromise<RotationPoliciesResponse>;
|
|
3373
|
+
/**
|
|
3374
|
+
* Get Rotation Policy
|
|
3375
|
+
* Get a specific rotation policy by ID
|
|
3376
|
+
* @param id
|
|
3377
|
+
* @returns RotationPolicyResponse Rotation policy retrieved successfully
|
|
3378
|
+
* @throws ApiError
|
|
3379
|
+
*/
|
|
3380
|
+
getRotationPolicy(id: string): CancelablePromise<RotationPolicyResponse>;
|
|
3381
|
+
/**
|
|
3382
|
+
* Update Rotation Policy
|
|
3383
|
+
* Update an existing rotation policy
|
|
3384
|
+
* @param id
|
|
3385
|
+
* @param requestBody
|
|
3386
|
+
* @returns RotationPolicyResponse Rotation policy updated successfully
|
|
3387
|
+
* @throws ApiError
|
|
3388
|
+
*/
|
|
3389
|
+
updateRotationPolicy(id: string, requestBody?: UpdateRotationPolicyRequest): CancelablePromise<RotationPolicyResponse>;
|
|
3390
|
+
/**
|
|
3391
|
+
* Delete Rotation Policy
|
|
3392
|
+
* Delete a rotation policy
|
|
3393
|
+
* @param id
|
|
3394
|
+
* @returns ErrorResponse Rotation policy deleted successfully
|
|
3395
|
+
* @throws ApiError
|
|
3396
|
+
*/
|
|
3397
|
+
deleteRotationPolicy(id: string): CancelablePromise<ErrorResponse>;
|
|
3398
|
+
/**
|
|
3399
|
+
* Trigger Rotation
|
|
3400
|
+
* Manually trigger a secret rotation for a policy
|
|
3401
|
+
* @param id
|
|
3402
|
+
* @returns TriggerRotationResponse Rotation executed successfully
|
|
3403
|
+
* @throws ApiError
|
|
3404
|
+
*/
|
|
3405
|
+
triggerRotation(id: string): CancelablePromise<TriggerRotationResponse>;
|
|
3406
|
+
/**
|
|
3407
|
+
* Get Rotation States
|
|
3408
|
+
* Get the rotation state history for a policy
|
|
3409
|
+
* @param id
|
|
3410
|
+
* @returns RotationStatesResponse Rotation states retrieved successfully
|
|
3411
|
+
* @throws ApiError
|
|
3412
|
+
*/
|
|
3413
|
+
getRotationStates(id: string): CancelablePromise<RotationStatesResponse>;
|
|
3414
|
+
/**
|
|
3415
|
+
* Revoke Expired Credentials
|
|
3416
|
+
* Revoke old credentials that have passed their dual-credential window
|
|
3417
|
+
* @returns RevokeOldCredentialResponse Expired credentials revoked successfully
|
|
3418
|
+
* @throws ApiError
|
|
3419
|
+
*/
|
|
3420
|
+
revokeExpiredCredentials(): CancelablePromise<RevokeOldCredentialResponse>;
|
|
3421
|
+
}
|
|
3422
|
+
|
|
3423
|
+
type CreateSamlProviderRequest = {
|
|
3424
|
+
/**
|
|
3425
|
+
* SAML identity provider type
|
|
3426
|
+
*/
|
|
3427
|
+
provider_type: CreateSamlProviderRequest.provider_type;
|
|
3428
|
+
/**
|
|
3429
|
+
* Human-readable name for this provider
|
|
3430
|
+
*/
|
|
3431
|
+
name: string;
|
|
3432
|
+
/**
|
|
3433
|
+
* SAML entity ID (issuer) from the IdP metadata
|
|
3434
|
+
*/
|
|
3435
|
+
entity_id?: string;
|
|
3436
|
+
/**
|
|
3437
|
+
* IdP SSO login URL
|
|
3438
|
+
*/
|
|
3439
|
+
sso_url?: string;
|
|
3440
|
+
/**
|
|
3441
|
+
* IdP X.509 certificate (PEM format) for signature validation
|
|
3442
|
+
*/
|
|
3443
|
+
certificate?: string;
|
|
3444
|
+
/**
|
|
3445
|
+
* Optional IdP metadata XML. When set, entity_id, sso_url, and certificate are parsed from it.
|
|
3446
|
+
*/
|
|
3447
|
+
idp_metadata_xml?: string;
|
|
3448
|
+
/**
|
|
3449
|
+
* Mark this provider as the default IdP for the organization
|
|
3450
|
+
*/
|
|
3451
|
+
is_default?: boolean;
|
|
3452
|
+
};
|
|
3453
|
+
declare namespace CreateSamlProviderRequest {
|
|
3454
|
+
/**
|
|
3455
|
+
* SAML identity provider type
|
|
3456
|
+
*/
|
|
3457
|
+
enum provider_type {
|
|
3458
|
+
OKTA = "okta",
|
|
3459
|
+
ONELOGIN = "onelogin",
|
|
3460
|
+
AZURE_AD = "azure-ad",
|
|
3461
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
3462
|
+
DUO = "duo",
|
|
3463
|
+
RIPPLING = "rippling",
|
|
3464
|
+
ORACLE = "oracle",
|
|
3465
|
+
PING_IDENTITY = "ping-identity"
|
|
3466
|
+
}
|
|
3467
|
+
}
|
|
3468
|
+
|
|
3469
|
+
type SamlProviderResponse = {
|
|
3470
|
+
id: string;
|
|
3471
|
+
org_id: string;
|
|
3472
|
+
provider_type: SamlProviderResponse.provider_type;
|
|
3473
|
+
name: string;
|
|
3474
|
+
entity_id: string;
|
|
3475
|
+
sso_url: string;
|
|
3476
|
+
certificate?: string;
|
|
3477
|
+
certificate_fingerprint?: string;
|
|
3478
|
+
certificate_not_after?: string | null;
|
|
3479
|
+
enabled: boolean;
|
|
3480
|
+
is_default: boolean;
|
|
3481
|
+
last_sso_at?: string | null;
|
|
3482
|
+
created_at: string;
|
|
3483
|
+
updated_at: string;
|
|
3484
|
+
};
|
|
3485
|
+
declare namespace SamlProviderResponse {
|
|
3486
|
+
enum provider_type {
|
|
3487
|
+
OKTA = "okta",
|
|
3488
|
+
ONELOGIN = "onelogin",
|
|
3489
|
+
AZURE_AD = "azure-ad",
|
|
3490
|
+
GOOGLE_WORKSPACE = "google-workspace",
|
|
3491
|
+
DUO = "duo",
|
|
3492
|
+
RIPPLING = "rippling",
|
|
3493
|
+
ORACLE = "oracle",
|
|
3494
|
+
PING_IDENTITY = "ping-identity"
|
|
3495
|
+
}
|
|
3496
|
+
}
|
|
3497
|
+
|
|
3498
|
+
type SamlProvidersResponse = Array<SamlProviderResponse>;
|
|
3499
|
+
|
|
3500
|
+
type UpdateSamlProviderRequest = {
|
|
3501
|
+
name?: string;
|
|
3502
|
+
entity_id?: string;
|
|
3503
|
+
sso_url?: string;
|
|
3504
|
+
certificate?: string;
|
|
3505
|
+
enabled?: boolean;
|
|
3506
|
+
is_default?: boolean;
|
|
3507
|
+
idp_metadata_xml?: string;
|
|
3508
|
+
};
|
|
3509
|
+
|
|
3510
|
+
declare class SamlProvidersService {
|
|
3511
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3512
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3513
|
+
/**
|
|
3514
|
+
* Register SAML Provider
|
|
3515
|
+
* Register a new SAML identity provider for SSO authentication
|
|
3516
|
+
* @param requestBody
|
|
3517
|
+
* @returns SamlProviderResponse SAML provider created successfully
|
|
3518
|
+
* @throws ApiError
|
|
3519
|
+
*/
|
|
3520
|
+
createSamlProvider(requestBody?: CreateSamlProviderRequest): CancelablePromise<SamlProviderResponse>;
|
|
3521
|
+
/**
|
|
3522
|
+
* Get All SAML Providers
|
|
3523
|
+
* Retrieve all SAML providers for the organization
|
|
3524
|
+
* @returns SamlProvidersResponse SAML providers retrieved successfully
|
|
3525
|
+
* @throws ApiError
|
|
3526
|
+
*/
|
|
3527
|
+
getAllSamlProviders(): CancelablePromise<SamlProvidersResponse>;
|
|
3528
|
+
/**
|
|
3529
|
+
* Get SAML Provider
|
|
3530
|
+
* Retrieve a specific SAML provider. Certificate PEM is omitted unless include=certificate.
|
|
3531
|
+
* @param id
|
|
3532
|
+
* @returns SamlProviderResponse SAML provider retrieved successfully
|
|
3533
|
+
* @throws ApiError
|
|
3534
|
+
*/
|
|
3535
|
+
getSamlProvider(id: string): CancelablePromise<SamlProviderResponse>;
|
|
3536
|
+
/**
|
|
3537
|
+
* Update SAML Provider
|
|
3538
|
+
* Update an existing SAML provider
|
|
3539
|
+
* @param id
|
|
3540
|
+
* @param requestBody
|
|
3541
|
+
* @returns ErrorResponse SAML provider updated successfully
|
|
3542
|
+
* @throws ApiError
|
|
3543
|
+
*/
|
|
3544
|
+
updateSamlProvider(id: string, requestBody?: UpdateSamlProviderRequest): CancelablePromise<ErrorResponse>;
|
|
3545
|
+
/**
|
|
3546
|
+
* Delete SAML Provider
|
|
3547
|
+
* Delete an existing SAML provider
|
|
3548
|
+
* @param id
|
|
3549
|
+
* @returns ErrorResponse SAML provider deleted successfully
|
|
3550
|
+
* @throws ApiError
|
|
3551
|
+
*/
|
|
3552
|
+
deleteSamlProvider(id: string): CancelablePromise<ErrorResponse>;
|
|
3553
|
+
/**
|
|
3554
|
+
* Get SAML SP Metadata
|
|
3555
|
+
* Redirects to the public SP metadata URL for this organization
|
|
3556
|
+
* @param id
|
|
3557
|
+
* @returns void
|
|
3558
|
+
* @throws ApiError
|
|
3559
|
+
*/
|
|
3560
|
+
getSamlMetadata(id: string): CancelablePromise<void>;
|
|
3561
|
+
}
|
|
3562
|
+
|
|
3563
|
+
type PublicSamlSsoRequest = {
|
|
3564
|
+
/**
|
|
3565
|
+
* Optional SAML provider ID. Must belong to the organization and be enabled.
|
|
3566
|
+
*/
|
|
3567
|
+
provider_id?: string;
|
|
3568
|
+
};
|
|
3569
|
+
|
|
3570
|
+
type SamlSsoResponse = {
|
|
3571
|
+
/**
|
|
3572
|
+
* URL to redirect the user to for IdP authentication
|
|
3573
|
+
*/
|
|
3574
|
+
redirect_url: string;
|
|
3575
|
+
/**
|
|
3576
|
+
* AuthnRequest ID for tracking
|
|
3577
|
+
*/
|
|
3578
|
+
request_id: string;
|
|
3579
|
+
};
|
|
3580
|
+
|
|
3581
|
+
declare class SamlSsoService {
|
|
3582
|
+
readonly httpRequest: BaseHttpRequest;
|
|
3583
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
3584
|
+
/**
|
|
3585
|
+
* Get public SAML SP metadata
|
|
3586
|
+
* Unauthenticated SP metadata XML for the organization
|
|
3587
|
+
* @param orgId
|
|
3588
|
+
* @returns string SP metadata XML
|
|
3589
|
+
* @throws ApiError
|
|
3590
|
+
*/
|
|
3591
|
+
getPublicSamlMetadata(orgId: string): CancelablePromise<string>;
|
|
3592
|
+
/**
|
|
3593
|
+
* SAML Assertion Consumer Service
|
|
3594
|
+
* Receive and validate a SAML Response from the identity provider
|
|
3595
|
+
* @param orgId
|
|
3596
|
+
* @returns void
|
|
3597
|
+
* @throws ApiError
|
|
3598
|
+
*/
|
|
3599
|
+
handlePublicSamlAcs(orgId: string): CancelablePromise<void>;
|
|
3600
|
+
/**
|
|
3601
|
+
* Start SAML SSO
|
|
3602
|
+
* Unauthenticated SP-initiated start. Returns a redirect URL for the login page or CLI.
|
|
3603
|
+
* @param orgSlug
|
|
3604
|
+
* @param requestBody
|
|
3605
|
+
* @returns SamlSsoResponse Redirect URL generated
|
|
3606
|
+
* @throws ApiError
|
|
3607
|
+
*/
|
|
3608
|
+
startPublicSamlSso(orgSlug: string, requestBody?: PublicSamlSsoRequest): CancelablePromise<SamlSsoResponse>;
|
|
3609
|
+
/**
|
|
3610
|
+
* Bookmark SAML SSO start
|
|
3611
|
+
* Success redirects to the IdP. Any error redirects to the dashboard login page.
|
|
3612
|
+
* @param orgSlug
|
|
3613
|
+
* @returns void
|
|
3614
|
+
* @throws ApiError
|
|
3615
|
+
*/
|
|
3616
|
+
startPublicSamlSsoRedirect(orgSlug: string): CancelablePromise<void>;
|
|
3617
|
+
}
|
|
3618
|
+
|
|
2072
3619
|
type BatchCreateSecretsRequest = {
|
|
2073
3620
|
app_id: string;
|
|
2074
3621
|
env_type_id: string;
|
|
@@ -2482,10 +4029,6 @@ type CreateServiceTokenResponse = {
|
|
|
2482
4029
|
created_at: string;
|
|
2483
4030
|
};
|
|
2484
4031
|
|
|
2485
|
-
type ErrorResponse = {
|
|
2486
|
-
error: string;
|
|
2487
|
-
};
|
|
2488
|
-
|
|
2489
4032
|
type ServiceTokenResponse = {
|
|
2490
4033
|
id: string;
|
|
2491
4034
|
name: string;
|
|
@@ -2535,59 +4078,89 @@ declare class ServiceTokensService {
|
|
|
2535
4078
|
deleteServiceToken(id: string): CancelablePromise<ErrorResponse>;
|
|
2536
4079
|
}
|
|
2537
4080
|
|
|
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;
|
|
4081
|
+
type CreateSetupOrgRequest = {
|
|
4082
|
+
org_name: string;
|
|
4083
|
+
org_slug?: string;
|
|
4084
|
+
admin_email: string;
|
|
4085
|
+
admin_full_name?: string;
|
|
4086
|
+
admin_password: string;
|
|
2552
4087
|
};
|
|
2553
|
-
|
|
2554
|
-
|
|
2555
|
-
|
|
2556
|
-
|
|
2557
|
-
|
|
2558
|
-
|
|
2559
|
-
|
|
2560
|
-
|
|
4088
|
+
|
|
4089
|
+
type SetupStatusResponse = {
|
|
4090
|
+
deployment_mode: SetupStatusResponse.deployment_mode;
|
|
4091
|
+
edition: SetupStatusResponse.edition;
|
|
4092
|
+
org_count: number;
|
|
4093
|
+
max_orgs: number | null;
|
|
4094
|
+
can_create_organization: boolean;
|
|
4095
|
+
first_org_ready: boolean;
|
|
4096
|
+
channel: string;
|
|
4097
|
+
};
|
|
4098
|
+
declare namespace SetupStatusResponse {
|
|
4099
|
+
enum deployment_mode {
|
|
4100
|
+
HOSTED = "hosted",
|
|
4101
|
+
SELFHOSTED = "selfhosted"
|
|
2561
4102
|
}
|
|
2562
|
-
enum
|
|
2563
|
-
|
|
2564
|
-
|
|
2565
|
-
CERTIFICATE = "certificate"
|
|
4103
|
+
enum edition {
|
|
4104
|
+
OSS = "oss",
|
|
4105
|
+
ENTERPRISE = "enterprise"
|
|
2566
4106
|
}
|
|
2567
4107
|
}
|
|
2568
4108
|
|
|
2569
|
-
|
|
2570
|
-
|
|
2571
|
-
|
|
2572
|
-
|
|
2573
|
-
|
|
2574
|
-
|
|
4109
|
+
declare class SetupService {
|
|
4110
|
+
readonly httpRequest: BaseHttpRequest;
|
|
4111
|
+
constructor(httpRequest: BaseHttpRequest);
|
|
4112
|
+
/**
|
|
4113
|
+
* Operator setup status (self-host)
|
|
4114
|
+
* @returns SetupStatusResponse Setup status
|
|
4115
|
+
* @throws ApiError
|
|
4116
|
+
*/
|
|
4117
|
+
getSetupStatus(): CancelablePromise<SetupStatusResponse>;
|
|
4118
|
+
/**
|
|
4119
|
+
* Create organization via operator setup token (self-host only)
|
|
4120
|
+
* @param requestBody
|
|
4121
|
+
* @returns any Organization created
|
|
4122
|
+
* @throws ApiError
|
|
4123
|
+
*/
|
|
4124
|
+
createSetupOrganization(requestBody?: CreateSetupOrgRequest): CancelablePromise<{
|
|
4125
|
+
message: string;
|
|
4126
|
+
org_id: string;
|
|
4127
|
+
admin_user_id: string;
|
|
4128
|
+
source: string;
|
|
4129
|
+
first_org: boolean;
|
|
4130
|
+
}>;
|
|
4131
|
+
}
|
|
2575
4132
|
|
|
2576
4133
|
type SystemStatusState = {
|
|
2577
4134
|
edition: SystemStatusState.edition;
|
|
4135
|
+
deployment_mode?: SystemStatusState.deployment_mode;
|
|
2578
4136
|
single_org_mode: boolean;
|
|
4137
|
+
max_orgs?: number | null;
|
|
4138
|
+
public_signup_enabled?: boolean;
|
|
4139
|
+
can_create_organization?: boolean;
|
|
2579
4140
|
management_enabled: boolean;
|
|
2580
4141
|
observability_enabled: boolean;
|
|
2581
4142
|
management_web_enabled: boolean;
|
|
2582
4143
|
landing_enabled: boolean;
|
|
2583
4144
|
first_bootstrap_completed_at?: string | null;
|
|
2584
4145
|
org_count: number;
|
|
4146
|
+
entitlement?: {
|
|
4147
|
+
present: boolean;
|
|
4148
|
+
source: string | null;
|
|
4149
|
+
in_grace: boolean;
|
|
4150
|
+
features: Array<string>;
|
|
4151
|
+
max_orgs: number | null;
|
|
4152
|
+
expires_at: string | null;
|
|
4153
|
+
};
|
|
2585
4154
|
};
|
|
2586
4155
|
declare namespace SystemStatusState {
|
|
2587
4156
|
enum edition {
|
|
2588
4157
|
OSS = "oss",
|
|
2589
4158
|
ENTERPRISE = "enterprise"
|
|
2590
4159
|
}
|
|
4160
|
+
enum deployment_mode {
|
|
4161
|
+
HOSTED = "hosted",
|
|
4162
|
+
SELFHOSTED = "selfhosted"
|
|
4163
|
+
}
|
|
2591
4164
|
}
|
|
2592
4165
|
|
|
2593
4166
|
type SystemStatusResponse = {
|
|
@@ -2604,6 +4177,12 @@ declare class SystemService {
|
|
|
2604
4177
|
* @throws ApiError
|
|
2605
4178
|
*/
|
|
2606
4179
|
getManagementSystemStatus(): CancelablePromise<SystemStatusResponse>;
|
|
4180
|
+
/**
|
|
4181
|
+
* Get Management System Status
|
|
4182
|
+
* @returns SystemStatusResponse Management system status
|
|
4183
|
+
* @throws ApiError
|
|
4184
|
+
*/
|
|
4185
|
+
manageGetManagementSystemStatus(): CancelablePromise<SystemStatusResponse>;
|
|
2607
4186
|
}
|
|
2608
4187
|
|
|
2609
4188
|
type AddTeamMemberRequest = {
|
|
@@ -2823,7 +4402,7 @@ declare class UsersService {
|
|
|
2823
4402
|
* @returns UserResponse User role updated successfully
|
|
2824
4403
|
* @throws ApiError
|
|
2825
4404
|
*/
|
|
2826
|
-
|
|
4405
|
+
updateUserRole(id: string, requestBody?: UpdateRoleRequest): CancelablePromise<UserResponse>;
|
|
2827
4406
|
/**
|
|
2828
4407
|
* Update User Password
|
|
2829
4408
|
* Update a user's password (Admin only)
|
|
@@ -2979,20 +4558,31 @@ declare class EnvSyncAPISDK {
|
|
|
2979
4558
|
readonly authentication: AuthenticationService;
|
|
2980
4559
|
readonly certificates: CertificatesService;
|
|
2981
4560
|
readonly changeRequests: ChangeRequestsService;
|
|
4561
|
+
readonly dynamicSecrets: DynamicSecretsService;
|
|
4562
|
+
readonly enterprise: EnterpriseService;
|
|
4563
|
+
readonly enterpriseCmk: EnterpriseCmkService;
|
|
2982
4564
|
readonly environmentTypes: EnvironmentTypesService;
|
|
2983
4565
|
readonly environmentVariables: EnvironmentVariablesService;
|
|
2984
4566
|
readonly environmentVariablesPointInTime: EnvironmentVariablesPointInTimeService;
|
|
2985
4567
|
readonly environmentVariablesRollback: EnvironmentVariablesRollbackService;
|
|
2986
4568
|
readonly fileUpload: FileUploadService;
|
|
2987
4569
|
readonly gpgKeys: GpgKeysService;
|
|
4570
|
+
readonly license: LicenseService;
|
|
4571
|
+
readonly logForwarding: LogForwardingService;
|
|
4572
|
+
readonly oidcProviders: OidcProvidersService;
|
|
2988
4573
|
readonly onboarding: OnboardingService;
|
|
2989
4574
|
readonly organizations: OrganizationsService;
|
|
4575
|
+
readonly orgFeatures: OrgFeaturesService;
|
|
2990
4576
|
readonly permissions: PermissionsService;
|
|
2991
4577
|
readonly roles: RolesService;
|
|
4578
|
+
readonly rotation: RotationService;
|
|
4579
|
+
readonly samlProviders: SamlProvidersService;
|
|
4580
|
+
readonly samlSso: SamlSsoService;
|
|
2992
4581
|
readonly secrets: SecretsService;
|
|
2993
4582
|
readonly secretsPointInTime: SecretsPointInTimeService;
|
|
2994
4583
|
readonly secretsRollback: SecretsRollbackService;
|
|
2995
4584
|
readonly serviceTokens: ServiceTokensService;
|
|
4585
|
+
readonly setup: SetupService;
|
|
2996
4586
|
readonly system: SystemService;
|
|
2997
4587
|
readonly teams: TeamsService;
|
|
2998
4588
|
readonly users: UsersService;
|
|
@@ -3018,6 +4608,18 @@ declare class ApiError extends Error {
|
|
|
3018
4608
|
constructor(request: ApiRequestOptions, response: ApiResult, message: string);
|
|
3019
4609
|
}
|
|
3020
4610
|
|
|
4611
|
+
type OrgFeatureGrantParam = {
|
|
4612
|
+
orgId: string;
|
|
4613
|
+
};
|
|
4614
|
+
|
|
4615
|
+
type OrgKmsBreakGlassParam = {
|
|
4616
|
+
orgId: string;
|
|
4617
|
+
};
|
|
4618
|
+
|
|
4619
|
+
type OrgKmsJobParam = {
|
|
4620
|
+
id: string;
|
|
4621
|
+
};
|
|
4622
|
+
|
|
3021
4623
|
type UploadFileError = {
|
|
3022
4624
|
error: string;
|
|
3023
4625
|
};
|
|
@@ -3027,4 +4629,4 @@ type UploadFileError = {
|
|
|
3027
4629
|
*/
|
|
3028
4630
|
type XEnvSyncOrgIdHeader = string;
|
|
3029
4631
|
|
|
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,
|
|
4632
|
+
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 CreateOrgKmsCredentialRequest, 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, EnterpriseCmkService, 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 OrgFeatureGrantParam, type OrgFeatureGrantResponse, OrgFeaturesService, type OrgKmsAppKeyInfo, type OrgKmsAppsResponse, type OrgKmsBreakGlassParam, OrgKmsConfigResponse, type OrgKmsCredentialResponse, type OrgKmsJobParam, OrgKmsJobResponse, OrgKmsVerifyResponse, type OrgResponse, type OrgSecret, type OrgSecretModelResponse, type OrgSecretsResponse, OrganizationsService, type PermissionMessageResponse, PermissionsService, type PromotionChangeRequestBody, ProviderConnection, type ProviderConnectionsResponse, type PublicSamlSsoRequest, PutOrgFeatureGrantRequest, 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 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, UpdateOrgKmsConfigRequest, 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, WhoAmIResponse, type XEnvSyncOrgIdHeader };
|