update_user¶
Operation¶
update_user
¶
update_user(request: UpdateUserInput | UpdateUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateUserInputDict]) -> UpdateUserOutput
Updates a information associated with a user id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateUserInput | UpdateUserInputDict | 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[UpdateUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateUserOutput
|
An instance of |
update_user
async
¶
update_user(request: UpdateUserInput | UpdateUserInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[UpdateUserInputDict]) -> UpdateUserOutput
Updates a information associated with a user id.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
UpdateUserInput | UpdateUserInputDict | 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[UpdateUserInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
UpdateUserOutput
|
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.
UpdateUserInputDict
¶
Bases: TypedDict
Dictionary form of UpdateUserInput.
Attributes¶
application_id
instance-attribute
¶
The identifier of the application the user is attached to.
user_aliases_to_delete
instance-attribute
¶
user_aliases_to_delete: Sequence[UserAlias | UserAliasDict] | None
The user aliases attached to the user id that are to be deleted.
user_aliases_to_update
instance-attribute
¶
user_aliases_to_update: Sequence[UserAlias | UserAliasDict] | None
The user aliases attached to the user id that are to be updated.
UpdateUserInput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateUserInput structure.
Attributes¶
application_id
class-attribute
instance-attribute
¶
application_id: str | None = ...
The identifier of the application the user is attached to.
user_aliases_to_delete
class-attribute
instance-attribute
¶
The user aliases attached to the user id that are to be deleted.
user_aliases_to_update
class-attribute
instance-attribute
¶
The user aliases attached to the user id that are to be updated.
Output¶
UpdateUserOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for UpdateUserOutput structure.
Attributes¶
response_metadata
class-attribute
instance-attribute
¶
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
¶
The user aliases that have been to be added to a user id.
user_aliases_deleted
class-attribute
instance-attribute
¶
The user aliases that have been deleted from a user id.