HSM Security Domain - Transfer Key

  • Odwołanie
Service:
Key Vault
API Version:
7.4

Pobieranie klucza transferu domeny zabezpieczeń

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

Parametry identyfikatora URI

Nazwa W Wymagane Typ Opis
vaultBaseUrl
 path True

string

Nazwa magazynu, na przykład https://myvault.vault.azure.net.
api-version
 query True

string

Wersja interfejsu API klienta.

Odpowiedzi

Nazwa Typ Opis
200 OK

TransferKey

Odpowiedź klucza transferu domeny zabezpieczeń
Other Status Codes

KeyVaultError

Key Vault odpowiedź o błędzie opisująca, dlaczego operacja nie powiodła się.

Przykłady

Retrieve Security Domain transfer key

Sample Request

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"
  }
}

Definicje

Nazwa Opis
Error

Błąd serwera magazynu kluczy.
KeyVaultError

Wyjątek błędu magazynu kluczy.
SecurityDomainJsonWebKey
TransferKey

Error

Błąd serwera magazynu kluczy.

Nazwa Typ Opis
code

string

Kod błędu.
innererror

Error

Błąd serwera magazynu kluczy.
message

string

Komunikat o błędzie.

KeyVaultError

Wyjątek błędu magazynu kluczy.

Nazwa Typ Opis
error

Error

Błąd serwera magazynu kluczy.

SecurityDomainJsonWebKey

Nazwa Typ Opis
alg

string

Algorytm przeznaczony do użycia z kluczem.
e

string

Publiczny wykładnik RSA.
key_ops

string[]

Obsługiwane operacje klucza.
kid

string

Identyfikator klucza.
kty

string

Typ klucza JsonWebKey (kty), zgodnie z definicją w pliku https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. W przypadku domeny zabezpieczeń ta wartość musi być RSA.
n

string

Modulus RSA.
use

string

Parametr użycia klucza publicznego. Jest to opcjonalne i jeśli jest obecny, musi być en.
x5c

string[]

Parametr łańcucha certyfikatów X509
x5t

string

Odcisk palca certyfikatu X509 SHA1. Jest to opcjonalne.
x5t#S256

string

Odcisk palca certyfikatu X509 SHA256.

TransferKey

Nazwa Typ Wartość domyślna Opis
key_format

string

jwk

Określa format klucza transferu
transfer_key

SecurityDomainJsonWebKey

Określa klucz transferu w formacie JWK