Struct CreateGroupRequest

pub struct CreateGroupRequest {
    pub group_type: Option<String>,
    pub metadata: Option<HashMap<String, String>>,
    pub policies: Option<Vec<String>>,
    pub member_group_ids: Option<Vec<String>>,
    pub member_entity_ids: Option<Vec<String>>,
}

Create an group

This endpoint creates or updates a group.

Note that it’s not possible to set the ID or the name to update an existing group, identity::group::update_by_id is the function to call for that use case.

• Path: identity/group
• Method: POST
• Reference: https://developer.hashicorp.com/vault/api-docs/secret/identity/group#create-a-group

Fields

group_type: Option<String>

Type of the group, internal or external. Defaults to internal.

metadata: Option<HashMap<String, String>>

Metadata to be associated with the entity.

policies: Option<Vec<String>>

Policies to be tied to the group.

member_group_ids: Option<Vec<String>>

Group IDs to be assigned as group members.

member_entity_ids: Option<Vec<String>>

Entity IDs to be assigned as group members.

Implementations

impl CreateGroupRequest

pub fn builder() -> CreateGroupRequestBuilder

Trait Implementations

impl Debug for CreateGroupRequest

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

Formats the value using the given formatter.

impl Default for CreateGroupRequest

fn default() -> CreateGroupRequest

Returns the “default value” for a type.

impl Endpoint for CreateGroupRequest

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

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,

impl Serialize for CreateGroupRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.