setGrant

POST

/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.

setGrant

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"
}
'

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));

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)

Response example

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

{
  "error": "string"
}

{
  "error": "string"
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Request body JSON required

subjectType
user
or
workspace
required
role
viewer
or
operator
or
admin
required
userId
optional
string
Required for subjectType user; must be a workspace member.

Returns

200

Saved.

JSON

id
string
required
subjectType
user
or
workspace
required
role
viewer
or
operator
or
admin
required
createdAt
string
required
format: date-time
user
optional
object
- id
  string
  required
- email
  string
  required
- name
  string
  required
- avatarUrl
  string
  required
}

400

Error.

JSON

error
string
required

403

Error.

JSON

error
string
required

404

Error.

JSON

error
string
required