sign - sign

Service:

Key Vault

API Version:

7.4

指定したキーを使用してダイジェストから署名を作成します。
SIGN 操作は、Azure Key Vaultに格納されている非対称キーと対称キーに適用されます。この操作ではキーの秘密部分が使用されるためです。 この操作には、キー/署名アクセス許可が必要です。

POST {vaultBaseUrl}/keys/{key-name}/{key-version}/sign?api-version=7.4

URI パラメーター

名前	/	必須	型	説明
key-name	path	True	string	キーの名前です。
key-version	path	True	string	キーのバージョン。
vaultBaseUrl	path	True	string	コンテナー名 (例: https://myvault.vault.azure.net)。
api-version	query	True	string	クライアント API バージョン。

要求本文

名前	必須	型	説明
alg	True	JsonWebKeySignatureAlgorithm	署名/検証アルゴリズム識別子。 考えられるアルゴリズムの種類の詳細については、「JsonWebKeySignatureAlgorithm」を参照してください。
value	True	string

応答

名前	型	説明
200 OK	KeyOperationResult	シグネチャ値。
Other Status Codes	KeyVaultError	操作Key Vault失敗した理由を説明するエラー応答です。

例

Sign

Sample Request

HTTP

POST https://myvault.vault.azure.net//keys/testkey/9885aa558e8d448789683188f8c194b0/sign?api-version=7.4

{
  "alg": "RS512",
  "value": "RUE3Nzg4NTQ4QjQ5RjFFN0U2NzAyQzhDNEMwMkJDOTA1MTYyOTUzNjI5NDhBNzZDQTlFOTM1NDA2M0ZGMjk2Mg"
}

Sample Response

Status code:

200

{
  "kid": "https://myvault.vault.azure.net/keys/testkey/9885aa558e8d448789683188f8c194b0",
  "value": "aKFG8NXcfTzqyR44rW42484K_zZI_T7zZuebvWuNgAoEI1gXYmxrshp42CunSmmu4oqo4-IrCikPkNIBkHXnAW2cv03Ad0UpwXhVfepK8zzDBaJPMKVGS-ZRz8CshEyGDKaLlb3J3zEkXpM3RrSEr0mdV6hndHD_mznLB5RmFui5DsKAhez4vUqajgtkgcPfCekMqeSwp6r9ItVL-gEoAohx8XMDsPedqu-7BuZcBcdayaPuBRL4wWoTDULA11P-UN_sJ5qMj3BbiRYhIlBWGR04wIGfZ3pkJjHJUpOvgH2QajdYPzUBauOCewMYbq9XkLRSzI_A7HkkDVycugSeAA"
}

定義

名前	説明
Error	キー コンテナー サーバー エラー。
JsonWebKeySignatureAlgorithm	署名/検証アルゴリズム識別子。 考えられるアルゴリズムの種類の詳細については、「JsonWebKeySignatureAlgorithm」を参照してください。
KeyOperationResult	キー操作の結果。
KeySignParameters	主要な操作パラメーター。
KeyVaultError	キー コンテナーのエラー例外。

Error

キー コンテナー サーバー エラー。

名前	型	説明
code	string	エラー コード。
innererror	Error	キー コンテナー サーバー エラー。
message	string	エラー メッセージ。

JsonWebKeySignatureAlgorithm

署名/検証アルゴリズム識別子。 考えられるアルゴリズムの種類の詳細については、「JsonWebKeySignatureAlgorithm」を参照してください。

名前	型	説明
ES256	string	で説明されているように、P-256 および SHA-256 を使用した https://tools.ietf.org/html/rfc7518ECDSA。
ES256K	string	P-256K および SHA-256 を使用した ECDSA https://tools.ietf.org/html/rfc7518
ES384	string	P-384 および SHA-384 を使用した ECDSA https://tools.ietf.org/html/rfc7518
ES512	string	P-521 および SHA-512 を使用した ECDSA https://tools.ietf.org/html/rfc7518
PS256	string	SHA-256 および MGF1 と SHA-256 を使用した RSASSA-PSS https://tools.ietf.org/html/rfc7518
PS384	string	SHA-384 および MGF1 と SHA-384 を使用した RSASSA-PSS https://tools.ietf.org/html/rfc7518
PS512	string	SHA-512 および MGF1 と SHA-512 を使用した RSASSA-PSS https://tools.ietf.org/html/rfc7518
RS256	string	で説明されているように、SHA-256 を使用した RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS384	string	で説明されているように、SHA-384 を使用した RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RS512	string	で説明されているように、SHA-512 を使用した RSASSA-PKCS1-v1_5 https://tools.ietf.org/html/rfc7518
RSNULL	string	予約済み

KeyOperationResult

キー操作の結果。

名前	型	説明
aad	string
iv	string
kid	string	キー識別子
tag	string
value	string

KeySignParameters

主要な操作パラメーター。

名前	型	説明
alg	JsonWebKeySignatureAlgorithm	署名/検証アルゴリズム識別子。 考えられるアルゴリズムの種類の詳細については、「JsonWebKeySignatureAlgorithm」を参照してください。
value	string

KeyVaultError

キー コンテナーのエラー例外。

名前	型	説明
error	Error	キー コンテナー サーバー エラー。