---
title: "setGrant"
---

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

# setGrant

Path: agenthold API › sharing

`POST /agents/{agentId}/grants`

URL: `/api/v1/agents/{agentId}/grants`

Grant a role to a workspace member or to the whole workspace (agent admin). Replaces an existing grant for the same subject.

## Authentication

Requires one of the following:

- `session`, apiKey, in cookie
- `token`, http bearer, header `Authorization`

## Path parameters

- `agentId` (`setGrant.path.agentId`; string, required)

## Request body

_Required._

- `subjectType` (`setGrant.subjectType`; string, required)
  - one of `"user"`, `"workspace"`
- `role` (`setGrant.role`; string, required)
  - one of `"viewer"`, `"operator"`, `"admin"`
- `userId` (`setGrant.userId`; string, optional) — Required for subjectType user; must be a workspace member.

## Example request

```json
{
  "subjectType": "user",
  "userId": "string",
  "role": "viewer"
}
```

## Code samples

### cURL

```bash
curl --request POST \
  --url '<base-url>/api/v1/agents/<agentId>/grants' \
  --header 'Content-Type: application/json' \
  --cookie 'agenthold_session=<agenthold_session>' \
  --data '
{
  "subjectType": "user",
  "userId": "string",
  "role": "viewer"
}
'
```

### TypeScript

```typescript
const url = '<base-url>/api/v1/agents/<agentId>/grants';
const options = {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    cookie: 'agenthold_session=<agenthold_session>'
  },
  body: JSON.stringify({subjectType: 'user', userId: 'string', role: 'viewer'})
};

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

### Python

```python
import requests

url = "<base-url>/api/v1/agents/<agentId>/grants"

payload = {
    "subjectType": "user",
    "userId": "string",
    "role": "viewer"
}
headers = {
    "cookie": "agenthold_session=<agenthold_session>",
    "Content-Type": "application/json"
}

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

print(response.text)
```

## Responses

### 200

Saved.

#### Example

```json
{
  "id": "string",
  "subjectType": "user",
  "user": {
    "id": "string",
    "email": "string",
    "name": "string",
    "avatarUrl": "string"
  },
  "role": "viewer",
  "createdAt": "2019-08-24T14:15:22Z"
}
```

- `id` (`setGrant.response.200.id`; string, required)
- `subjectType` (`setGrant.response.200.subjectType`; string, required)
  - one of `"user"`, `"workspace"`
- `role` (`setGrant.response.200.role`; string, required)
  - one of `"viewer"`, `"operator"`, `"admin"`
- `createdAt` (`setGrant.response.200.createdAt`; string, required)
  - format: `date-time`
- `user` (`setGrant.response.200.user`; object, optional)
  - `id` (`setGrant.response.200.user.id`; string, required)
  - `email` (`setGrant.response.200.user.email`; string, required)
  - `name` (`setGrant.response.200.user.name`; string, required)
  - `avatarUrl` (`setGrant.response.200.user.avatarUrl`; string, required)

### 400

Error.

#### Example

```json
{
  "error": "string"
}
```

- `error` (`setGrant.response.400.error`; string, required)

### 403

Error.

#### Example

```json
{
  "error": "string"
}
```

- `error` (`setGrant.response.403.error`; string, required)

### 404

Error.

#### Example

```json
{
  "error": "string"
}
```

- `error` (`setGrant.response.404.error`; string, required)


Source: https://agenthold.dev/api/set-grant/index.md