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

# Update Group

> Updates group information.

`Unary` · [`Groups`](/docs/api-reference/generated/group/overview)

Updates group information.

Use this method to:

* Rename a group
* Update group description

### Examples

* Update group name:

  Changes the name of an existing group.

  ```yaml theme={null}
  groupId: "d2c94c27-3b76-4a42-b88c-95a85e392c68"
  name: "Platform Team"
  description: "Platform engineering team"
  ```

### Authorization

Requires `org:admin` permission on the organization or `group:admin` permission on the specific group.

## Endpoint

```text theme={null}
POST /api/gitpod.v1.GroupService/UpdateGroup
```

Send a Bearer token as described in [Authentication](/docs/api-reference#authenticate-requests). If your organization uses a custom management-plane domain, replace `https://app.ona.com` with that domain.

## Request example

<CodeGroup>
  ```bash cURL theme={null}
  export ONA_HOST=https://app.ona.com
  export ONA_API_KEY=<your-token>

  curl --request POST \
    --url "$ONA_HOST/api/gitpod.v1.GroupService/UpdateGroup" \
    --header "Authorization: Bearer $ONA_API_KEY" \
    --header "Content-Type: application/json" \
    --data '{
    "groupId": "<group-id>"
  }'
  ```

  ```python Python theme={null}
  import gitpod.v1.group_pb2 as group_pb2
  from ona_sdk import create_client_from_env

  ona = create_client_from_env()
  request = group_pb2.UpdateGroupRequest(
      group_id="<group-id>",
  )
  response = ona.services.group.update_group(request)
  print(response)
  ```

  ```typescript TypeScript theme={null}
  import { create } from "@bufbuild/protobuf";
  import { createClientFromEnv } from "@gitpod/sdk";
  import { UpdateGroupRequestSchema } from "@gitpod/sdk/gitpod/v1/group_pb";

  async function main() {
    const ona = createClientFromEnv();
    const request = create(UpdateGroupRequestSchema, {
      groupId: "<group-id>",
    });
    const response = await ona.services.group.updateGroup(request);
    console.log(response);
  }

  main().catch(console.error);
  ```

  ```go Go theme={null}
  package main

  import (
  	"context"
  	"fmt"
  	"log"

  	"connectrpc.com/connect"
  	"github.com/gitpod-io/gitpod-sdk-go/sdk"
  	gitpodpb "github.com/gitpod-io/gitpod-sdk-go/v1"
  )

  func main() {
  	ona, err := sdk.NewFromEnv()
  	if err != nil {
  		log.Fatal(err)
  	}

  	request := connect.NewRequest(&gitpodpb.UpdateGroupRequest{
  		GroupId: "<group-id>",
  	})
  	response, err := ona.Services.Group.UpdateGroup(context.Background(), request)
  	if err != nil {
  		log.Fatal(err)
  	}
  	fmt.Println(response.Msg)
  }
  ```

  ```json Request body theme={null}
  {
    "groupId": "<group-id>"
  }
  ```
</CodeGroup>

## Request

`gitpod.v1.UpdateGroupRequest`

UpdateGroup messages

| Field         | Type   | Required | Description                                         |
| ------------- | ------ | -------- | --------------------------------------------------- |
| `groupId`     | string | No       | Constraints: `string.uuid=true`.                    |
| `name`        | string | No       | Constraints: `string.max_len=80, string.min_len=3`. |
| `description` | string | No       | Constraints: `string.max_len=255`.                  |

## Response

`gitpod.v1.UpdateGroupResponse`

| Field   | Type                           | Required | Description |
| ------- | ------------------------------ | -------- | ----------- |
| `group` | [Group](#type-gitpod-v1-group) | No       |             |

## Related types

<a id="type-gitpod-v1-group" />

<Accordion title="Group">
  `gitpod.v1.Group`

  | Field            | Type               | Required | Description                                                                                                                                |
  | ---------------- | ------------------ | -------- | ------------------------------------------------------------------------------------------------------------------------------------------ |
  | `id`             | string             | No       | Constraints: `string.uuid=true`.                                                                                                           |
  | `organizationId` | string             | No       | Constraints: `string.uuid=true`.                                                                                                           |
  | `name`           | string             | No       | Constraints: `string.max_len=80, string.min_len=3`.                                                                                        |
  | `systemManaged`  | boolean            | No       | system\_managed indicates that this group is created by the system automatically                                                           |
  | `createdAt`      | RFC 3339 timestamp | No       |                                                                                                                                            |
  | `updatedAt`      | RFC 3339 timestamp | No       |                                                                                                                                            |
  | `description`    | string             | No       | Constraints: `string.max_len=255`.                                                                                                         |
  | `memberCount`    | integer            | No       | member\_count is the total number of members in this group                                                                                 |
  | `directShare`    | boolean            | No       | direct\_share indicates that this group is used for direct user sharing on resources. These groups are hidden from regular group listings. |
</Accordion>