Entrar

Conceder scopes ao acesso

POST https://{organization}.myguper.com/api/connect/accessScope

Anexa um ou mais scopes a um apiKey existente. Um scope é o par service.scope declarado por cada serviço Guper na configuração da conta.

Hoje cada serviço expõe um único scope all — register.all, loyalty.all, order.all, sender.all, catalog.all, organization.all, journey.all, media-manager.all, auditObserver.all, pipeline.all, gapp-be.all — e o connect expõe seis mais finos: connect.user, connect.access, connect.scope, connect.session, connect.auth e connect.mcp. Scopes mais finos dos outros serviços vão sendo criados conforme a necessidade aparece.

Requisição cujo token pertence a uma chave sem o scope que a rota exige é recusada com 403, e a resposta nomeia o scope que falta em requiredScope. Chamadas assinadas entre serviços Guper não passam por essa verificação.

Scopes enviados que não casam com um service.scope conhecido voltam em invalidScopes; concessões duplicadas são ignoradas silenciosamente. A resposta sempre reflete o que de fato foi persistido.

Try-it values populated from environment ACME (Demo)


Autenticação

Token

Most Connect endpoints require a valid x-guper-authorization token. Token issuance itself (/api/connect/auth) is the exception — it uses the x-guper-apikey and x-guper-apisecret credentials.

Cabeçalhos

Name Type Description
x-guper-authorization * string User token issued by Guper.
Content-Type * string Always `application/json` for endpoints that accept a JSON body.

Corpo da requisição

Content-Type: application/json

{
    "apiKey": "acme",
    "scope": "[\"register.all\", \"loyalty.all\", \"connect.user\"]"
}

Respostas

{
    "organization": "acme",
    "access":       "acme",
    "scopes": [
        { "scope": 1, "access": 11 },
        { "scope": 2, "access": 11 }
    ],
    "dateTime":     "2026-05-04T13:38:53-03:00"
}

Relacionados

Copied to clipboard