Skip to main content

​
Campos

CampoTipoDescrição
roleIdUUIDIdentificador único
organizationIdUUID?Referência à organização; preenchido apenas para ORGANIZATION
typeRoleTypeTipo da role (INTERNAL, ENVIRONMENT ou ORGANIZATION)
nameStringNome do papel (ex.: “Admin”, “Agente”)
descriptionString?Descrição do papel
createdByUUID?Usuário que criou o registro, quando aplicável
createdAtDateTimeData de criação
updatedByUUID?Usuário que fez a última atualização, quando aplicável
updatedAtDateTimeData da última atualização
deletedByUUID?Usuário que removeu o registro, quando aplicável
deletedAtDateTime?Data de remoção

​
Relacionamentos

​
Regras de Negócio

  • INTERNAL é usado apenas no BackOffice e não pertence a uma organização.
  • ENVIRONMENT é uma role global reutilizável por organizações; a organização aparece na Membership, não na Role.
  • ORGANIZATION é customizada por uma organização e exige organizationId preenchido.
  • Um papel é um conjunto nomeado de permissions do catálogo do DEVMOB.
  • Usuários são associados a roles por Membership.
  • Exclusão é lógica (deletedAt); papéis excluídos são ignorados nas consultas.
  • Ao criar uma organização, o owner recebe uma Membership ACTIVE com uma role admin de ambiente compatível com o tipo da organização.

​
Enums

​
RoleType

ValorDescrição
INTERNALRole interna para BackOffice, fora de qualquer organização
ENVIRONMENTRole global reutilizável por organizações
ORGANIZATIONRole customizada por uma organização

​
Example

{
  "roleId": "0197a7f8-15d1-7320-9b60-02497d7a0d61",
  "organizationId": null,
  "type": "ENVIRONMENT",
  "name": "Agente de Vendas",
  "description": "Role padrão para operação de vendas em empresa",
  "createdBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "createdAt": "2026-07-03T13:10:00.000Z",
  "updatedBy": "0197a805-0910-7eb2-bae7-90a13df2a9b2",
  "updatedAt": "2026-07-03T13:10:00.000Z",
  "deletedBy": null,
  "deletedAt": null
}