> ## Documentation Index
> Fetch the complete documentation index at: https://docs.cocoondata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# <access-service>/api/v1/groups/{groupId}

## URL structure&#x20;

```text theme={null}
https://access-service.xy-company.com/api/v1/groups/{groupId}
```

where `{groupId}` is the ID of a group.

## Supported methods and overview&#x20;

* `GET` - used to retrieve information about an existing [group](/3.0/admin/managing-groups.md), based on the group's ID.
* `PUT` - used to modify the fields of an existing group and/or the association of [labels](/3.0/admin/managing-labels.md) and the membership of [Covata users](/3.0/admin/administering-users.md) with this group.
* `DELETE` - used to delete an existing group.

> [!NOTE]
>
> The `GET` and `DELETE` methods take no parameters.

## Detailed description&#x20;

This API endpoint serves a number of purposes:

* Retrieves information about an existing group, using the group's ID. A group's ID can be obtained by calling the `GET` method of the [\<access-service>/api/v1/groups](/3.0/api/access-service-api-v1-groups.md) API endpoint, which retrieves a list of field information for all existing groups on the Covata Platform. \

  **Tip:** All information (except the **description** member) returned in the [response](/3.0/api/access-service-api-v1-groups-groupid.md#access-service-api-v1-groups-groupid-returns-from-a-GET-or-PUT-request) from a `GET` method call to this API endpoint is also returned in the [response](/3.0/api/access-service-api-v1-groups.md#access-service-api-v1-groups-returns-from-a-GET-request) from a `GET` method call to the [\<access-service>/api/v1/groups](/3.0/api/access-service-api-v1-groups.md) endpoint. Therefore, if you do not require a group's **description** when retrieving information about the group, there is no need to call the `GET` method on this API endpoint.
* Modifies the fields of an existing group and/or the association of labels and the membership of Covata users with this group, based on the group's ID. This endpoint's `PUT` method allows modification of a group's name and description, as well as:

  * the association (i.e. addition) of [labels](/3.0/api/access-service-api-v1-labels.md) with the group,
  * the removal of labels from the group and
  * the addition (i.e. membership) of Covata users to (or their removal from) this group.
* Deletes an existing group from the Covata Platform. \

  **Important:** Deleting an existing group removes any association between the Covata users who were members of this group as well as any labels that were associated with the group. Therefore, if a Covata user was shared a [Secure Object](/3.0/api/creating-secure-objects-and-collections.md#secure-object) with a label that is associated with one or more groups (of which the user is also a member) and the deletion of one of these groups results in the user:

  * Still remaining associated with this label (through the label's association with other groups to which the user is also a member), then the user will still have access to this Secure Object.
  * Losing their association with this label (because the user was not a member of any other group that had an association with this label), then the user loses access to this Secure Object.

## Supported roles&#x20;

This API endpoint supports the following Covata user [roles](/3.0/admin/administering-users.md#a-users-roles) (as described in the [Covata Platform Administrator's Guide](/3.0/admin.md)):

* [System administrator](/3.0/admin/administering-users.md#system-administrator-role)

The Covata Platform's resources available to one of these Covata users (above) is determined by the access token passed in the [header](/3.0/api/access-service-api-v1-groups-groupid.md#access-service-api-v1-groups-groupid-required-headers) of requests to this endpoint.

## Required headers&#x20;

The appropriate access token as the `Bearer` token:

* `Authorization: Bearer a1b2c3d4-e5f6-g7h8-i9j0-k1l2m3n4o5p6`

The following header is required if the body of the request has a JSON object:

* `Content-Type: application/json`

## Optional parameters&#x20;

The following optional parameters can also be sent in the body of the PUT request, each as individual members of a JSON object:

* **description** - .
* **labels** - .

  * **add** - .

    * **id** - .
  * **remove** - .

    * **id** - .
* **members** - .

  * **add** - .

    * **email** - .
  * **remove** - .

    * **email** - .
* **name** - .

  **Example ():**

## Returns from a GET or PUT request&#x20;

A JSON-formatted response containing the following members:

* **id** - .
* **name** - .
* **description** - .

  **Example (response from ...):**

## Returns from a DELETE request&#x20;

If the request succeeded, then an HTTP response status `200 OK` is returned.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.