-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
keys.json
566 lines (566 loc) · 16.9 KB
/
keys.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
{
"swagger": "2.0",
"info": {
"version": "2021-10-01",
"title": "KeyVaultManagementClient",
"description": "The Azure management API provides a RESTful set of web services that interact with Azure Key Vault."
},
"host": "management.azure.com",
"schemes": [
"https"
],
"paths": {
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}": {
"put": {
"tags": [
"Keys"
],
"operationId": "Keys_CreateIfNotExist",
"description": "Creates the first version of a new key if it does not exist. If it already exists, then the existing key is returned without any write operations being performed. This API does not create subsequent versions, and does not update existing keys.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group which contains the specified key vault."
},
{
"name": "vaultName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "The name of the key vault which contains the key to be created."
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{1,127}$",
"description": "The name of the key to be created."
},
{
"$ref": "#/parameters/ApiVersionParameter"
},
{
"name": "parameters",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/KeyCreateParameters"
},
"description": "The parameters used to create the specified key."
}
],
"responses": {
"200": {
"description": "The created key.",
"schema": {
"$ref": "#/definitions/Key"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"Create a key": {
"$ref": "./examples/createKey.json"
}
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
},
"get": {
"tags": [
"Keys"
],
"operationId": "Keys_Get",
"description": "Gets the current version of the specified key from the specified key vault.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group which contains the specified key vault."
},
{
"name": "vaultName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "The name of the vault which contains the key to be retrieved."
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{1,127}$",
"description": "The name of the key to be retrieved."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The retrieved key.",
"schema": {
"$ref": "#/definitions/Key"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"Get a key": {
"$ref": "./examples/getKey.json"
}
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys": {
"get": {
"tags": [
"Keys"
],
"operationId": "Keys_List",
"description": "Lists the keys in the specified key vault.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group which contains the specified key vault."
},
{
"name": "vaultName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "The name of the vault which contains the keys to be retrieved."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The retrieved page of keys.",
"schema": {
"$ref": "#/definitions/KeyListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"List keys in the vault": {
"$ref": "./examples/listKeys.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions/{keyVersion}": {
"get": {
"tags": [
"Keys"
],
"operationId": "Keys_GetVersion",
"description": "Gets the specified version of the specified key in the specified key vault.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group which contains the specified key vault."
},
{
"name": "vaultName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "The name of the vault which contains the key version to be retrieved."
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{1,127}$",
"description": "The name of the key version to be retrieved."
},
{
"name": "keyVersion",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-fA-F0-9]{32}$",
"description": "The version of the key to be retrieved."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The retrieved key version.",
"schema": {
"$ref": "#/definitions/Key"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"Get a key version": {
"$ref": "./examples/getKeyVersion.json"
}
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
}
},
"/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}/keys/{keyName}/versions": {
"get": {
"tags": [
"Keys"
],
"operationId": "Keys_ListVersions",
"description": "Lists the versions of the specified key in the specified key vault.",
"parameters": [
{
"$ref": "#/parameters/SubscriptionIdParameter"
},
{
"name": "resourceGroupName",
"in": "path",
"required": true,
"type": "string",
"description": "The name of the resource group which contains the specified key vault."
},
{
"name": "vaultName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{3,24}$",
"description": "The name of the vault which contains the key versions to be retrieved."
},
{
"name": "keyName",
"in": "path",
"required": true,
"type": "string",
"pattern": "^[a-zA-Z0-9-]{1,127}$",
"description": "The name of the key versions to be retrieved."
},
{
"$ref": "#/parameters/ApiVersionParameter"
}
],
"responses": {
"200": {
"description": "The retrieved page of key versions.",
"schema": {
"$ref": "#/definitions/KeyListResult"
}
},
"default": {
"description": "Error response describing why the operation failed.",
"schema": {
"$ref": "common.json#/definitions/CloudError"
}
}
},
"x-ms-examples": {
"List key versions in the vault": {
"$ref": "./examples/listKeyVersions.json"
}
},
"x-ms-pageable": {
"nextLinkName": "nextLink"
},
"produces": [
"application/json"
],
"consumes": [
"application/json"
]
}
}
},
"definitions": {
"KeyProperties": {
"properties": {
"attributes": {
"$ref": "#/definitions/KeyAttributes",
"description": "The attributes of the key."
},
"kty": {
"type": "string",
"minLength": 1,
"description": "The type of the key. For valid values, see JsonWebKeyType.",
"enum": [
"EC",
"EC-HSM",
"RSA",
"RSA-HSM"
],
"x-ms-enum": {
"name": "JsonWebKeyType",
"modelAsString": true
}
},
"keyOps": {
"type": "array",
"items": {
"type": "string",
"description": "The permitted JSON web key operations of the key. For more information, see JsonWebKeyOperation.",
"enum": [
"encrypt",
"decrypt",
"sign",
"verify",
"wrapKey",
"unwrapKey",
"import"
],
"x-ms-enum": {
"name": "JsonWebKeyOperation",
"modelAsString": true
}
}
},
"keySize": {
"type": "integer",
"format": "int32",
"description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA."
},
"curveName": {
"type": "string",
"description": "The elliptic curve name. For valid values, see JsonWebKeyCurveName.",
"enum": [
"P-256",
"P-384",
"P-521",
"P-256K"
],
"x-ms-enum": {
"name": "JsonWebKeyCurveName",
"modelAsString": true
}
},
"keyUri": {
"type": "string",
"description": "The URI to retrieve the current version of the key.",
"readOnly": true
},
"keyUriWithVersion": {
"type": "string",
"description": "The URI to retrieve the specific version of the key.",
"readOnly": true
}
},
"description": "The properties of the key.",
"type": "object"
},
"KeyAttributes": {
"properties": {
"enabled": {
"type": "boolean",
"description": "Determines whether or not the object is enabled."
},
"nbf": {
"x-ms-client-name": "NotBefore",
"type": "integer",
"format": "int64",
"description": "Not before date in seconds since 1970-01-01T00:00:00Z."
},
"exp": {
"x-ms-client-name": "Expires",
"type": "integer",
"format": "int64",
"description": "Expiry date in seconds since 1970-01-01T00:00:00Z."
},
"created": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Creation time in seconds since 1970-01-01T00:00:00Z."
},
"updated": {
"type": "integer",
"format": "int64",
"readOnly": true,
"description": "Last updated time in seconds since 1970-01-01T00:00:00Z."
},
"recoveryLevel": {
"type": "string",
"description": "The deletion recovery level currently in effect for the object. If it contains 'Purgeable', then the object can be permanently deleted by a privileged user; otherwise, only the system can purge the object at the end of the retention interval.",
"enum": [
"Purgeable",
"Recoverable+Purgeable",
"Recoverable",
"Recoverable+ProtectedSubscription"
],
"x-ms-enum": {
"name": "DeletionRecoveryLevel",
"modelAsString": true
},
"readOnly": true,
"x-nullable": false
},
"exportable": {
"type": "boolean",
"description": "Indicates if the private key can be exported."
}
},
"description": "The object attributes managed by the Azure Key Vault service.",
"type": "object"
},
"KeyCreateParameters": {
"properties": {
"tags": {
"type": "object",
"additionalProperties": {
"type": "string"
},
"description": "The tags that will be assigned to the key."
},
"properties": {
"$ref": "#/definitions/KeyProperties",
"description": "The properties of the key to be created."
}
},
"description": "The parameters used to create a key.",
"required": [
"properties"
],
"x-ms-azure-resource": true,
"type": "object"
},
"Key": {
"properties": {
"properties": {
"x-ms-client-flatten": true,
"$ref": "#/definitions/KeyProperties",
"description": "The properties of the key."
}
},
"required": [
"properties"
],
"allOf": [
{
"$ref": "./keyvault.json#/definitions/Resource"
}
],
"description": "The key resource.",
"type": "object"
},
"KeyListResult": {
"properties": {
"value": {
"type": "array",
"items": {
"$ref": "#/definitions/Key"
},
"description": "The key resources."
},
"nextLink": {
"type": "string",
"description": "The URL to get the next page of keys."
}
},
"description": "The page of keys.",
"type": "object"
}
},
"parameters": {
"SubscriptionIdParameter": {
"name": "subscriptionId",
"in": "path",
"required": true,
"type": "string",
"description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call."
},
"ApiVersionParameter": {
"name": "api-version",
"in": "query",
"required": true,
"type": "string",
"description": "Client Api Version."
}
},
"securityDefinitions": {
"azure_auth": {
"type": "oauth2",
"authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize",
"flow": "implicit",
"description": "Azure Active Directory OAuth2 Flow",
"scopes": {
"user_impersonation": "impersonate your user account"
}
}
}
}