Skip to main content
POST
Grant a credential to an installed agent

Authorizations

Authorization
string
header
required

API key: key id as the username, secret as the password. An account API key carries the same scopes as an OAuth token and is checked against the scopes listed under oauth2 on each operation. A trigger API key is limited to its trigger's workspace and reaches only the session operations that list this scheme alongside the oauth2 scopes.

Path Parameters

workspace_agent_id
string<uuid>
required

Body

application/json
auth_config_id
string<uuid>
required
credentials_id
string<uuid>
required
replace
boolean
default:false

Revoke the bindings that would block this one, in the same transaction: either everything commits or nothing changes. A dedicated key and a grant serving every member exclude each other.

Response

Successful response

id
string<uuid>
created_at
string<date-time>
updated_at
string<date-time>
auth_config_id
string<uuid>

Integration auth config this row applies to

created_by_id
string<uuid>

The user or API key that granted this credential to the agent.

target_id
string<uuid>

Workspace agent install receiving the credential; the association is scoped to this install's workspace. Account-wide availability is plain credential ownership with no association row.

kind
enum<string>

GRANTED = existing credential shared with the agent; CONNECTED = credential created for the agent (connect flow).

Available options:
CONNECTED,
GRANTED
credentials_id
string<uuid> | null

Linked credential row; null while OAuth connect is pending.

integration
any
member_owned
any
owner
any
runs_as
any
workspace
any
workspace_agent_id
any