Qbusiness  >  Operations  >  delete_user

delete_user

Operation

delete_user async

delete_user(input: DeleteUserInput, plugins: list[Plugin] | None = None) -> DeleteUserOutput

Deletes a user by email id.

Parameters:

Name	Type	Description	Default
input	DeleteUserInput	An instance of DeleteUserInput.	required
plugins	list[Plugin] | None	A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations.	None

Returns:

Type	Description
DeleteUserOutput	An instance of DeleteUserOutput.

Input

DeleteUserInput dataclass

Dataclass for DeleteUserInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application from which the user is being deleted.

user_id class-attribute instance-attribute

user_id: str | None = None

The user email being deleted.

Output

DeleteUserOutput dataclass

Dataclass for DeleteUserOutput structure.