Pedido de conexão de um aplicativo

GET

/oauth/authorizations/{requestId}

curl --request GET \
  --url https://api-connect.zoppy.com.br/oauth/authorizations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \
  --header 'Authorization: Bearer <token>'

• Produção
• Staging

O que a tela de consentimento mostra: o aplicativo, a loja, para onde a pessoa volta e as permissões pedidas.

Authorizations

• bearer

Parameters

Path Parameters

requestId

required

Id do pedido de conexão

string format: uuid

Id do pedido de conexão

Responses

200

O pedido

Media typeapplication/json

object

id

required

Id do pedido de conexão

string format: uuid

client

required

O aplicativo que pede acesso

object

name

required

Nome com que o aplicativo se registrou (ex.: “Claude”)

string

redirectHost

required

Para onde a pessoa volta depois de decidir

string

company

required

A loja que o aplicativo vai acessar

object

id

required

string format: uuid

name

required

string

audience

required

Mcp (agentes de IA) ou api (CLI do Connect)

string

Allowed values: mcp api

scopes

required

As permissões pedidas, todas marcadas por padrão

Array<object>

object

scope

required

A permissão

string

Allowed values: connect:read connect:operate connect:build

label

required

O que ela deixa o aplicativo fazer, em português

string

expiresAt

required

Até quando o pedido vale

string format: date-time

Example

{
  "audience": "mcp",
  "scopes": [
    {
      "scope": "connect:read"
    }
  ]
}

401

Token ausente, inválido ou expirado (connect.unauthorized)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

403

Papel sem acesso ou Connect não liberado (connect.forbidden_role, connect.feature_disabled)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}

404

Pedido inexistente, vencido ou já decidido (connect.oauth_request_not_found)

Media typeapplication/json

object

type

required

Código estável do erro, para máquinas (ex.: connect.connector_not_found)

string

title

required

Nome da classe do erro

string

status

required

Status HTTP

integer

detail

required

Mensagem em pt-BR, segura para mostrar a quem usa a tela

string

requestId

required

Id de correlação: passe ao suporte para achar o rastro completo

string

nullable

meta

Detalhes estruturados seguros para a tela (erros de campo, ids)

object

key

additional properties

Example ^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "requestId": "example",
  "meta": {
    "additionalProperty": "example"
  }
}