sign - sign

Referência

Service:: Key Vault

API Version:: 7.4

Cria uma assinatura de um resumo usando a chave especificada.
A operação SIGN é aplicável a chaves assimétricas e simétricas armazenadas no Azure Key Vault porque essa operação usa a parte privada da chave. Essa operação requer a permissão de chave/sinal.

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

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
key-name	path	True	string	O nome da chave.
key-version	path	True	string	A versão da chave.
vaultBaseUrl	path	True	string	O nome do cofre, por exemplo https://myvault.vault.azure.net, .
api-version	query	True	string	Versão de API do cliente.

Corpo da solicitação

Nome	Obrigatório	Tipo	Description
alg	True	JsonWebKeySignatureAlgorithm	O identificador do algoritmo de autenticação/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.
value	True	string

Respostas

Nome	Tipo	Description
200 OK	KeyOperationResult	O valor da assinatura.
Other Status Codes	KeyVaultError	Key Vault resposta de erro que descreve por que a operação falhou.

Exemplos

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

Definições

Nome	Description
Error	O erro do servidor do cofre de chaves.
JsonWebKeySignatureAlgorithm	O identificador do algoritmo de autenticação/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.
KeyOperationResult	O resultado da operação de chave.
KeySignParameters	Os principais parâmetros de operações.
KeyVaultError	A exceção de erro do cofre de chaves.

Error

O erro do servidor do cofre de chaves.

Nome	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.

JsonWebKeySignatureAlgorithm

O identificador do algoritmo de autenticação/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.

Nome	Tipo	Description
ES256	string	ECDSA usando P-256 e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518.
ES256K	string	ECDSA usando P-256K e SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
ES384	string	ECDSA usando P-384 e SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
ES512	string	ECDSA usando P-521 e SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
PS256	string	RSASSA-PSS usando SHA-256 e MGF1 com SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
PS384	string	RSASSA-PSS usando SHA-384 e MGF1 com SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
PS512	string	RSASSA-PSS usando SHA-512 e MGF1 com SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RS256	string	RSASSA-PKCS1-v1_5 usando SHA-256, conforme descrito em https://tools.ietf.org/html/rfc7518
RS384	string	RSASSA-PKCS1-v1_5 usando SHA-384, conforme descrito em https://tools.ietf.org/html/rfc7518
RS512	string	RSASSA-PKCS1-v1_5 usando SHA-512, conforme descrito em https://tools.ietf.org/html/rfc7518
RSNULL	string	Reservado

KeyOperationResult

O resultado da operação de chave.

Nome	Tipo	Description
aad	string
iv	string
kid	string	Identificador da chave
tag	string
value	string

KeySignParameters

Os principais parâmetros de operações.

Nome	Tipo	Description
alg	JsonWebKeySignatureAlgorithm	O identificador do algoritmo de autenticação/verificação. Para obter mais informações sobre possíveis tipos de algoritmo, consulte JsonWebKeySignatureAlgorithm.
value	string

KeyVaultError

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

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