Skip to main content
O objeto papel define um conjunto nomeado de permissoes que podem ser atribuidas a usuarios dentro de uma organizacao. Papeis suportam controle de acesso tanto a nivel de organizacao quanto a nivel de ambiente, e podem ser herdados de escopos superiores.
​
roleId
string
O identificador unico do papel.
​
organizationId
string
O ID da organizacao.
​
slug
string
O slug do papel.
​
name
string
O nome de exibicao do papel.
​
description
string|null
A descricao do papel. null se nao fornecida.
​
type
string
O tipo do papel. Um de: ENVIRONMENT_ROLE, ORGANIZATION_ROLE.
​
permissions
string[]
Array de slugs de permissoes atribuidas ao papel.
​
inherited
boolean
Se o papel e herdado de um escopo superior.
​
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": "admin",
  "name": "Admin",
  "description": "Full administrative access",
  "type": "ENVIRONMENT_ROLE",
  "permissions": [
    "users:read",
    "users:write",
    "organizations:read",
    "organizations:write",
    "billing:manage"
  ],
  "inherited": false,
  "createdAt": "2026-01-15T10:00:00.000Z",
  "updatedAt": "2026-01-15T10:00:00.000Z"
}