Escopos disponíveis

Esta é uma API que retorna os escopos disponíveis na aplicação. Com esta API é possível criar perfils de permissões para os usuários e para as chaves de integração que acessam o sistema.

Listar Escopos Disponíveis

API de listagem de escopos disponíveis na aplicação.

GET /api/scopes

Exemplo de requisição

GET /api/scopes HTTP/1.1
Host: api.exemplo.com
Accept: application/json
Authorization: Bearer <Access-Token>

response = sdk.auth.get_scopes()

const resp = await sdk.auth.getScopes();
console.log(resp.payload);

Exemplo de resposta

HTTP/1.1 200 OK
Content-Type: application/json

{
  "scopes": [
    "auth.users",
    "auth.roles",
    "auth.apikeys"
  ]
}

if response.success:
    return response.scopes

["auth.users", "auth.roles", "auth.apikeys"];

Formato dos dados

Resposta

Parâmetro Tipo Descrição
scopes array Lista de escopos disponíveis na aplicação