Struct UpdateKeyConfigurationRequest

pub struct UpdateKeyConfigurationRequest {
    pub mount: String,
    pub name: String,
    pub min_decryption_version: Option<u64>,
    pub min_encryption_version: Option<u64>,
    pub deletion_allowed: Option<bool>,
    pub exportable: Option<bool>,
    pub allow_plaintext_backup: Option<bool>,
    pub auto_rotate_period: Option<String>,
}

Update Key Configuration

This endpoint allows tuning configuration values for a given key. (These values are returned during a read operation on the named key.)

• Path: {self.mount}/keys/{self.name}/config
• Method: POST
• Response: N/A
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/transit#update-key-configuration

Fields

mount: String

name: String

min_decryption_version: Option<u64>

Specifies the minimum version of ciphertext allowed to be decrypted. Adjusting this as part of a key rotation policy can prevent old copies of ciphertext from being decrypted, should they fall into the wrong hands. For signatures, this value controls the minimum version of signature that can be verified against. For HMACs, this controls the minimum version of a key allowed to be used as the key for verification.

min_encryption_version: Option<u64>

Specifies the minimum version of the key that can be used to encrypt plaintext, sign payloads, or generate HMACs. Must be 0 (which will use the latest version) or a value greater or equal to min_decryption_version.

deletion_allowed: Option<bool>

Specifies if the key is allowed to be deleted.

exportable: Option<bool>

Enables keys to be exportable. This allows for all the valid keys in the key ring to be exported. Once set, this cannot be disabled.

allow_plaintext_backup: Option<bool>

If set, enables taking backup of named key in the plaintext format. Once set, this cannot be disabled.

auto_rotate_period: Option<String>

The period at which this key should be rotated automatically. Setting this to “0” will disable automatic key rotation. This value cannot be shorter than one hour. When no value is provided, the period remains unchanged.

Implementations

impl UpdateKeyConfigurationRequest

pub fn builder() -> UpdateKeyConfigurationRequestBuilder

Trait Implementations

impl Debug for UpdateKeyConfigurationRequest

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

Formats the value using the given formatter.

impl Default for UpdateKeyConfigurationRequest

fn default() -> UpdateKeyConfigurationRequest

Returns the “default value” for a type.

impl Endpoint for UpdateKeyConfigurationRequest

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 = ()

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,