HSM Security Domain - Transfer Key

Mengambil kunci transfer Domain Keamanan

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

Parameter URI

Name In Required Type Description
vaultBaseUrl
path True
  • string

Nama vault, misalnya https://myvault.vault.azure.net.

api-version
query True
  • string

Versi API klien.

Respons

Name Type Description
200 OK

Respons kunci transfer Domain Keamanan

Other Status Codes

Key Vault respons kesalahan yang menjelaskan mengapa operasi gagal.

Contoh

Retrieve Security Domain transfer key

Sample Request

GET https://myhsmvault.managedhsm.azure.net//securitydomain/upload?api-version=7.3

Sample Response

{
  "key_format": "jwk",
  "transfer_key": {
    "kid": "https://myhsmvault.managedhsm.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"
  }
}

Definisi

Error

Kesalahan server brankas kunci.

KeyVaultError

Pengecualian kesalahan brankas kunci.

SecurityDomainJsonWebKey
TransferKey

Error

Kesalahan server brankas kunci.

Name Type Description
code
  • string

Kode kesalahan.

innererror

Kesalahan server brankas kunci.

message
  • string

Pesan kesalahan.

KeyVaultError

Pengecualian kesalahan brankas kunci.

Name Type Description
error

Kesalahan server brankas kunci.

SecurityDomainJsonWebKey

Name Type Description
alg
  • string

Algoritma yang ditujukan untuk digunakan dengan kunci .

e
  • string

Eksponen publik RSA.

key_ops
  • string[]

Operasi kunci yang didukung.

kid
  • string

Pengidentifikasi kunci.

kty
  • string

Jenis Kunci JsonWebKey (kty), seperti yang didefinisikan dalam https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. Untuk Domain Keamanan, nilai ini harus RSA.

n
  • string

Modulus RSA.

use
  • string

Parameter Penggunaan Kunci Umum. Ini opsional dan jika ada harus enc.

x5c
  • string[]

Parameter rantai sertifikat X509

x5t
  • string

Thumbprint SHA1 sertifikat X509. Ini opsional.

x5t#S256
  • string

Thumbprint SERTIFIKAT X509 SHA256.

TransferKey

Name Type Default Value Description
key_format
  • string
jwk

Menentukan format kunci transfer

transfer_key

Menentukan kunci transfer dalam format JWK