Skip to main content

GET Listar Roles da Conta

Lista as roles da clínica do token.

Autenticação necessária

Envie o header Authorization: Bearer {accessToken} (token de usuário) ou x-api-key: {apiKey} (integrações). Veja Autenticação.

Permissão necessária

Exige as permissões read_roles e give_roles. Tanto com token JWT quanto com API Key, todas são obrigatórias.

Roles no provedor de login

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.


Endpoint​

GET https://api-dev.imagemais.com.br/api/roles

Requisição​

curl -X 'GET' \n 'https://api-dev.imagemais.com.br/api/roles' \n -H 'accept: application/json' \n -H 'Authorization: Bearer {accessToken}'

Respostas​

200 Sucesso​

[
{
"slug": "org-recepcao",
"name": "Recepção",
"description": "Equipe da recepção",
"redirectRoute": "/agenda"
}
]

400 Clínica ainda não migrada​

{
"message": "A clínica ainda não foi migrada para o novo login. A gestão de roles fica disponível depois da migração.",
"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
}
CampoTipoDescrição
slugstringIdentificador da role (use nas demais rotas)
namestringNome
descriptionstring | nullDescrição
redirectRoutestring | nullTela inicial da role no front; null se não houver