Skip to main content
PATCH
cURL
Two fields are writable: permission_level, and tool_scope for live-connection grants.
Raising a live-connection grant to manager clears its tool_scope. A manager sees the connection’s full available tool set by definition, so the two cannot coexist — sending both in the same request returns 400.
Setting tool_scope on a secret grant returns 400: the field applies to live connections only.

Authorizations

x-api-key
string
header
required

API Key authentication. Format: 'x-api-key: api_key'

Path Parameters

id
string<uuid>
required

A UUID string identifying this Object permission.

Body

A grant of access to a secret or a live connection.

permission_level
enum<string>
  • manager - Manager
  • editor - Editor
  • viewer - Viewer
Available options:
manager,
editor,
viewer
tool_scope
any | null

Live connections only: subset of the connection's available tools this access may use (NULL = the full available set, tracking it as it changes; MANAGER grants are always NULL)

Response

200 - application/json

A grant of access to a secret or a live connection.

id
string<uuid>
required
read-only
permission_level
enum<string>
required
  • manager - Manager
  • editor - Editor
  • viewer - Viewer
Available options:
manager,
editor,
viewer
created_at
string<date-time>
required
read-only
updated_at
string<date-time>
required
read-only
user
string
required
read-only

User (Expandable)

group
string
required
read-only

Group (Expandable)

secret
string
required
read-only

Secret (Expandable)

live_connection
string
required
read-only

Live connection (Expandable)

granted_by
string
required
read-only

Granted by (Expandable)

tool_scope
any | null

Live connections only: subset of the connection's available tools this access may use (NULL = the full available set, tracking it as it changes; MANAGER grants are always NULL)