remove_user_from_group¶
Operation¶
remove_user_from_group
¶
remove_user_from_group(request: RemoveUserFromGroupInput | RemoveUserFromGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveUserFromGroupInputDict]) -> RemoveUserFromGroupOutput
Removes the specified user from the specified group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RemoveUserFromGroupInput | RemoveUserFromGroupInputDict | 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[RemoveUserFromGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RemoveUserFromGroupOutput
|
An instance of |
remove_user_from_group
async
¶
remove_user_from_group(request: RemoveUserFromGroupInput | RemoveUserFromGroupInputDict | None = None, /, *, plugins: list[Plugin] | None = None, **kwargs: Unpack[RemoveUserFromGroupInputDict]) -> RemoveUserFromGroupOutput
Removes the specified user from the specified group.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
request
|
RemoveUserFromGroupInput | RemoveUserFromGroupInputDict | 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[RemoveUserFromGroupInputDict]
|
The input fields as keyword arguments. |
{}
|
Returns:
| Type | Description |
|---|---|
RemoveUserFromGroupOutput
|
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.
RemoveUserFromGroupInputDict
¶
Bases: TypedDict
Dictionary form of RemoveUserFromGroupInput.
Attributes¶
group_name
instance-attribute
¶
The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
user_name
instance-attribute
¶
The name of the user to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
RemoveUserFromGroupInput
dataclass
¶
Bases: _SerdeShape
Dataclass for RemoveUserFromGroupInput structure.
Attributes¶
group_name
class-attribute
instance-attribute
¶
group_name: str | None = ...
The name of the group to update.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
user_name
class-attribute
instance-attribute
¶
user_name: str | None = ...
The name of the user to remove.
This parameter allows (through its regex pattern) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-
Output¶
RemoveUserFromGroupOutput
dataclass
¶
Bases: _SerdeShape
Dataclass for RemoveUserFromGroupOutput structure.