Organization
The organization the connection's token acts for, in the singular. Two tools: get and update. Neither takes an id or a workspace: the organization comes from the token alone, never from an argument, and its profile applies to every workspace.
organization_get​
Read · scope
inbox/workspaces· permissionsettings.show·GET /organization
Fetch the token's organization: id, public_id, external_id, name, slug, document_type, document_number, email, phone, custom_metadata, created_at, updated_at. The same JSON as GET /v1/organization. Kobana's commercial settings (courtesy, plan, limits, partner) and the system metadata are never returned.
This tool takes no parameters. Every system role (owner, admin, viewer) holds settings.show.
organization_update​
Write · scope
inbox/workspaces+write· permissionsettings.update·PATCH /organization
Update the organization's custom_metadata. The same as PATCH /v1/organization. Owners and admins hold settings.update.
| Parameter | Type | Description |
|---|---|---|
custom_metadata | object | null | Free-form JSON owned by you. null keeps the stored value. |
custom_metadata_mode | string | replace (default) or merge (deep-merges over the stored value). |
The identity (external_id, slug, document_type, document_number) cannot be changed, nor can name, email and phone: they mirror the Kobana account and are kept in sync from it. Sent anyway, they are ignored. Kobana's commercial settings are not parameters of this tool; the endpoint refuses a body that names one with 403 FORBIDDEN. Every change is recorded in the organization audit log.
The scope is inbox/workspaces because the authorization server has no inbox/settings scope yet: the organization is what the workspaces belong to.