Skip to main content
Um role define um conjunto nomeado de permissoes que pode ser atribuido a membros da organizacao. Roles possuem dois tipos: ENVIRONMENT_ROLE (padroes globais da plataforma como Admin ou Member) e ORGANIZATION_ROLE (roles customizados criados pela organizacao). Roles de ambiente sao herdados e nao podem ser modificados, enquanto roles de organizacao oferecem customizacao completa. Voce encontrara objetos de role ao gerenciar acesso da equipe ou atribuir permissoes a memberships.
​
roleId
string
O identificador unico do role.
​
organizationId
string
O ID da organizacao (UUIDv7). Present for ORGANIZATION_ROLE type.
​
slug
string
O slug do role.
​
name
string
O nome de exibicao do role.
​
description
string|null
A descricao do role. null se nao fornecida.
​
type
string
O tipo do role. Um de: ENVIRONMENT_ROLE, ORGANIZATION_ROLE.
​
permissions
string[]
Array de slugs de permissao atribuidos ao role.
​
inherited
boolean
Se o role e herdado de um escopo pai.
​
createdAt
string
Timestamp de criacao (ISO 8601).
​
updatedAt
string
Timestamp da ultima atualizacao (ISO 8601).
{
  "roleId": "role_01HQZE7N9K4RW2X6MTJP8YCDF3",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "slug": "editor",
  "name": "Editor",
  "description": "Can edit and publish content",
  "type": "ORGANIZATION_ROLE",
  "permissions": [
    "content:read",
    "content:write",
    "content:publish"
  ],
  "inherited": false,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}