Skip to main content
POST
/
organizations
/
{organizationId}
/
roles
Criar Role
curl --request POST \
  --url https://api.example.com/organizations/{organizationId}/roles \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "slug": "<string>",
  "name": "<string>",
  "description": "<string>",
  "permissions": [
    "<string>"
  ]
}
'
{
  "roleId": "role_org_custom_editor",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "slug": "custom-editor",
  "name": "Custom Editor",
  "description": "Optional description",
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "roles:read"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}
Cria um novo role. 
curl -X POST https://api.awsales.io/studio/organizations/ORG_ID/roles \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "slug": "custom-editor",
    "name": "Custom Editor",
    "description": "Can edit content but not manage users",
    "permissions": ["content:read", "content:write"]
  }'
Use o endpoint Listar Permissoes para descobrir os slugs de permissao disponiveis antes de criar um role.
Requer permissao roles:write.

​
Cabecalhos

​
Authorization
string
required
Token bearer.

​
Parametros de Rota

​
organizationId
string
required
O UUID da organizacao.

​
Corpo da Requisicao

​
slug
string
required
Identificador unico do role dentro da organizacao.
​
name
string
required
Nome de exibicao do role.
​
description
string
Descricao opcional.
​
permissions
string[]
required
Array de slugs de permissao (ex.: ["users:read", "roles:read"]).

​
Resposta

​
roleId
string
O ID do role.
​
organizationId
string
O UUID da organizacao. Present only for organization roles.
​
slug
string
Identificador unico do role.
​
name
string
Nome de exibicao.
​
description
string
Descricao do role.
​
type
string
Tipo do role (ENVIRONMENT_ROLE ou ORGANIZATION_ROLE).
​
permissions
string[]
Array de slugs de permissao.
​
inherited
boolean
Se o role e herdado do ambiente.
​
createdAt
string
Timestamp de criacao ISO 8601.
​
updatedAt
string
Timestamp da ultima atualizacao ISO 8601.
{
  "roleId": "role_org_custom_editor",
  "organizationId": "019525fd-4c38-7e30-a5c1-b6e3f4d8a9c2",
  "slug": "custom-editor",
  "name": "Custom Editor",
  "description": "Optional description",
  "type": "ORGANIZATION_ROLE",
  "permissions": ["users:read", "roles:read"],
  "inherited": false,
  "createdAt": "2026-03-25T14:00:00.000Z",
  "updatedAt": "2026-03-25T14:00:00.000Z"
}

​
Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
404organization.not_foundOrganizacao nao encontrada
409role.slug_already_existsO slug do role ja esta em uso
404permission.not_foundUma ou mais permissoes nao existem
500internal_server_errorOcorreu um erro inesperado