Skip to content

Assigns a global connector to a workspace.

POST
/v1/m/sourcescope/assignments
curl --request POST \
--url https://example.com/v1/m/sourcescope/assignments \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "connector_name": "example", "enabled": true, "id": "example", "mode": "example", "note": "example", "workspace_ref": "example" }'

Assigns a global connector to a workspace. An ENABLED assignment added to an already-assigned connector admits a workspace that could not reach it a moment earlier, so it is proposed rather than applied (202), exactly like a relaxing binding create.

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
connector_name
required

After trimming it must be non-empty.

string
enabled
Any of:
boolean
id
Any of:

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

string
mode
Any of:

After trimming and lowercasing, r remains r; every other value normalizes to rw. Blank update input preserves the stored mode.

string
note
Any of:

Capped at 512 bytes.

string
workspace_ref
required

After trimming it must resolve to a workspace.

string
Example generated
{
"connector_name": "example",
"enabled": true,
"id": "example",
"mode": "example",
"note": "example",
"workspace_ref": "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
{}