Pasar parámetros a proveedores de identidad

Describe cómo pasar parámetros a la API de un Proveedor de identidad.

Puede pasar parámetros específicos del proveedor a un Proveedor de identidad (IdP) durante la autenticación. Los valores pueden ser estáticos para cada conexión o dinámicos para cada usuario.

​

Limitaciones

Para esta configuración, tenga en cuenta las siguientes restricciones:

• Solo se aceptan parámetros válidos de OAuth 2.0/OIDC.
• No todos los IdP admiten parámetros upstream. Consulte con el IdP específico antes de continuar con la implementación.
• Los IdP de SAML no admiten parámetros upstream.

​

Parámetros estáticos

Utilice parámetros estáticos para configurar su conexión de modo que envíe un conjunto estándar de parámetros al IdP cuando un usuario inicie sesión.

Para configurar parámetros estáticos, llame a los endpoints de Auth0 Management API Crear una conexión o Actualizar una conexión, y pase el objeto upstream_params dentro del objeto options con los parámetros que desee enviar al IdP.

​

Ejemplo: WordPress

WordPress te permite pasar un parámetro blog opcional a su endpoint de autorización de OAuth 2.0 y solicitar automáticamente acceso al blog especificado cuando los usuarios inician sesión. Para obtener más información, consulta la documentación de OAuth 2.0 de WordPress.

Para seguir este ejemplo, necesitarás una conexión social de WordPress en funcionamiento.

​

Obtener la conexión

Llame al endpoint Get a connection de la Management API para obtener los valores actuales del objeto options:

El objeto options tendrá un aspecto similar al siguiente:

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"]
  }
}

​

Actualiza la conexión (estática)

Copia el objeto options existente y, a continuación, añade el objeto upstream_params con el campo blog como atributo:

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"],
    "upstream_params": {
      "blog": {"value":"myblog.wordpress.com"}
    }
  }
}

Llama al endpoint Actualizar una conexión de la Management API con el objeto options en el cuerpo:

Ahora, cada vez que un usuario se autentique con esta conexión, la solicitud al endpoint de autorización de WordPress incluirá el parámetro de consulta blog=myblog.wordpress.com.

​

Parámetros dinámicos

Use parámetros dinámicos para configurar su conexión de modo que envíe al IdP un conjunto de parámetros con valores específicos del usuario cuando inicie sesión.

Para configurar parámetros dinámicos, llame al endpoint Create a connection o Update a connection de la Management API de Auth0, pase el objeto upstream_params dentro del objeto options con los parámetros que desea enviar al IdP y especifique el campo con el que se asigna el parámetro mediante el atributo alias.

A continuación, se muestra un ejemplo del objeto options que retomaremos más adelante en el ejemplo X:

{
  "options": {
    "upstream_params": {
      "screen_name": {
        "alias": "login_hint"
      }
    }
  }
}

​

Campos disponibles

Estos son los campos disponibles del atributo alias:

• acr_values
• audience
• client_id
• display
• id_token_hint
• login_hint
• max_age
• prompt
• resource
• response_mode
• response_type
• ui_locales

​

Ejemplo: X

X le permite pasar un parámetro opcional screen_name a su endpoint de autorización OAuth. El parámetro screen_name rellena previamente el campo de username de la pantalla de inicio de sesión con el valor indicado. Para obtener más información, consulte la referencia de la API de X.

Para seguir este ejemplo, necesitará una conexión social de X en funcionamiento.

​

Obtener la Conexión

Llame al endpoint Get a connection de Management API para recuperar los valores actuales del objeto options:

El objeto options tendrá un aspecto similar al siguiente:

"options": {
  "client_id": "YOUR_CLIENT_ID",
  "client_secret": "YOUR_CLIENT_SECRET",
  "profile": true
}

​

Actualizar la conexión (dinámica)

Copie el objeto options existente, agregue el objeto upstream_params con el campo screen_name como atributo y, a continuación, configure el atributo alias como login_hint:

{
  "options": {
    "client_id": "", 
    "profile": true, 
    "scope": ["profile"],
    "upstream_params": {
      "screen_name": {
        "alias": "login_hint"
      }
    }
  }
}

Llame al endpoint Actualizar una conexión de Management API con el objeto options en el cuerpo:

​

Llama al endpoint de inicio de sesión

Cuando llames al endpoint de inicio de sesión de la API de autenticación para un usuario, puedes pasar su correo electrónico al parámetro login_hint:

A continuación, este valor se pasará al endpoint de autorización de X como parámetro screen_name:

https://api.x.com/oauth/authorize
  ?oauth_token={yourXAuthToken}
  &screen_name=[e-mail]