quota
Accessed as client.admin.users.quota; the async client mirrors it.
AdminUsersQuota
The admin.users.quota namespace.
get
get(username: str) -> QuotaInfo
Get the user's quota info.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
username
|
str
|
username of user to query |
required |
Returns:
| Type | Description |
|---|---|
QuotaInfo
|
QuotaInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
ForbiddenError
|
|
NotFoundError
|
|
UnprocessableEntityError
|
|
Operation ID: adminGetUserQuota
set_groups
set_groups(username: str, *, groups: list[str]) -> None
Set the user's quota groups to a given list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
username
|
str
|
username of the user to modify the quota groups from |
required |
groups
|
list[str]
|
Quota groups the user shall have |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
ForbiddenError
|
|
NotFoundError
|
|
UnprocessableEntityError
|
|
Operation ID: adminSetUserQuotaGroups
AsyncAdminUsersQuota
The admin.users.quota namespace.
get
get(username: str) -> QuotaInfo
Get the user's quota info.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
username
|
str
|
username of user to query |
required |
Returns:
| Type | Description |
|---|---|
QuotaInfo
|
QuotaInfo. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
ForbiddenError
|
|
NotFoundError
|
|
UnprocessableEntityError
|
|
Operation ID: adminGetUserQuota
set_groups
set_groups(username: str, *, groups: list[str]) -> None
Set the user's quota groups to a given list.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
username
|
str
|
username of the user to modify the quota groups from |
required |
groups
|
list[str]
|
Quota groups the user shall have |
required |
Returns:
| Type | Description |
|---|---|
None
|
No content. |
Raises:
| Type | Description |
|---|---|
BadRequestError
|
|
ForbiddenError
|
|
NotFoundError
|
|
UnprocessableEntityError
|
|
Operation ID: adminSetUserQuotaGroups