Skip to main content
GET
/
roles
Listar Papeis
curl --request GET \
  --url https://api.example.com/roles \
  --header 'Authorization: <authorization>'
[
  {
    "roleId": "1",
    "organizationId": null,
    "slug": "admin",
    "name": "Admin",
    "description": null,
    "type": "ENVIRONMENT_ROLE",
    "permissions": ["users:read", "users:write", "roles:read", "roles:write"],
    "inherited": true,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z"
  }
]
Requer permissao roles:read.

Headers

Authorization
string
required
Bearer token.

Parametros de Query

organizationId
string
Filtrar por UUID da organizacao.
type
string
Filtrar por tipo de papel.

Resposta

[
  {
    "roleId": "1",
    "organizationId": null,
    "slug": "admin",
    "name": "Admin",
    "description": null,
    "type": "ENVIRONMENT_ROLE",
    "permissions": ["users:read", "users:write", "roles:read", "roles:write"],
    "inherited": true,
    "createdAt": "2026-01-15T10:00:00.000Z",
    "updatedAt": "2026-01-15T10:00:00.000Z"
  }
]

Exemplos de Codigo

curl https://api.awsales.io/admin/roles \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

Codigos de Erro

StatusCodigoDescricao
400validation_errorEntrada invalida ou campos obrigatorios ausentes
401unauthorizedAutenticacao ausente ou invalida
403forbiddenPermissoes insuficientes
500internal_server_errorOcorreu um erro inesperado