Struct GenerateHmacRequest

pub struct GenerateHmacRequest {
    pub mount: String,
    pub name: String,
    pub key_version: Option<u64>,
    pub algorithm: Option<HashAlgorithm>,
    pub input: String,
}

Generate HMAC

This endpoint returns the digest of given data using the specified hash algorithm and the named key. The key can be of any type supported by transit; the raw key will be marshaled into bytes to be used for the HMAC function. If the key is of a type that supports rotation, the latest (current) version will be used.

• Path: {self.mount}/hmac/{self.name}(/{self.algorithm)
• Method: POST
• Response: GenerateHmacResponse
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#generate-hmac

Fields

mount: String

name: String

key_version: Option<u64>

Specifies the version of the key to use for the operation. If not set, uses the latest version. Must be greater than or equal to the key’s min_encryption_version, if set.

algorithm: Option<HashAlgorithm>

Specifies the hash algorithm to use.

input: String

Specifies the base64 encoded input data.

Implementations

impl GenerateHmacRequest

pub fn builder() -> GenerateHmacRequestBuilder

Trait Implementations

impl Debug for GenerateHmacRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for GenerateHmacRequest

fn default() -> GenerateHmacRequest

Returns the “default value” for a type.

impl Endpoint for GenerateHmacRequest

const REQUEST_BODY_TYPE: RequestType = RequestType::JSON

The content type of the request body

const RESPONSE_BODY_TYPE: ResponseType = ResponseType::JSON

The content type of the response body

type Response = GenerateHmacResponse

The type that the raw response from executing this endpoint will deserialized into. This type is passed on to the EndpointResult and is used to determine the type returned when the parse() method is called.

fn path(&self) -> String

The relative URL path that represents the location of this Endpoint. This is combined with the base URL from a Client instance to create the fully qualified URL.

fn method(&self) -> RequestMethod

The HTTP method to be used when executing this Endpoint.

fn body(&self) -> Result<Option<Vec<u8>>, ClientError>

Optional data to add to the body of the request.

fn query(&self) -> Result<Option<String>, ClientError>

Optional query parameters to add to the request.

fn url(&self, base: &str) -> Result<Uri, ClientError>

Returns the full URL address of the endpoint using the base address.

fn request(&self, base: &str) -> Result<Request<Vec<u8>>, ClientError>

Returns a Request containing all data necessary to execute against this endpoint.

fn exec<'life0, 'life1, 'async_trait>( &'life0 self, client: &'life1 (impl Client + 'async_trait), ) -> Pin<Box<dyn Future<Output = Result<EndpointResult<Self::Response>, ClientError>> + Send + 'async_trait>>

where 'life0: 'async_trait, 'life1: 'async_trait, Self: 'async_trait,

Executes the Endpoint using the given Client.

fn with_middleware<M>(self, middleware: &M) -> MutatedEndpoint<'_, Self, M>

where M: MiddleWare,