Create role

Creates a new role for the company.

The only required field is name. The remaining fields (description, intern, type, permissions) are optional on creation — however, we recommend always sending them complete, since a later update to this role (PUT /v1/companies/roles/{roleId}) is a full replacement of the object, with no prior read of permissions by the API.

The permissions array follows the format [{module, permissions: {<resource>: [actions]}}], the same one used on update and reflected in the permissions catalog.

The intern flag indicates whether the role is an internal platform role (true, reserved for the system's own roles) or a normal company-use role (false — the most common case when creating roles for clients). The type field identifies the role's category; the most common values are normal, for company-scoped roles, and global, for roles that span companies.

There are standard canonical roles — for example, credit analyst, credit manager, credit director, and commercial profiles — commonly used as a permissions reference when setting up roles for new companies.

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