HSM Security Domain - Transfer Key

Service:

Key Vault

API Version:

7.4

Obter chave de transferência de Domínio de Segurança

GET {vaultBaseUrl}/securitydomain/upload?api-version=7.4

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net.
api-version	query	True	string	Versão da API de Cliente.

Respostas

Name	Tipo	Description
200 OK	TransferKey	Resposta da chave de transferência do Domínio de Segurança
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve a razão pela qual a operação falhou.

Exemplos

Retrieve Security Domain transfer key

Sample Request

HTTP

GET https://myvault.vault.azure.net//securitydomain/upload?api-version=7.4

Sample Response

Status code:

200

{
  "key_format": "jwk",
  "transfer_key": {
    "kid": "https://myvault.vault.azure.net/transfer_key",
    "kty": "RSA",
    "key_ops": [
      "encrypt"
    ],
    "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w",
    "e": "AQAB",
    "alg": "RSA-OAEP-256",
    "x5c": [
      "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwM/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H"
    ],
    "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI",
    "x5t#S256": "gIBQCTDDN"
  }
}

Definições

Name	Description
Error	O erro do servidor do cofre de chaves.
KeyVaultError	A exceção de erro do cofre de chaves.
SecurityDomainJsonWebKey
TransferKey

Error

O erro do servidor do cofre de chaves.

Name	Tipo	Description
code	string	O código de erro.
innererror	Error	O erro do servidor do cofre de chaves.
message	string	A mensagem de erro.

KeyVaultError

A exceção de erro do cofre de chaves.

Name	Tipo	Description
error	Error	O erro do servidor do cofre de chaves.

SecurityDomainJsonWebKey

Name	Tipo	Description
alg	string	Algoritmo destinado a ser utilizado com a chave.
e	string	Expoente público RSA.
key_ops	string[]	Operações principais suportadas.
kid	string	Identificador de chave.
kty	string	JsonWebKey Key Type (kty), conforme definido em https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Para Domínio de Segurança, este valor tem de ser RSA.
n	string	Módulo RSA.
use	string	Parâmetro de Utilização da Chave Pública. Isto é opcional e, se estiver presente, tem de ser um enc.
x5c	string[]	Parâmetro da cadeia de certificados X509
x5t	string	Thumbprint SHA1 do certificado X509. Isto é opcional.
x5t#S256	string	Thumbprint SHA256 do certificado X509.

TransferKey

Name	Tipo	Valor Predefinido	Description
key_format	string	jwk	Especifica o formato da chave de transferência
transfer_key	SecurityDomainJsonWebKey		Especifica a chave de transferência no formato JWK