Axuz Developers

GET /oauth/consent

Pré-visualização do consentimento (JSON, para a tela do auth_client)

  • Acesso: Pública
  • Serviço: https://auth-api.axuz.net

Autenticação aceita

  • sessionCookie — Sessão plena Axuz (cookie de sessão da casa). Sessão restrita é 403 enrollment_required.

Mesma query do /oauth/authorize. Revalida tudo no servidor. A tela DEVE destacar client.verified=false (app de terceiro não verificado), mostrar client.redirect_host (para onde o usuário volta) e marcar os escopos com sensitive=true. É a API que a tela /oauth/consent do axuz_auth_client usa (substitui o OAuth antigo do axuz_api).

Parâmetros

NomeEmTipoObrigatórioDescrição
client_idquerystringsim
redirect_uriquerystringsim
scopequerystringsim
statequerystringsim
code_challengequerystringsim
code_challenge_methodquerystringsim
noncequerystringnão

Respostas

200

App e escopos pedidos.

NomeTipoObrigatórioDescrição
clientobjectsim
client.client_idstringsim
client.namestringsim
client.verifiedbooleansim

false = app não verificado pelo operador: destacar na tela.

client.redirect_hoststringsim

Host (com porta) da redirect_uri; esquema customizado para app nativo.

scopesarray<object>sim
scopes[].codestringsim
scopes[].descriptionstringsim
scopes[].sensitivebooleansim

Exige client verificado; destacar na tela.

already_grantedbooleansim

400

Erro do protocolo (RFC 6749 §5.2).

NomeTipoObrigatórioDescrição
errorstringsim

invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope, invalid_token, insufficient_scope, access_denied, login_required, consent_required, enrollment_required, rate_limited, not_found, server_error.

error_descriptionstringnão

401

Sem sessão válida.

NomeTipoObrigatórioDescrição
errorstringsim

invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope, invalid_token, insufficient_scope, access_denied, login_required, consent_required, enrollment_required, rate_limited, not_found, server_error.

error_descriptionstringnão

403

Sessão restrita (menos de 2 fatores fortes). Cadastre fatores primeiro.

NomeTipoObrigatórioDescrição
errorstringsim

invalid_request, invalid_client, invalid_grant, unauthorized_client, unsupported_grant_type, invalid_scope, invalid_token, insufficient_scope, access_denied, login_required, consent_required, enrollment_required, rate_limited, not_found, server_error.

error_descriptionstringnão

429

Limite de requisições excedido.

NomeTipoObrigatórioDescrição
errorstringsim

500

Erro interno. Tente de novo com backoff; reporte o X-Request-Id.

NomeTipoObrigatórioDescrição
errorstringsim

Exemplos

O "Try it" está desligado nesta referência. Use os exemplos com a sua credencial de teste.

curl

curl -sS -X GET 'https://auth-api.axuz.net/oauth/consent?client_id=VALUE&redirect_uri=VALUE&scope=VALUE&state=VALUE&code_challenge=VALUE&code_challenge_method=VALUE' \
  -H "Cookie: access_token=$AXUZ_SESSION_JWT"

Node.js

const res = await fetch("https://auth-api.axuz.net/oauth/consent?client_id=VALUE&redirect_uri=VALUE&scope=VALUE&state=VALUE&code_challenge=VALUE&code_challenge_method=VALUE", {
  method: 'GET',
  headers: {
    Cookie: `access_token=${process.env.AXUZ_SESSION_JWT}`,
  },
});
if (!res.ok) throw new Error(`HTTP ${res.status}: ${await res.text()}`);
console.log(await res.json());

Python

import os
import requests

res = requests.request(
    "GET",
    "https://auth-api.axuz.net/oauth/consent?client_id=VALUE&redirect_uri=VALUE&scope=VALUE&state=VALUE&code_challenge=VALUE&code_challenge_method=VALUE",
    headers={
        "Cookie": f"access_token={os.environ['AXUZ_SESSION_JWT']}",
    },
    timeout=30,
)
res.raise_for_status()
print(res.json())