---
title: "UpdateGroup"
---

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

Path: EZGH Cloud organizations and IAM › groups

`PATCH /v1/organizations/{orgId}/groups/{groupId}`

## Authentication

Requires one of the following:

- `apiKey`, http, header `Authorization`
- `sessionCookie`, apiKey, in cookie
- `oauth`, http, header `Authorization`

## Path parameters

- `UpdateGroup.path.orgId` (string, required)
- `UpdateGroup.path.groupId` (string, required)

## Header parameters

- `UpdateGroup.header.if-match` (string, optional)

## Request body

_Required._

- `UpdateGroup.name` (string, optional)
- `UpdateGroup.description` (string, optional)

## Example request

```json
{
  "name": "string",
  "description": "string"
}
```

## Code samples

### cURL

```curl
curl --request PATCH \
  --url https://orgs.ezghcloud.com/v1/organizations/string/groups/string \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "description": "string"
}
'
```

### TypeScript

```typescript
const url = 'https://orgs.ezghcloud.com/v1/organizations/string/groups/string';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({name: 'string', description: 'string'})
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));
```

### Python

```python
import requests

url = "https://orgs.ezghcloud.com/v1/organizations/string/groups/string"

payload = {
    "name": "string",
    "description": "string"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)
```

## Responses

### 200

Success

#### Example

```json
{
  "id": "string",
  "name": "string",
  "slug": "string",
  "resourceName": "string",
  "description": "string",
  "members": [
    {
      "type": "user",
      "id": "string"
    }
  ],
  "policyIds": [
    "string"
  ],
  "managedBy": "scim",
  "locked": true,
  "createdAt": "string",
  "updatedAt": "string"
}
```

- `UpdateGroup.response.200.id` (string, required)
- `UpdateGroup.response.200.name` (string, required)
- `UpdateGroup.response.200.slug` (string, required)
- `UpdateGroup.response.200.resourceName` (string, required)
- `UpdateGroup.response.200.description` (string, required)
- `UpdateGroup.response.200.members` (array<object>, required)
  - `UpdateGroup.response.200.members.type` (string, required)
    - one of `"user"`, `"bot"`
  - `UpdateGroup.response.200.members.id` (string, required)
- `UpdateGroup.response.200.policyIds` (array<string>, required)
- `UpdateGroup.response.200.managedBy` (any of, required)
  - any of: `string`, `null`
- `UpdateGroup.response.200.locked` (boolean, required)
- `UpdateGroup.response.200.createdAt` (string, required)
- `UpdateGroup.response.200.updatedAt` (string, required)

### 400

InvalidRequest

#### Example

```json
{
  "error": {
    "code": "invalid_request",
    "message": "string",
    "issues": [
      {
        "path": "string",
        "message": "string"
      }
    ]
  }
}
```

- `UpdateGroup.response.400.error` (object, required)
  - `UpdateGroup.response.400.error.code` (string, required)
    - one of `"invalid_request"`
  - `UpdateGroup.response.400.error.message` (string, required)
  - `UpdateGroup.response.400.error.issues` (array<object>, optional)
    - `UpdateGroup.response.400.error.issues.path` (string, required)
    - `UpdateGroup.response.400.error.issues.message` (string, required)

### 401

Unauthenticated

#### Example

```json
{
  "error": {
    "code": "unauthenticated",
    "message": "string"
  }
}
```

- `UpdateGroup.response.401.error` (object, required)
  - `UpdateGroup.response.401.error.code` (string, required)
    - one of `"unauthenticated"`
  - `UpdateGroup.response.401.error.message` (string, required)

### 403

AccessDenied | ForbiddenOrigin

#### Example

```json
{
  "error": {
    "code": "access_denied",
    "message": "string"
  }
}
```

Any of:

- [AccessDeniedEncoded](/orgs-api/schemas/AccessDeniedEncoded/)
- [ForbiddenOriginEncoded](/orgs-api/schemas/ForbiddenOriginEncoded/)

### 404

NotFound

#### Example

```json
{
  "error": {
    "code": "not_found",
    "message": "string"
  }
}
```

- `UpdateGroup.response.404.error` (object, required)
  - `UpdateGroup.response.404.error.code` (string, required)
    - one of `"not_found"`
  - `UpdateGroup.response.404.error.message` (string, required)

### 409

ManagedByScim

#### Example

```json
{
  "error": {
    "code": "managed_by_scim",
    "message": "string"
  }
}
```

- `UpdateGroup.response.409.error` (object, required)
  - `UpdateGroup.response.409.error.code` (string, required)
    - one of `"managed_by_scim"`
  - `UpdateGroup.response.409.error.message` (string, required)

### 412

PreconditionFailed

#### Example

```json
{
  "error": {
    "code": "precondition_failed",
    "message": "string"
  }
}
```

- `UpdateGroup.response.412.error` (object, required)
  - `UpdateGroup.response.412.error.code` (string, required)
    - one of `"precondition_failed"`
  - `UpdateGroup.response.412.error.message` (string, required)

### 429

TooManyRequests

#### Example

```json
{
  "error": {
    "code": "too_many_requests",
    "message": "string"
  }
}
```

- `UpdateGroup.response.429.error` (object, required)
  - `UpdateGroup.response.429.error.code` (string, required)
    - one of `"too_many_requests"`
  - `UpdateGroup.response.429.error.message` (string, required)

### 500

InternalError

#### Example

```json
{
  "error": {
    "code": "internal_error",
    "message": "string"
  }
}
```

- `UpdateGroup.response.500.error` (object, required)
  - `UpdateGroup.response.500.error.code` (string, required)
    - one of `"internal_error"`
  - `UpdateGroup.response.500.error.message` (string, required)

### 503

Unavailable

#### Example

```json
{
  "error": {
    "code": "unavailable",
    "message": "string"
  }
}
```

- `UpdateGroup.response.503.error` (object, required)
  - `UpdateGroup.response.503.error.code` (string, required)
    - one of `"unavailable"`
  - `UpdateGroup.response.503.error.message` (string, required)


Source: https://docs.ezghcloud.com/orgs-api/groups/UpdateGroup/index.md