Skip to content

QBusiness  >  Operations  >  update_user

update_user

Operation

update_user async 

update_user(input: UpdateUserInput, plugins: list[Plugin] | None = None) -> UpdateUserOutput

Updates a information associated with a user id.

Parameters:

Name Type Description Default
input UpdateUserInput

An instance of UpdateUserInput.

 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
UpdateUserOutput

An instance of UpdateUserOutput.

Input

UpdateUserInput dataclass

Dataclass for UpdateUserInput structure.

Attributes

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

The identifier of the application the user is attached to.

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

The user aliases attached to the user id that are to be deleted.

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

The user aliases attached to the user id that are to be updated.

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

The email id attached to the user.

Output

UpdateUserOutput dataclass

Dataclass for UpdateUserOutput structure.

Attributes

response_metadata class-attribute instance-attribute 
response_metadata: ResponseMetadata = field(default=EMPTY_RESPONSE_METADATA, repr=False, compare=False)

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_added class-attribute instance-attribute 
user_aliases_added: list[UserAlias] | None = None

The user aliases that have been to be added to a user id.

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

The user aliases that have been deleted from a user id.

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

The user aliases attached to a user id that have been updated.