listGrants

GET

/api/v1/agents/{agentId}/grants

Who has access to the agent, including implicit access (owner, workspace owners and admins).

listGrants

curl --request GET \
  --url '<base-url>/api/v1/agents/<agentId>/grants' \
  --cookie 'agenthold_session=<agenthold_session>'

const url = '<base-url>/api/v1/agents/<agentId>/grants';
const options = {
  method: 'GET',
  headers: {cookie: 'agenthold_session=<agenthold_session>'}
};

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

Response example

{
  "grants": [
    {
      "id": "string",
      "subjectType": "user",
      "user": {
        "id": "string",
        "email": "string",
        "name": "string",
        "avatarUrl": "string"
      },
      "role": "viewer",
      "createdAt": "2019-08-24T14:15:22Z"
    }
  ],
  "effective": [
    {
      "user": {
        "id": "string",
        "email": "string",
        "name": "string",
        "avatarUrl": "string"
      },
      "role": "viewer",
      "via": "owner"
    }
  ]
}

{
  "error": "string"
}

Authorization

session
optional
API key in cookie

token
optional
HTTP Bearer
Authorization: Bearer <token>

Path parameters

agentId
string
required

Returns

200

Access list.

JSON

grants
array of
object
required
- 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
}
effective
array of
object
required
Every workspace member with access and their effective role.
- user
  object
  required
  id
  string
  required
  email
  string
  required
  name
  string
  required
  avatarUrl
  string
  required
- role
  viewer
  or
  operator
  or
  admin
  required
- via
  owner
  or
  workspace_admin
  or
  grant
  or
  workspace_grant
  required
}

404

Error.

JSON

error
string
required