User Groups Module API

API reference for user group management endpoints.

BriteCore V2 user_groups API endpoint wrappers.

britecore_sdk.api.api_calls.v2.user_groups.add_group(user_group=None, **kwargs)[source]

Add Group.

POST /api/v2/user_groups/add_group

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.user_groups.delete_group(id=None, **kwargs)[source]

Delete Group.

POST /api/v2/user_groups/delete_group

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.user_groups.get_group(id=None, **kwargs)[source]

Get Group.

POST /api/v2/user_groups/get_group

Parameters:
Return type:

Any

britecore_sdk.api.api_calls.v2.user_groups.list_groups(**kwargs)[source]

List Groups.

POST /api/v2/user_groups/list_groups

Parameters:

kwargs (Unpack[RequestParameters])

Return type:

Any

britecore_sdk.api.api_calls.v2.user_groups.update_group(user_group=None, **kwargs)[source]

Update Group.

POST /api/v2/user_groups/update_group

Parameters:
Return type:

Any