# \GroupsApi

All URIs are relative to *https://registry.example.com*

Method | HTTP request | Description
------------- | ------------- | -------------
[**add_group_members**](GroupsApi.md#add_group_members) | **POST** /api/v1/groups/{id}/members | Add members to group
[**create_group**](GroupsApi.md#create_group) | **POST** /api/v1/groups | Create group
[**delete_group**](GroupsApi.md#delete_group) | **DELETE** /api/v1/groups/{id} | Delete group
[**get_group**](GroupsApi.md#get_group) | **GET** /api/v1/groups/{id} | Get group
[**list_groups**](GroupsApi.md#list_groups) | **GET** /api/v1/groups | List groups
[**remove_group_members**](GroupsApi.md#remove_group_members) | **DELETE** /api/v1/groups/{id}/members | Remove members from group
[**update_group**](GroupsApi.md#update_group) | **PATCH** /api/v1/groups/{id} | Update group



## add_group_members

> add_group_members(id, group_members_request)
Add members to group

Adds one or more users to the group. Users who are already members are silently ignored.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group UUID | [required] |
**group_members_request** | [**GroupMembersRequest**](GroupMembersRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## create_group

> models::Group create_group(create_group_request)
Create group

Creates a new group. Requires admin privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**create_group_request** | [**CreateGroupRequest**](CreateGroupRequest.md) |  | [required] |

### Return type

[**models::Group**](Group.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## delete_group

> delete_group(id)
Delete group

Permanently deletes a group and removes all associated permission grants. Requires admin privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group UUID | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## get_group

> models::Group get_group(id)
Get group

Returns a single group by its unique identifier, including its members.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group UUID | [required] |

### Return type

[**models::Group**](Group.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## list_groups

> Vec<models::Group> list_groups()
List groups

Returns all groups visible to the authenticated user.

### Parameters

This endpoint does not need any parameter.

### Return type

[**Vec<models::Group>**](Group.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## remove_group_members

> remove_group_members(id, group_members_request)
Remove members from group

Removes one or more users from the group. Users who are not members are silently ignored.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group UUID | [required] |
**group_members_request** | [**GroupMembersRequest**](GroupMembersRequest.md) |  | [required] |

### Return type

 (empty response body)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)


## update_group

> models::Group update_group(id, update_group_request)
Update group

Partially updates group metadata. Requires admin privileges.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**id** | **uuid::Uuid** | Group UUID | [required] |
**update_group_request** | [**UpdateGroupRequest**](UpdateGroupRequest.md) |  | [required] |

### Return type

[**models::Group**](Group.md)

### Authorization

[apiKeyAuth](../README.md#apiKeyAuth), [bearerAuth](../README.md#bearerAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)

