Transmettre des paramètres aux fournisseurs d’identité

Décrit comment transmettre des paramètres à l’API d’un fournisseur d’identité.

Vous pouvez transmettre à un fournisseur d’identité (IdP) des paramètres spécifiques au fournisseur pendant l’authentification. Les valeurs peuvent être statiques pour chaque connexion ou dynamiques pour chaque utilisateur.

​

Limitations

Pour cette configuration, gardez à l’esprit les restrictions suivantes :

• Seuls les paramètres OAuth 2.0/OIDC valides sont acceptés.
• Les IdP ne prennent pas tous en charge les paramètres upstream. Vérifiez auprès de l’IdP concerné avant de poursuivre l’implémentation.
• Les IdP SAML ne prennent pas en charge les paramètres upstream.

​

Paramètres statiques

Utilisez des paramètres statiques pour configurer votre connexion de façon à envoyer un ensemble standard de paramètres à l’IdP lorsqu’un utilisateur se connecte.

Pour configurer des paramètres statiques, appelez l’un des points de terminaison Auth0 Management API Créer une connexion ou Mettre à jour une connexion, puis transmettez l’objet upstream_params dans l’objet options, avec les paramètres que vous souhaitez envoyer à l’IdP.

​

Exemple : WordPress

WordPress vous permet de transmettre un paramètre facultatif blog à son point de terminaison d’autorisation OAuth 2.0, et de demander automatiquement l’accès à un blogue précis lorsqu’un utilisateur se connecte. Pour en savoir plus, consultez la documentation OAuth 2.0 de WordPress.

Pour suivre cet exemple, vous aurez besoin d’une connexion sociale WordPress opérationnelle.

​

Récupérer la connexion

Appelez le point de terminaison Get a connection de la Management API pour récupérer les valeurs actuelles de l’objet options :

L’objet options aura une apparence semblable à celle-ci :

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

​

Mettre à jour la connexion (statique)

Copiez l’objet options existant, puis ajoutez l’objet upstream_params avec le champ blog comme attribut :

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

Appelez le point de terminaison Mettre à jour une connexion du Management API avec l’objet options dans le corps de la requête :

Désormais, chaque fois qu’un utilisateur s’authentifie avec cette connexion, la requête envoyée au point de terminaison d’autorisation WordPress inclura le paramètre de requête blog=myblog.wordpress.com.

​

Paramètres dynamiques

Utilisez des paramètres dynamiques pour configurer votre connexion afin d’envoyer à l’IdP, au moment de la connexion de l’utilisateur, un ensemble de paramètres dont les valeurs sont propres à cet utilisateur.

Pour configurer des paramètres dynamiques, appelez le point de terminaison Créer une connexion ou Mettre à jour une connexion de l’Auth0 Management API, transmettez l’objet upstream_params dans l’objet options avec les paramètres que vous souhaitez envoyer à l’IdP, puis indiquez, à l’aide de l’attribut alias, le champ auquel chaque paramètre correspond.

Voici un exemple d’objet options que nous reprendrons plus loin dans l’exemple X :

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

​

Champs disponibles

Voici les champs disponibles pour l’attribut alias :

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

​

Exemple : X

X vous permet de passer un paramètre facultatif screen_name à son point de terminaison d’autorisation OAuth. Le paramètre screen_name préremplit le champ du nom d’utilisateur sur l’écran de connexion avec la valeur fournie. Pour en savoir plus, consultez la référence de l’API de X.

Pour reproduire cet exemple, vous aurez besoin d’une connexion sociale X fonctionnelle.

​

Récupérer la connexion

Appelez le point de terminaison Get a connection de Management API pour récupérer les valeurs actuelles de l’objet options :

L’objet options ressemblera à ce qui suit :

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

​

Mettre à jour la connexion (dynamique)

Copiez l’objet options existant, ajoutez l’objet upstream_params avec le champ screen_name en tant qu’attribut, puis définissez l’attribut alias à login_hint :

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

Appelez le point de terminaison Mettre à jour une connexion du Management API avec l’objet options dans le corps de la requête :

​

Appeler le point de terminaison de connexion

Lorsque vous appelez le point de terminaison de connexion de l’API d’authentification pour un utilisateur, vous pouvez fournir son adresse de courriel dans le paramètre login_hint :

Cette valeur sera ensuite transmise au point de terminaison d’autorisation X en tant que paramètre screen_name :

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