Skip to content

Binds a connected source to a workspace/agent-group, recording a self-audit attributed to the real principal.

POST
/v1/m/sourcescope/bindings
curl --request POST \
--url https://example.com/v1/m/sourcescope/bindings \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "cred_hint": "example", "cred_name": "example", "cred_ref": "example", "cred_ref_kind": "example", "effect": "example", "enabled": true, "folder_path": "example", "id": "example", "note": "example", "scope_ref": "example", "scope_tree": "example", "source_ref": "example", "source_type": "example" }'

Binds a connected source to a workspace/agent-group, recording a self-audit attributed to the real principal.

X-Olivares-Tenant
string format: uuid

Target tenant id; required when the principal can act in more than one tenant.

Media type application/json
object
cred_hint
Any of:

Masked partial only; capped at 64 bytes.

string
cred_name
Any of:

Credential-reference tuple. When any tuple field is non-empty, name, ref_kind, and ref are all required.

string
cred_ref
Any of:

A credential locator, never an inline credential value.

string
cred_ref_kind
Any of:

Case-insensitive after trimming: env, vault, secret_manager, file, or other.

string
effect
Any of:

Case-insensitive after trimming. Empty defaults to allow; otherwise allow or forbid.

string
enabled
Any of:
boolean
folder_path
Any of:

Output-only projection accepted by the DTO but ignored; the store resolves it from scope_ref.

string
id
Any of:

Accepted by the DTO but ignored on input; identity comes from the store.

string
note
Any of:

Capped at 512 bytes.

string
scope_ref
Any of:

Required for every scope_tree except workspace; a blank workspace ref selects the default workspace.

string
scope_tree
required

Case-insensitive after trimming: workspace, agent_group, folder, session, agent, user, user_group, or role.

string
source_ref
required

After trimming it must be non-empty. On update the stored value wins.

string
source_type
required

Case-insensitive after trimming: mcp, model, provider, knowledge, or data. On update the stored value wins.

string
Example generated
{
"cred_hint": "example",
"cred_name": "example",
"cred_ref": "example",
"cred_ref_kind": "example",
"effect": "example",
"enabled": true,
"folder_path": "example",
"id": "example",
"note": "example",
"scope_ref": "example",
"scope_tree": "example",
"source_ref": "example",
"source_type": "example"
}

OK

Media type application/json
object
Example generated
{}

Bad request

Media type application/json
object
Example generated
{}

Unauthenticated

Media type application/json
object
Example generated
{}

Forbidden

Media type application/json
object
Example generated
{}

Not found

Media type application/json
object
Example generated
{}

Conflict / setup required

Media type application/json
object
Example generated
{}

Rate limited

Media type application/json
object
Example generated
{}