Skip to content

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 DeleteUserOutput.

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 DeleteUserOutput.

Input

Pass the input as keyword arguments, a positional dictionary, or a positional model object. Pass plugins separately as a keyword argument.

DeleteUserInputDict

Bases: TypedDict

Dictionary form of DeleteUserInput.

Attributes

application_id instance-attribute
application_id: Required[str]

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

user_id instance-attribute
user_id: Required[str]

The user email being deleted.

DeleteUserInput dataclass

Bases: _SerdeShape

Dataclass for DeleteUserInput structure.

Attributes

application_id class-attribute instance-attribute
application_id: str | None = ...

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

user_id class-attribute instance-attribute
user_id: str | None = ...

The user email being deleted.

Output

DeleteUserOutput dataclass

Bases: _SerdeShape

Dataclass for DeleteUserOutput structure.

Attributes

response_metadata class-attribute instance-attribute
response_metadata: ResponseMetadata = ...

Metadata about the response that produced this output. Use this to recover the request identifiers a service's support team needs in order to investigate a call. Members of the metadata are individually optional.