Data API — User Groups

14 min

user_group_create

sync(client: AuthenticatedClient | Client, body: CreateUserGroupRequest | Unset = UNSET) -> ProblemDetails | UserGroupDetailResponse | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
body	CreateUserGroupRequest \| Unset	UNSET

body — Request to create a new user group

Returns: ProblemDetails | UserGroupDetailResponse | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_delete

sync(id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_describe

sync(id: UUID, client: AuthenticatedClient | Client) -> ProblemDetails | UserGroupDetailResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: ProblemDetails | UserGroupDetailResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_list

sync(client: AuthenticatedClient | Client, name: str | Unset = UNSET, states: list[UserGroupStateEnum] | Unset = UNSET, page: int | Unset = UNSET, page_size: int | Unset = UNSET) -> ProblemDetails | list[ErrorResponse] | list[UserGroupResponse] | None

Parameter	Type	Default
client	AuthenticatedClient \| Client	required
name	str \| Unset	UNSET
states	list[UserGroupStateEnum] \| Unset	UNSET
page	int \| Unset	UNSET
page_size	int \| Unset	UNSET

Returns: ProblemDetails | list[ErrorResponse] | list[UserGroupResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_members_add

sync(id: UUID, client: AuthenticatedClient | Client, body: AddUserGroupMembersRequest | Unset = UNSET) -> ProblemDetails | UserGroupDetailResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	AddUserGroupMembersRequest \| Unset	UNSET

body — Request to add members to a user group

Returns: ProblemDetails | UserGroupDetailResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_member_remove

sync(id: UUID, user_id: UUID, client: AuthenticatedClient | Client) -> Any | ProblemDetails | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
user_id	UUID	required
client	AuthenticatedClient \| Client	required

Returns: Any | ProblemDetails | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.

user_group_update

sync(id: UUID, client: AuthenticatedClient | Client, body: UpdateUserGroupRequest | Unset = UNSET) -> ProblemDetails | UserGroupResponse | list[ErrorResponse] | None

Parameter	Type	Default
id	UUID	required
client	AuthenticatedClient \| Client	required
body	UpdateUserGroupRequest \| Unset	UNSET

body — Request to update an existing user group

Returns: ProblemDetails | UserGroupResponse | list[ErrorResponse] | None

Raises:

Exception	Condition
UnexpectedStatus	If the server returns an undocumented status code and Client.raise_on_unexpected_status is True.
TimeoutException	If the request takes longer than Client.timeout.