users

Accessed as client.admin.quota.groups.users; the async client mirrors it.

SyncAsync

AdminQuotaGroupsUsers

The admin.quota.groups.users namespace.

add

add(quotagroup: str, username: str) -> None

Add a user to a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to add the user to	required
`username`	`str`	username of the user to add to the quota group	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminAddUserToQuotaGroup

list

list(quotagroup: str) -> list[User]

List users in a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to list members of	required

Returns:

Type	Description
`list[User]`	UserList.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminListUsersInQuotaGroup

remove

remove(quotagroup: str, username: str) -> None

Remove a user from a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to remove a user from	required
`username`	`str`	username of the user to remove from the quota group	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminRemoveUserFromQuotaGroup

AsyncAdminQuotaGroupsUsers

The admin.quota.groups.users namespace.

add

add(quotagroup: str, username: str) -> None

Add a user to a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to add the user to	required
`username`	`str`	username of the user to add to the quota group	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.
`ConflictError`	APIError is error format response.
`UnprocessableEntityError`	APIValidationError is error format response related to input validation.

Operation ID: adminAddUserToQuotaGroup

list

list(quotagroup: str) -> list[User]

List users in a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to list members of	required

Returns:

Type	Description
`list[User]`	UserList.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminListUsersInQuotaGroup

remove

remove(quotagroup: str, username: str) -> None

Remove a user from a quota group.

Parameters:

Name	Type	Description	Default
`quotagroup`	`str`	quota group to remove a user from	required
`username`	`str`	username of the user to remove from the quota group	required

Returns:

Type	Description
`None`	No content.

Raises:

Type	Description
`BadRequestError`	APIError is error format response.
`ForbiddenError`	APIForbiddenError is a forbidden error response.
`NotFoundError`	APINotFound is a not found error response.

Operation ID: adminRemoveUserFromQuotaGroup