POST Criar Role
Cria uma role na clínica, com as permissões escolhidas.
Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.
Exige a permissão create_roles.
As roles da clínica ficam no provedor de login (WorkOS), identificadas pelo slug. O banco do PEP guarda só a tela inicial de cada role. As permissões ficam em cache por até 5 minutos; alterações feitas por estas rotas limpam o cache na hora.
O slug sai do nome: org- + nome sem acento em minúsculas (org-recepcao). Se já existir na clínica, ganha -2, -3…
Endpoint
POST https://api-dev.imagemais.com.br/api/roles
Corpo da Requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
name | string | ✅ | Nome da role (não pode ficar vazio; espaços das pontas são removidos) |
description | string | ❌ | Descrição |
permissions | string[] | ✅ | Permissões da role, só as do catálogo (veja Catálogo de Permissões). Pode ser [] |
redirectRoute | string | ❌ | Tela inicial da role: caminho interno do sistema, começando com / (ex.: /agenda). Vazio ou endereço externo é recusado |
Requisição
curl -X 'POST' \n 'https://api-dev.imagemais.com.br/api/roles' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}' \n -H 'Content-Type: application/json' \n -d '{
"name": "Recepção",
"description": "Equipe da recepção",
"permissions": [
"read_patients"
],
"redirectRoute": "/agenda"
}'
Respostas
201 Sucesso
{
"slug": "org-recepcao",
"name": "Recepção",
"description": "Equipe da recepção",
"redirectRoute": "/agenda"
}
400 Requisição inválida
Mensagens possíveis: Informe o nome da role, Permissão desconhecida: {nome} (fora do catálogo), A tela inicial deve ser um caminho do sistema, começando com "/". e o aviso de clínica não migrada.
{
"message": "Permissão desconhecida: foo_bar",
"error": "Bad Request",
"statusCode": 400
}
403 Sem permissão
{
"message": "Permissões insuficientes",
"error": "Forbidden",
"statusCode": 403
}
503 Serviço de login indisponível
{
"message": "Não foi possível falar com o serviço de login. Tente novamente em instantes.",
"error": "Service Unavailable",
"statusCode": 503
}