Solicitud para crear una cuenta conectada

Inicia un flujo de autorización para vincular la cuenta del usuario autenticado con un proveedor de identidad externo.

POST https://{host}/me/v1/connected-accounts/connect

Crear una solicitud de cuenta conectada

cURL

curl --request POST \
  --url https://{host}/me/v1/connected-accounts/connect \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "connection": "<string>",
  "redirect_uri": "<string>",
  "authorization_params": {
    "acr_values": "<string>",
    "audience": "<string>",
    "id_token_hint": "<string>",
    "login_hint": "<string>",
    "max_age": 1073741823,
    "resource": "<string>",
    "ui_locales": "<string>"
  },
  "code_challenge": "<string>",
  "code_challenge_method": "<string>",
  "scopes": [
    "openid",
    "offline_access",
    "read:tasks",
    "write:tasks"
  ],
  "state": "<string>"
}
'

201

{
  "auth_session": "<string>",
  "connect_params": {
    "ticket": "<string>"
  },
  "connect_uri": "<string>",
  "expires_in": 2
}

Autorizaciones

Authorization · string · header · requerido

Los tokens Bearer y DPoP son compatibles según la configuración de la API

Cuerpo

application/json

Cuerpo de la solicitud para crear una solicitud de vinculación de cuentas.

connection · string · requerido

El nombre de la conexión con la que se vinculará la cuenta (por ejemplo, 'google-oauth2', 'facebook').

Required string length: 1 - 128

redirect_uri · string<uri> · requerido

El URI al que se redirigirá una vez completado el proceso de conexión.

Maximum string length: 2048

authorization_params · Authorization Parameters · object

Parámetros de autorización que se enviarán al Proveedor de identidad (IdP) subyacente durante la solicitud de autorización. Estos parámetros influyen en cómo el IdP procesa el flujo de autorización y qué permisos se solicitan.

Show child attributes

code_challenge · string

El desafío de código PKCE derivado del code verifier.

Required string length: 43 - 128

code_challenge_method · string

El método utilizado para derivar el desafío de código. Obligatorio cuando se proporciona code_challenge.

Allowed value: "S256"

scopes · string[]

Define los permisos que el cliente solicita al Proveedor de identidad. Debe incluir los alcances estándar usados para identificar al usuario (por ejemplo, 'openid', 'email', 'profile'), el scope necesario para obtener tokens de actualización si hace falta (por ejemplo, 'offline_access') y cualquier alcance personalizado que el cliente necesite para acceder a recursos protegidos.

Required array length: 1 - 100 elements

Required string length: 1 - 255

Ejemplo:

[
  "openid",
  "offline_access",
  "read:tasks",
  "write:tasks"
]

state · string

Un valor opaco que se usa para mantener el estado entre la solicitud y el callback.

Required string length: 1 - 4096

Respuesta

201

application/json

Solicitud de conexión de cuenta creada correctamente

auth_session · string · requerido

El identificador de la sesión de autenticación.

Maximum string length: 64

connect_params · object · requerido

Parámetros que se usarán con el URI de conexión.

Show child attributes

connect_uri · string<uri> · requerido

El URI base para iniciar el flujo de conexión de cuentas.

expires_in · integer · requerido

La cantidad de segundos hasta que expire el ticket.

Rango requerido: x >= 1