---
title: "SetUserGroups"
---

> 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 › users

`PUT /v1/organizations/{orgId}/users/{userId}/groups`

## Authentication

Requires one of the following:

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

## Path parameters

- `SetUserGroups.path.orgId` (string, required)
- `SetUserGroups.path.userId` (string, required)

## Header parameters

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

## Request body

_Required._

- `SetUserGroups.groupIds` (array<string>, required)

## Example request

```json
{
  "groupIds": [
    "string"
  ]
}
```

## Code samples

### cURL

```curl
curl --request PUT \
  --url https://orgs.ezghcloud.com/v1/organizations/string/users/string/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "groupIds": [
    "string"
  ]
}
'
```

### TypeScript

```typescript
const url = 'https://orgs.ezghcloud.com/v1/organizations/string/users/string/groups';
const options = {
  method: 'PUT',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({groupIds: ['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/users/string/groups"

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

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

print(response.text)
```

## Responses

### 200

Success

#### Example

```json
{
  "groupIds": [
    "string"
  ]
}
```

- `SetUserGroups.response.200.groupIds` (array<string>, required)

### 400

InvalidRequest

#### Example

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

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

### 401

Unauthenticated

#### Example

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

- `SetUserGroups.response.401.error` (object, required)
  - `SetUserGroups.response.401.error.code` (string, required)
    - one of `"unauthenticated"`
  - `SetUserGroups.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"
  }
}
```

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

### 409

ManagedByScim

#### Example

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

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

### 412

PreconditionFailed

#### Example

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

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

### 429

TooManyRequests

#### Example

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

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

### 500

InternalError

#### Example

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

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

### 503

Unavailable

#### Example

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

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


Source: https://docs.ezghcloud.com/orgs-api/users/SetUserGroups/index.md