Skip to content

[KeyVault] Adding descriptions to JsonWebKey kty values #3199

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
schaabs merged 1 commit into from
Jun 8, 2018
Merged

[KeyVault] Adding descriptions to JsonWebKey kty values #3199

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
34 changes: 30 additions & 4 deletions specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.0/keyvault.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3724,11 +3724,33 @@
},
"kty": {
"type": "string",
"description": "JsonWebKey key type (kty).",
"description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40.",
"enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ],
"x-ms-enum": {
"name": "JsonWebKeyType",
"modelAsString": true
"modelAsString": true,
"values": [
{
"value": "EC",
"description": "Elliptic Curve."
},
{
"value": "EC-HSM",
"description": "Elliptic Curve with a private key which is not exportable from the HSM."
},
{
"value": "RSA",
"description": "RSA (https://tools.ietf.org/html/rfc3447)"
},
{
"value": "RSA-HSM",
"description": "RSA with a private key which is not exportable from the HSM."
},
{
"value": "oct",
"description": "Octet sequence (used to represent symmetric keys)"
}
]
}
},
"key_ops": {
Expand Down Expand Up @@ -4375,9 +4397,13 @@
"description": "Indicates if the private key can be exported."
},
"kty": {
"x-ms-client-name": "keyType",
"type": "string",
"description": "The key type."
"description": "The type of key pair to be used for the certificate.",
"enum": [ "EC", "EC-HSM", "RSA", "RSA-HSM", "oct" ],
"x-ms-enum": {
"name": "JsonWebKeyType",
"modelAsString": true
}
},
"key_size": {
"type": "integer",
Expand Down