delete_user¶
Operation¶
delete_user
¶
delete_user(request: DeleteUserInput | DeleteUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUserInputDict]) -> DeleteUserOutput
Deletes a user by email id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteUserInput | DeleteUserInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteUserOutput
|
An instance of |
delete_user
async
¶
delete_user(request: DeleteUserInput | DeleteUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[DeleteUserInputDict]) -> DeleteUserOutput
Deletes a user by email id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
DeleteUserInput | DeleteUserInputDict | None
|
The input as a model or dictionary. Pass this or keyword arguments, not both. |
None
|
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
|
**kwargs
|
Unpack[DeleteUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
DeleteUserOutput
|
An instance of |
Input¶
Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.
Output¶
DeleteUserOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for DeleteUserOutput structure.