Struct CreateEntityAliasRequest

pub struct CreateEntityAliasRequest {
    pub name: String,
    pub canonical_id: String,
    pub mount_accessor: String,
    pub id: Option<String>,
    pub custom_metadata: Option<HashMap<String, String>>,
}

Create an entity alias

This endpoint creates a new alias for an entity.

• Path: identity/entity-alias
• Method: POST
• Response: Option<CreateEntityAliasResponse>
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/identity/entity-alias#create-an-entity-alias

Fields

name: String

Name of the alias. Name should be the identifier of the client in the authentication source. For example, if the alias belongs to userpass backend, the name should be a valid username within userpass auth method. If the alias belongs to GitHub, it should be the GitHub username. If the alias belongs to an approle auth method, the name should be a valid RoleID.

canonical_id: String

Entity ID to which this alias belongs to.

mount_accessor: String

Accessor of the mount to which the alias should belong to.

id: Option<String>

ID of the entity alias. If set, updates the corresponding entity alias.

custom_metadata: Option<HashMap<String, String>>

A map of arbitrary string to string valued user-provided metadata meant to describe the alias.

Implementations

impl CreateEntityAliasRequest

pub fn builder() -> CreateEntityAliasRequestBuilder

Trait Implementations

impl Debug for CreateEntityAliasRequest

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

Formats the value using the given formatter.

impl Default for CreateEntityAliasRequest

fn default() -> CreateEntityAliasRequest

Returns the “default value” for a type.

impl Endpoint for CreateEntityAliasRequest

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 = CreateEntityAliasResponse

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,