Skip to main content
Proxied do WorkOS — nao e armazenado no banco de dados da aplicacao.

​
Esquema

CampoTipoDescricao
permissionIdstringIdentificador unico (formato WorkOS: perm_*)
slugstringUnico (formato: resource:action)
resourcestringNome do recurso
actionstringNome da acao
namestringNome de exibicao
descriptionstring?Descricao
systembooleanPermissao definida pelo sistema
createdAtdatetimeTimestamp de criacao
updatedAtdatetimeUltima atualizacao

​
Exemplo

{
  "permissionId": "perm_01JK8BILLING12345READ",
  "slug": "billing:read",
  "resource": "billing",
  "action": "read",
  "name": "Visualizar Billing",
  "description": "Permite visualizar informacoes de cobranca e faturas",
  "system": true,
  "createdAt": "2026-01-10T08:00:00Z",
  "updatedAt": "2026-01-10T08:00:00Z"
}

​
Relacionamentos

  • Atribuida a Roles via array de slugs

​
Regras de Negocio

  • Formato: resource:action (ex: users:read)
  • Permissoes de sistema sao imutaveis
Permissoes com system: true sao gerenciadas pelo WorkOS e nao podem ser editadas ou removidas pela aplicacao. Apenas permissoes customizadas (system: false) podem ser modificadas.
O slug segue o padrao resource:action, permitindo verificacao granular de acesso. Exemplos: users:read, users:write, billing:read, settings:delete.