Sign in

Grant Access Scope

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

Attaches one or more scopes to an existing apiKey. A scope is the service.scope pair declared by each Guper service in its account configuration.

Today every service exposes a single all scope — register.all, loyalty.all, order.all, sender.all, catalog.all, organization.all, journey.all, media-manager.all, auditObserver.all, pipeline.all, gapp-be.all — and connect exposes six finer ones: connect.user, connect.access, connect.scope, connect.session, connect.auth and connect.mcp. Finer scopes for the other services are added as the need appears.

A request whose token belongs to a key without the scope the route requires is refused with 403 and the response names the missing scope in requiredScope. Calls signed between Guper services do not go through this check.

Sent scopes that don't match a known service.scope come back in invalidScopes; duplicate grants are silently ignored. The response always reflects what was actually persisted.

Try-it values populated from environment ACME (Demo)


Authentication

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.

Headers

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.

Request body

Content-Type: application/json

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

Responses

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

Related

Copied to clipboard