grants

List the callers permitted to use a connection.

GET

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/grants

Returns every caller named on the connection's grant. Callers named directly on a single tool are not listed — this reads the connection's own grant. Not yet implemented — returns 501 until the behaviour lands.

List the callers permitted to use a connection. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to list grants for.

List the callers permitted to use a connection. › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Sqsp-Connector-On-Behalf-Of

string

The member or agent id this call acts on behalf of. Honoured only for a caller on this service's original-client allowlist.

List the callers permitted to use a connection. › Responses

The callers permitted to use the connection.

The callers permitted to use a connection.

ListGrantsResponse

Grant[] · required

The grants on the connection.

Permit a caller to use a connection.

PUT

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/grants

Permits the caller named in the body to use the connection, covering the connector's default tools. Granting a caller that already holds a grant changes nothing and returns that same grant.

Permit a caller to use a connection. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to grant on.

Permit a caller to use a connection. › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Sqsp-Connector-On-Behalf-Of

string

The member or agent id this call acts on behalf of. Honoured only for a caller on this service's original-client allowlist.

Permit a caller to use a connection. › Request Body

The caller to permit on a connection.

GrantConnectionAccessRequest

caller

string · required

The caller to permit: the consumer-named agent or service that will make calls through this connection.

Example: agent-runtime

Permit a caller to use a connection. › Responses

The grant the caller now holds.

A caller permitted to use a connection.

Grant

caller

string · required

The permitted caller: the consumer-named agent or service that makes calls through this connection.

Example: agent-runtime

Stop a caller using a connection.

DELETE

http://localhost:8000

/api/connectors/v1/{namespace}/{namespaceId}/connections/{connectionId}/grants/{caller}

Removes the caller from the connection's grant. This is not a guarantee that the caller can no longer reach the connection: authorization also allows a caller to be named directly on a single tool, and such a grant survives this, because it is checked against the connection being live rather than against this grant. Revoke the connection itself to stop every caller at once.

Stop a caller using a connection. › path Parameters

namespace

string · enum · required

What the connection is based off of.

Enum values:

workspace

namespaceId

string · required

Identifier of the namespace instance the connection belongs to.

connectionId

string · required

The connection to revoke on.

caller

string · required

The caller to remove.

Stop a caller using a connection. › Headers

Authorization

string · required

The Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.

Sqsp-Connector-On-Behalf-Of

string

The member or agent id this call acts on behalf of. Honoured only for a caller on this service's original-client allowlist.

Stop a caller using a connection. › Responses

The caller no longer holds this grant.

No data returned

connections connectors