Pular para o conteúdo principal

Papéis, permissões e escopos

O acesso de equipe depende da identidade, da membership ativa, das permissões e do escopo do produto. O COBRES verifica essas condições na API, mesmo quando a interface já escondeu uma ação.

Membership da organização​

Uma membership associa a pessoa à organização. Ela pode possuir papéis, indicação de titularidade, modo de somente leitura, escopo de empresas e função de cobrança.

Os schemas representam o escopo de empresas como all ou selected, com uma lista de empresas quando aplicável. A função de cobrança pode ser manager, coordinator ou operator. Essas funções participam das regras do COBRES e não substituem o catálogo de permissões.

Papéis personalizados reúnem chaves de permissão. Titular e somente leitura são representações virtuais com regras próprias; não devem ser tratados como papéis personalizados editáveis.

Exemplos de famílias:

FamíliaFinalidade
identity.*Membros, papéis, chaves e webhooks
files.objects.*Leitura e escrita de arquivos
audit.events.readConsulta à trilha da organização
cobres.debtors.*Cadastro de devedores
cobres.debts.*Cadastro de dívidas
cobres.portfolios.*Carteiras
cobres.quotes.*Cotações
cobres.finance.*Rotinas financeiras
cobres.collection*Atendimento, tarefas, caixa de e-mails de cobrança e mensagens prontas
cobres.assignments.*Distribuição e transferência de dívidas
cobres.agreements.*Acordos, importação e fila de desacordo
cobres.offers.*Pedido e registro da aprovação do credor
cobres.portal_submissions.reviewConferência dos cadastros enviados pelo credor

Não interprete o asterisco como uma permissão literal aceitada pela API. Consulte as chaves cadastradas e selecione as necessárias.

Humanos e integrações​

O middleware autentica, e require_permission é a porta comum de autorização para humanos e chaves. Chaves usam o retrato de permissões armazenado, sem herdar futuras ampliações do papel de origem.

Além da permissão, certas rotas exigem pessoa humana. Nesse caso, a chave recebe actor_not_allowed. Um resultado permission_denied indica ausência de autorização para a ação; um not_found também pode refletir recurso fora do escopo.

Equipe da plataforma​

Os papéis de plataforma são platform_owner, platform_admin, platform_finance, platform_analyst e platform_support. Cada um recebe um conjunto definido de chaves platform.*. Permissão da plataforma não equivale à permissão da organização.

Revise permissões ao mudar responsabilidades, bloquear membros ou substituir integrações. Mudanças na interface não são uma forma de revogação: aplique-as nos vínculos, papéis e chaves correspondentes.