Pular para o conteúdo principal

Organização

A organização em nome da qual o token da conexão age, no singular. Duas tools: obter e atualizar. Nenhuma recebe id nem workspace: a organização vem só do token, nunca de um argumento, e o perfil dela vale para todos os workspaces.


organization_get​

Leitura · escopo inbox/workspaces · permissão settings.show · GET /organization

Devolve a organização do token: id, public_id, external_id, name, slug, document_type, document_number, email, phone, custom_metadata, created_at, updated_at. O mesmo JSON de GET /v1/organization. As configurações comerciais da Kobana (cortesia, plano, limites, parceiro) e os metadados de sistema nunca são devolvidos.

Esta tool não recebe parâmetros. Todo papel de sistema (dono, admin, leitor) tem settings.show.

organization_update​

Escrita · escopo inbox/workspaces + write · permissão settings.update · PATCH /organization

Atualiza o custom_metadata da organização. O mesmo que PATCH /v1/organization. Dono e admin têm settings.update.

ParâmetroTipoDescrição
custom_metadataobject | nullJSON livre, seu. null mantém o valor guardado.
custom_metadata_modestringreplace (padrão) ou merge (mescla em profundidade sobre o valor guardado).

A identidade (external_id, slug, document_type, document_number) não pode ser alterada, nem name, email e phone: eles espelham a conta Kobana e são sincronizados a partir dela. Se enviados, são ignorados. As configurações comerciais da Kobana não são parâmetros desta tool; o endpoint recusa com 403 FORBIDDEN um corpo que cite alguma delas. Toda alteração fica registrada no log de auditoria da organização.

O escopo é inbox/workspaces porque o servidor de autorização ainda não tem o escopo inbox/settings: a organização é a dona dos workspaces.