Qbusiness  >  Operations  >  get_user

get_user

Operation

get_user async

get_user(input: GetUserInput, plugins: list[Plugin] | None = None) -> GetUserOutput

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

Parameters:

Name	Type	Description	Default
input	GetUserInput	An instance of GetUserInput.	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
GetUserOutput	An instance of GetUserOutput.

Input

GetUserInput dataclass

Dataclass for GetUserInput structure.

Attributes

application_id class-attribute instance-attribute

application_id: str | None = None

The identifier of the application connected to the user.

user_id class-attribute instance-attribute

user_id: str | None = None

The user email address attached to the user.

Output

GetUserOutput dataclass

Dataclass for GetUserOutput structure.

Attributes

user_aliases class-attribute instance-attribute

user_aliases: list[UserAlias] | None = None

A list of user aliases attached to a user.