DataBolsa docs

Organização e equipe

Papéis, convites, visibilidade de clientes, licença, chaves de organização e trilha de auditoria.

Toda operação do Advisor acontece dentro de uma organização, identificada pelo slug (meu-escritorio) ou pelo id. advisorGetMe lista as organizações em que a sua credencial pode agir.

Papéis

PapelO que pode
ownertudo, incluindo trocar papéis e revogar chaves
adminequipe, clientes, carteiras e chaves
advisor (assessor)os clientes que enxerga, e as carteiras deles

Papel é por pessoa e ocupa um assento da licença. Quem só precisa consultar não vira membro — use uma chave de organização com escopo read.

Visibilidade de clientes

settings.client_visibility decide o que um assessor enxerga:

  • all — todo assessor vê a carteira de clientes inteira do escritório.
  • assigned — cada assessor vê apenas os clientes de quem é o responsável (advisorSetClientAssignment).
databolsa-advisor advisorUpdateOrganization meu-escritorio \
  --settings '{"client_visibility":"assigned"}'

Com assigned, um cliente fora da carteira do assessor responde 404 — o mesmo que um cliente de outro escritório. É proposital: a resposta não revela que o registro existe.

Convites

Convidar é por e-mail e por papel. O aceite exige que a pessoa esteja logada com a conta que foi convidada — um convite não pode ser transferido.

databolsa-advisor advisorCreateInvitation meu-escritorio \
  --email [email protected] --role advisor
databolsa-advisor advisorListInvitations meu-escritorio
databolsa-advisor advisorRevokeInvitation meu-escritorio <invitationId>

Para tirar alguém de circulação sem perder o histórico, suspenda em vez de remover: advisorUpdateMember ... --status suspended. A trilha de auditoria continua apontando para o membro.

Licença

advisorGetLicense devolve plano, assentos, limite de clientes e validade. Vencida, toda escrita responde 402 com code: license_required e as leituras seguem abertas — o escritório nunca perde acesso ao próprio dado.

databolsa-advisor advisorGetLicense meu-escritorio

Chaves de organização

Chaves db_org_... são a credencial de serviço do escritório, em dois escopos:

  • full — opera como admin;
  • read — somente leitura.
databolsa-advisor advisorCreateOrgKey meu-escritorio --name "integração ERP" --scope read
databolsa-advisor advisorListOrgKeys meu-escritorio
databolsa-advisor advisorRevokeOrgKey meu-escritorio <keyId>

A chave inteira volta uma vez só, na criação. Depois disso a listagem mostra apenas o prefixo e os metadados. Chave de organização é um secret de servidor: nunca em código de browser, variável NEXT_PUBLIC_*, prompt ou log.

A chave pessoal do produto B2C não autentica no Advisor: ela pertence a outro realm de identidade. Para agir com o papel e a visibilidade do seu assento, use o conector com login (OAuth) ou o portal.

Auditoria

Toda escrita — em qualquer porta — entra em advisorListAuditLog com autor, ação, recurso e origem, na mesma transação da mudança. Não há como escrever sem deixar registro.

databolsa-advisor advisorListAuditLog meu-escritorio --limit 50 --json