Post
/crypto/v1/macverify
Verify the input MAC. The key used must have the MACVERIFY
key operation.
Security
HTTP
Type bearer
API Key: apiKeyAuth
Header parameter nameAuthorization
Body parameters
object
key
Uniquely identifies a persisted or transient sobject.
OneOf
SobjectDescriptorVariantKid
object (SobjectDescriptorVariantKid)
kid
string (uuid) Required
SobjectDescriptorVariantName
object (SobjectDescriptorVariantName)
name
string Required
Max length4096
Pattern^[^\n]*[^\s\n][^\n]*$
SobjectDescriptorVariantTransientKey
object (SobjectDescriptorVariantTransientKey)
transient_key
string (byte) Required
SobjectDescriptorVariantInline
object (SobjectDescriptorVariantInline)
inline
object Required
value
string (byte) Required
obj_type
string Required
Type of security object.
Valid values[
"AES",
"ARIA",
"DES",
"DES3",
"SEED",
"RSA",
"DSA",
"EC",
"KCDSA",
"ECKCDSA",
"BIP32",
"BLS",
"OPAQUE",
"HMAC",
"LEDABETA",
"ROUND5BETA",
"SECRET",
"LMS",
"XMSS",
"MLDSA",
"MLDSABETA",
"MLKEM",
"MLKEMBETA",
"CERTIFICATE",
"PBE"
]
alg
string
A hash algorithm.
Valid values[
"BLAKE2B256",
"BLAKE2B384",
"BLAKE2B512",
"BLAKE2S256",
"RIPEMD160",
"SSL3",
"SHA1",
"SHA224",
"SHA256",
"SHA384",
"SHA512",
"STREEBOG256",
"STREEBOG512",
"SHA3_224",
"SHA3_256",
"SHA3_384",
"SHA3_512"
]
data
string (byte) Required
The data over which the MAC needs to be verified
mac
string (byte)
The MAC to verify. Note that the previously available
field digest is deprecated; this field should be used
instead.
Responses
2XX
Success result
object
kid
string (uuid) | null
The ID of the key used for verification. Returned for non-transient keys.
result
boolean
True if the signature verified and false if it did not.