Skip to content

get_user

Operation

get_user

get_user(request: GetUserInput | GetUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUserInputDict]) -> GetUserOutput

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Parameters:

Name Type Description Default
request GetUserInput | GetUserInputDict | 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[GetUserInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetUserOutput

An instance of GetUserOutput.

get_user async

get_user(request: GetUserInput | GetUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[GetUserInputDict]) -> GetUserOutput

Describes the universally unique identifier (UUID) associated with a local user in a data source.

Parameters:

Name Type Description Default
request GetUserInput | GetUserInputDict | 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[GetUserInputDict]

The input fields as keyword arguments.

{}

Returns:

Type Description
GetUserOutput

An instance of GetUserOutput.

Input

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

GetUserInputDict

Bases: TypedDict

Dictionary form of GetUserInput.

Attributes

application_id instance-attribute
application_id: Required[str]

The identifier of the application connected to the user.

user_id instance-attribute
user_id: Required[str]

The user email address attached to the user.

GetUserInput dataclass

Bases: _SerdeShape

Dataclass for GetUserInput structure.

Attributes

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

The identifier of the application connected to the user.

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

The user email address attached to the user.

Output

GetUserOutput dataclass

Bases: _SerdeShape

Dataclass for GetUserOutput 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.

user_aliases class-attribute instance-attribute
user_aliases: list[UserAlias] | None = ...

A list of user aliases attached to a user.