@sphereon/ssi-sdk.kms-rest-client 0.34.1-next.299 → 0.34.1-next.323

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -4,7 +4,7 @@ import { BearerTokenArg } from '@sphereon/ssi-types';
4
4
  var IKmsRestClient$1 = {
5
5
  components: {
6
6
  schemas: {
7
- KmsCreateRawSignatureArgs: {
7
+ KmsClientCreateRawSignatureArgs: {
8
8
  type: "object",
9
9
  additionalProperties: false,
10
10
  properties: {
@@ -271,7 +271,7 @@ var IKmsRestClient$1 = {
271
271
  additionalProperties: false,
272
272
  description: "Response body containing the created signature."
273
273
  },
274
- KmsDeleteKeyArgs: {
274
+ KmsClientDeleteKeyArgs: {
275
275
  type: "object",
276
276
  properties: {
277
277
  baseUrl: {
@@ -281,9 +281,12 @@ var IKmsRestClient$1 = {
281
281
  type: "string"
282
282
  }
283
283
  },
284
+ required: [
285
+ "aliasOrKid"
286
+ ],
284
287
  additionalProperties: false
285
288
  },
286
- KmsGenerateKeyArgs: {
289
+ KmsClientGenerateKeyArgs: {
287
290
  type: "object",
288
291
  additionalProperties: false,
289
292
  properties: {
@@ -312,6 +315,19 @@ var IKmsRestClient$1 = {
312
315
  }
313
316
  }
314
317
  },
318
+ GenerateKeyResponse: {
319
+ type: "object",
320
+ properties: {
321
+ keyPair: {
322
+ $ref: "#/components/schemas/ManagedKeyPair"
323
+ }
324
+ },
325
+ required: [
326
+ "keyPair"
327
+ ],
328
+ additionalProperties: false,
329
+ description: "Response body containing a generated key pair."
330
+ },
315
331
  ManagedKeyPair: {
316
332
  type: "object",
317
333
  properties: {
@@ -440,7 +456,7 @@ var IKmsRestClient$1 = {
440
456
  additionalProperties: false,
441
457
  description: "Data class representing a cryptographic key pair used with JOSE (JSON Object Signing and Encryption)."
442
458
  },
443
- KmsGetKeyArgs: {
459
+ KmsClientGetKeyArgs: {
444
460
  type: "object",
445
461
  properties: {
446
462
  baseUrl: {
@@ -455,6 +471,19 @@ var IKmsRestClient$1 = {
455
471
  ],
456
472
  additionalProperties: false
457
473
  },
474
+ GetKeyResponse: {
475
+ type: "object",
476
+ properties: {
477
+ keyInfo: {
478
+ $ref: "#/components/schemas/ManagedKeyInfo"
479
+ }
480
+ },
481
+ required: [
482
+ "keyInfo"
483
+ ],
484
+ additionalProperties: false,
485
+ description: "Response body containing a managed key."
486
+ },
458
487
  ManagedKeyInfo: {
459
488
  type: "object",
460
489
  properties: {
@@ -508,7 +537,7 @@ var IKmsRestClient$1 = {
508
537
  additionalProperties: false,
509
538
  description: "Represents a managed cryptographic key information that is guaranteed to be present and resolved, part of a KMS providing concrete access to the key."
510
539
  },
511
- KmsGetKeyProviderArgs: {
540
+ KmsClientGetKeyProviderArgs: {
512
541
  type: "object",
513
542
  properties: {
514
543
  baseUrl: {
@@ -518,6 +547,9 @@ var IKmsRestClient$1 = {
518
547
  type: "string"
519
548
  }
520
549
  },
550
+ required: [
551
+ "providerId"
552
+ ],
521
553
  additionalProperties: false
522
554
  },
523
555
  KeyProviderResponse: {
@@ -547,7 +579,7 @@ var IKmsRestClient$1 = {
547
579
  ],
548
580
  description: "The type of Key Provider. Determines the required configuration settings. - AZURE_KEYVAULT: Microsoft Azure Key Vault or Managed HSM. - AWS_KMS: Amazon Web Services Key Management Service."
549
581
  },
550
- kmsGetResolverArgs: {
582
+ kmsClientGetResolverArgs: {
551
583
  type: "object",
552
584
  properties: {
553
585
  baseUrl: {
@@ -601,7 +633,7 @@ var IKmsRestClient$1 = {
601
633
  ],
602
634
  description: "Method used to identify cryptographic keys."
603
635
  },
604
- KmsIsValidRawSignatureArgs: {
636
+ KmsClientIsValidRawSignatureArgs: {
605
637
  type: "object",
606
638
  additionalProperties: false,
607
639
  properties: {
@@ -638,7 +670,7 @@ var IKmsRestClient$1 = {
638
670
  additionalProperties: false,
639
671
  description: "Response body containing the details of the signature verification."
640
672
  },
641
- KmsListKeyProvidersArgs: {
673
+ KmsClientListKeyProvidersArgs: {
642
674
  type: "object",
643
675
  properties: {
644
676
  baseUrl: {
@@ -681,7 +713,7 @@ var IKmsRestClient$1 = {
681
713
  additionalProperties: false,
682
714
  description: "Response body containing the details of a Key Provider instance."
683
715
  },
684
- KmsListKeysArgs: {
716
+ KmsClientListKeysArgs: {
685
717
  type: "object",
686
718
  properties: {
687
719
  baseUrl: {
@@ -709,7 +741,7 @@ var IKmsRestClient$1 = {
709
741
  additionalProperties: false,
710
742
  description: "Response body containing all the managed keys."
711
743
  },
712
- KmsListResolversArgs: {
744
+ KmsClientListResolversArgs: {
713
745
  type: "object",
714
746
  properties: {
715
747
  baseUrl: {
@@ -734,7 +766,7 @@ var IKmsRestClient$1 = {
734
766
  additionalProperties: false,
735
767
  description: "Response body containing all the resolvers."
736
768
  },
737
- KmsProviderDeleteKeyArgs: {
769
+ KmsClientProviderDeleteKeyArgs: {
738
770
  type: "object",
739
771
  properties: {
740
772
  baseUrl: {
@@ -753,7 +785,7 @@ var IKmsRestClient$1 = {
753
785
  ],
754
786
  additionalProperties: false
755
787
  },
756
- KmsProviderGenerateKey: {
788
+ KmsClientProviderGenerateKeyArgs: {
757
789
  type: "object",
758
790
  additionalProperties: false,
759
791
  properties: {
@@ -784,7 +816,7 @@ var IKmsRestClient$1 = {
784
816
  "providerId"
785
817
  ]
786
818
  },
787
- KmsProviderGetKeyArgs: {
819
+ KmsClientProviderGetKeyArgs: {
788
820
  type: "object",
789
821
  properties: {
790
822
  baseUrl: {
@@ -803,7 +835,7 @@ var IKmsRestClient$1 = {
803
835
  ],
804
836
  additionalProperties: false
805
837
  },
806
- KmsProviderListKeysArgs: {
838
+ KmsClientProviderListKeysArgs: {
807
839
  type: "object",
808
840
  properties: {
809
841
  baseUrl: {
@@ -818,7 +850,7 @@ var IKmsRestClient$1 = {
818
850
  ],
819
851
  additionalProperties: false
820
852
  },
821
- KmsProviderStoreKey: {
853
+ KmsClientProviderStoreKeyArgs: {
822
854
  type: "object",
823
855
  additionalProperties: false,
824
856
  properties: {
@@ -895,7 +927,20 @@ var IKmsRestClient$1 = {
895
927
  additionalProperties: false,
896
928
  description: "Represents a resolved cryptographic key information where the key is guaranteed to be present and resolved, providing concrete access to the key."
897
929
  },
898
- KmsResolveKeyArgs: {
930
+ StoreKeyResponse: {
931
+ type: "object",
932
+ properties: {
933
+ keyInfo: {
934
+ $ref: "#/components/schemas/ManagedKeyInfo"
935
+ }
936
+ },
937
+ required: [
938
+ "keyInfo"
939
+ ],
940
+ additionalProperties: false,
941
+ description: "Response body containing a stored key."
942
+ },
943
+ KmsClientResolveKeyArgs: {
899
944
  type: "object",
900
945
  additionalProperties: false,
901
946
  properties: {
@@ -942,7 +987,7 @@ var IKmsRestClient$1 = {
942
987
  type: "string"
943
988
  }
944
989
  },
945
- KmsStoreKeyArgs: {
990
+ KmsClientStoreKeyArgs: {
946
991
  type: "object",
947
992
  additionalProperties: false,
948
993
  properties: {
@@ -966,157 +1011,157 @@ var IKmsRestClient$1 = {
966
1011
  }
967
1012
  },
968
1013
  methods: {
969
- kmsCreateRawSignature: {
1014
+ kmsClientCreateRawSignature: {
970
1015
  description: "",
971
1016
  "arguments": {
972
- $ref: "#/components/schemas/KmsCreateRawSignatureArgs"
1017
+ $ref: "#/components/schemas/KmsClientCreateRawSignatureArgs"
973
1018
  },
974
1019
  returnType: {
975
1020
  $ref: "#/components/schemas/CreateRawSignatureResponse"
976
1021
  }
977
1022
  },
978
- kmsDeleteKey: {
1023
+ kmsClientDeleteKey: {
979
1024
  description: "",
980
1025
  "arguments": {
981
- $ref: "#/components/schemas/KmsDeleteKeyArgs"
1026
+ $ref: "#/components/schemas/KmsClientDeleteKeyArgs"
982
1027
  },
983
1028
  returnType: {
984
1029
  type: "boolean"
985
1030
  }
986
1031
  },
987
- kmsGenerateKey: {
1032
+ kmsClientGenerateKey: {
988
1033
  description: "",
989
1034
  "arguments": {
990
- $ref: "#/components/schemas/KmsGenerateKeyArgs"
1035
+ $ref: "#/components/schemas/KmsClientGenerateKeyArgs"
991
1036
  },
992
1037
  returnType: {
993
- $ref: "#/components/schemas/ManagedKeyPair"
1038
+ $ref: "#/components/schemas/GenerateKeyResponse"
994
1039
  }
995
1040
  },
996
- kmsGetKey: {
1041
+ kmsClientGetKey: {
997
1042
  description: "",
998
1043
  "arguments": {
999
- $ref: "#/components/schemas/KmsGetKeyArgs"
1044
+ $ref: "#/components/schemas/KmsClientGetKeyArgs"
1000
1045
  },
1001
1046
  returnType: {
1002
- $ref: "#/components/schemas/ManagedKeyInfo"
1047
+ $ref: "#/components/schemas/GetKeyResponse"
1003
1048
  }
1004
1049
  },
1005
- kmsGetKeyProvider: {
1050
+ kmsClientGetKeyProvider: {
1006
1051
  description: "",
1007
1052
  "arguments": {
1008
- $ref: "#/components/schemas/KmsGetKeyProviderArgs"
1053
+ $ref: "#/components/schemas/KmsClientGetKeyProviderArgs"
1009
1054
  },
1010
1055
  returnType: {
1011
1056
  $ref: "#/components/schemas/KeyProviderResponse"
1012
1057
  }
1013
1058
  },
1014
- kmsGetResolver: {
1059
+ kmsClientGetResolver: {
1015
1060
  description: "",
1016
1061
  "arguments": {
1017
- $ref: "#/components/schemas/kmsGetResolverArgs"
1062
+ $ref: "#/components/schemas/kmsClientGetResolverArgs"
1018
1063
  },
1019
1064
  returnType: {
1020
1065
  $ref: "#/components/schemas/Resolver"
1021
1066
  }
1022
1067
  },
1023
- kmsIsValidRawSignature: {
1068
+ kmsClientIsValidRawSignature: {
1024
1069
  description: "",
1025
1070
  "arguments": {
1026
- $ref: "#/components/schemas/KmsIsValidRawSignatureArgs"
1071
+ $ref: "#/components/schemas/KmsClientIsValidRawSignatureArgs"
1027
1072
  },
1028
1073
  returnType: {
1029
1074
  $ref: "#/components/schemas/VerifyRawSignatureResponse"
1030
1075
  }
1031
1076
  },
1032
- kmsListKeyProviders: {
1077
+ kmsClientListKeyProviders: {
1033
1078
  description: "",
1034
1079
  "arguments": {
1035
- $ref: "#/components/schemas/KmsListKeyProvidersArgs"
1080
+ $ref: "#/components/schemas/KmsClientListKeyProvidersArgs"
1036
1081
  },
1037
1082
  returnType: {
1038
1083
  $ref: "#/components/schemas/ListKeyProvidersResponse"
1039
1084
  }
1040
1085
  },
1041
- kmsListKeys: {
1086
+ kmsClientListKeys: {
1042
1087
  description: "",
1043
1088
  "arguments": {
1044
- $ref: "#/components/schemas/KmsListKeysArgs"
1089
+ $ref: "#/components/schemas/KmsClientListKeysArgs"
1045
1090
  },
1046
1091
  returnType: {
1047
1092
  $ref: "#/components/schemas/ListKeysResponse"
1048
1093
  }
1049
1094
  },
1050
- kmsListResolvers: {
1095
+ kmsClientListResolvers: {
1051
1096
  description: "",
1052
1097
  "arguments": {
1053
- $ref: "#/components/schemas/KmsListResolversArgs"
1098
+ $ref: "#/components/schemas/KmsClientListResolversArgs"
1054
1099
  },
1055
1100
  returnType: {
1056
1101
  $ref: "#/components/schemas/ListResolversResponse"
1057
1102
  }
1058
1103
  },
1059
- kmsProviderDeleteKey: {
1104
+ kmsClientProviderDeleteKey: {
1060
1105
  description: "",
1061
1106
  "arguments": {
1062
- $ref: "#/components/schemas/KmsProviderDeleteKeyArgs"
1107
+ $ref: "#/components/schemas/KmsClientProviderDeleteKeyArgs"
1063
1108
  },
1064
1109
  returnType: {
1065
1110
  type: "boolean"
1066
1111
  }
1067
1112
  },
1068
- kmsProviderGenerateKey: {
1113
+ kmsClientProviderGenerateKey: {
1069
1114
  description: "",
1070
1115
  "arguments": {
1071
- $ref: "#/components/schemas/KmsProviderGenerateKey"
1116
+ $ref: "#/components/schemas/KmsClientProviderGenerateKeyArgs"
1072
1117
  },
1073
1118
  returnType: {
1074
- $ref: "#/components/schemas/ManagedKeyPair"
1119
+ $ref: "#/components/schemas/GenerateKeyResponse"
1075
1120
  }
1076
1121
  },
1077
- kmsProviderGetKey: {
1122
+ kmsClientProviderGetKey: {
1078
1123
  description: "",
1079
1124
  "arguments": {
1080
- $ref: "#/components/schemas/KmsProviderGetKeyArgs"
1125
+ $ref: "#/components/schemas/KmsClientProviderGetKeyArgs"
1081
1126
  },
1082
1127
  returnType: {
1083
- $ref: "#/components/schemas/ManagedKeyInfo"
1128
+ $ref: "#/components/schemas/GetKeyResponse"
1084
1129
  }
1085
1130
  },
1086
- kmsProviderListKeys: {
1131
+ kmsClientProviderListKeys: {
1087
1132
  description: "",
1088
1133
  "arguments": {
1089
- $ref: "#/components/schemas/KmsProviderListKeysArgs"
1134
+ $ref: "#/components/schemas/KmsClientProviderListKeysArgs"
1090
1135
  },
1091
1136
  returnType: {
1092
1137
  $ref: "#/components/schemas/ListKeysResponse"
1093
1138
  }
1094
1139
  },
1095
- kmsProviderStoreKey: {
1140
+ kmsClientProviderStoreKey: {
1096
1141
  description: "",
1097
1142
  "arguments": {
1098
- $ref: "#/components/schemas/KmsProviderStoreKey"
1143
+ $ref: "#/components/schemas/KmsClientProviderStoreKeyArgs"
1099
1144
  },
1100
1145
  returnType: {
1101
- $ref: "#/components/schemas/ManagedKeyInfo"
1146
+ $ref: "#/components/schemas/StoreKeyResponse"
1102
1147
  }
1103
1148
  },
1104
- kmsResolveKey: {
1149
+ kmsClientResolveKey: {
1105
1150
  description: "",
1106
1151
  "arguments": {
1107
- $ref: "#/components/schemas/KmsResolveKeyArgs"
1152
+ $ref: "#/components/schemas/KmsClientResolveKeyArgs"
1108
1153
  },
1109
1154
  returnType: {
1110
1155
  $ref: "#/components/schemas/ResolvedKeyInfo"
1111
1156
  }
1112
1157
  },
1113
- kmsStoreKey: {
1158
+ kmsClientStoreKey: {
1114
1159
  description: "",
1115
1160
  "arguments": {
1116
- $ref: "#/components/schemas/KmsStoreKeyArgs"
1161
+ $ref: "#/components/schemas/KmsClientStoreKeyArgs"
1117
1162
  },
1118
1163
  returnType: {
1119
- $ref: "#/components/schemas/ManagedKeyInfo"
1164
+ $ref: "#/components/schemas/StoreKeyResponse"
1120
1165
  }
1121
1166
  }
1122
1167
  }