Autenticación del agente: request

Descripción general

Inicia el acceso del agente para que el usuario abra su navegador y elija qué autorizar. Este endpoint está fuera de la lista permitida de api post. Mantén privados los datos de la sesión de acceso.

Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.

Este endpoint pertenece al protocolo de acceso y no está disponible mediante api post. Usa el flujo admitido de inicio de sesión en navegador y mantén las credenciales de sesión fuera de la salida y los registros.

Autenticación y permisos

Clases de credenciales aceptadas

delegated_oauth

Capacidad delegada

oauth-bootstrap

Rol mínimo del espacio de trabajo

Este contrato no exige un rol mínimo de espacio de trabajo; siguen aplicándose las comprobaciones de propiedad y permisos.

Alcance del acceso

Recursos a los que este usuario está autorizado a acceder

Se requiere consentimiento para todos los espacios de trabajo

No

Cambia el estado

No

Cuando la operación se completa

not_agent_callable

Un token solo puede usar los derechos de su propietario. Cada solicitud comprueba pertenencia al espacio, propiedad del recurso, espacios elegidos y capacidades concedidas. Los perfiles core y full cambian qué herramientas se muestran; no conceden acceso.

Campos de solicitud

Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "client_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 80
    },
    "device_name": {
      "type": "string",
      "minLength": 1,
      "maxLength": 120
    },
    "callback_uri": {
      "anyOf": [
        {
          "type": "string",
          "const": "http://127.0.0.1:8789/grant/callback"
        },
        {
          "type": "string",
          "maxLength": 2048,
          "format": "uri",
          "pattern": "^https:\\/\\/.*"
        }
      ]
    },
    "callback_state": {
      "type": "string",
      "minLength": 32,
      "maxLength": 256
    }
  },
  "required": [
    "client_name",
    "device_name",
    "callback_uri",
    "callback_state"
  ],
  "additionalProperties": false
}

Respuesta y finalización

Estados HTTP de éxito: 200. Cuando la operación se completa: not_agent_callable.

Una respuesta HTTP exitosa puede indicar aceptación, no finalización. Para trabajo en segundo plano, guarda el ID devuelto y consulta la misma operación hasta que termine. Una publicación programada o aceptada solo está publicada cuando la plataforma lo confirma; un tiempo de espera agotado en el cliente no determina el resultado.

Obligatorio significa obligatorio dentro del objeto principal y la rama elegida. Un campo secundario obligatorio no convierte en obligatorio un objeto principal opcional. Las reglas y nombres de campos siguientes se copian del contrato.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "request_id": {
      "type": "string",
      "format": "uuid",
      "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"
    },
    "approval_url": {
      "type": "string",
      "format": "uri"
    },
    "expires_in": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "request_id",
    "approval_url",
    "expires_in"
  ]
}

Errores y reintentos seguros

Comprueba el estado HTTP y el cuerpo de respuesta. Un error de validación 400 puede contener un ZodError; los errores del controlador usan los campos error, message y code. Conserva request_id o x-request-id para el diagnóstico, sin credenciales. Corrige los errores de acceso 401/403 antes de reintentar y respeta Retry-After para 429. Si una escritura es incierta o devuelve 5xx, consulta primero el resultado existente. Reutiliza una clave de idempotencia solo donde se admita; el comportamiento de reintento varía por operación y no garantiza una entrega exactamente una vez.

Ejemplos

Estos ejemplos usan valores ficticios comprobados con los esquemas. Sustituye los IDs por otros autorizados, los archivos multimedia por recursos listos y las fechas por tu hora de publicación confirmada. Comprueba la elegibilidad de la cuenta antes de enviar una escritura. Esta página no envía solicitudes API.

Establece SOSOAPI_ACCESS_TOKEN en tu servidor con una credencial aceptada por esta operación y mantenla fuera del código del navegador. Para un agente, usa sosoapi auth login para iniciar sesión en el navegador y deja a la CLI renovar sus credenciales.

request.json

{
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
}

cURL

curl --request POST \
  "https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request" \
  -H "Authorization: Bearer $SOSOAPI_ACCESS_TOKEN" \
  -H "Content-Type: application/json" \
  --data-binary @request.json

JavaScript

// Server-side JavaScript. Do not print tokens or credential-bearing responses.
const token = process.env.SOSOAPI_ACCESS_TOKEN;
if (!token) throw new Error("Set an accepted credential for this operation");
const response = await fetch("https://gqeshlawtcexsapabaui.supabase.co/functions/v1/identity-api/agent-auth/request", {
  method: "POST",
  headers: { "Content-Type": "application/json", Authorization: "Bearer " + token },
  body: JSON.stringify({
  "client_name": "example",
  "device_name": "example",
  "callback_uri": "http://127.0.0.1:8789/grant/callback",
  "callback_state": "exampleaaaaaaaaaaaaaaaaaaaaaaaaa"
})
});
const result = await response.json();
// Check response.ok, the operation-specific body and completion state before continuing.

Ejemplo de respuesta sintética

{
  "request_id": "11111111-1111-4111-8111-111111111111",
  "approval_url": "https://example.com/media.png",
  "expires_in": 1
}

Herramientas y guías relacionadas