Criar papel

Cria um novo papel (role) para a empresa.

O único campo obrigatório é name. Os demais (description, intern, type, permissions) são opcionais na criação — porém recomendamos sempre enviá-los completos, já que uma atualização posterior deste papel (PUT /v1/companies/roles/{roleId}) é uma substituição completa do objeto, sem leitura prévia de permissões pela API.

O array permissions segue o formato [{module, permissions: {<recurso>: [ações]}}], o mesmo utilizado na atualização e refletido no catálogo de permissões disponíveis.

A flag intern indica se o papel é um papel interno da plataforma (true, reservado a papéis do próprio sistema) ou um papel de uso normal da empresa (false — o caso mais comum ao criar papéis para clientes). O campo type identifica a categoria do papel; os valores mais comuns são normal, para papéis restritos à empresa, e global, para papéis que atravessam empresas.

Existem papéis canônicos padrão — por exemplo, perfis de analista, gerente, diretor e comercial de crédito — comumente usados como referência de permissões ao configurar papéis em novas empresas.

curl --location '/v1/companies/roles' \ --header 'Content-Type: application/json' \ --data '{ "name": "string", "description": "string", "intern": true, "type": "string", "permissions": [ { "module": "string", "permissions": {} } ] }'

Requisição

Respostas