Utilisez identifiants client OAuth 2.0

OAuth 2.0 est un protocole d'autorisation qui donne accès à un ensemble de ressources telles que des API distantes ou des données utilisateur.

Pour plus de détails sur OAuth 2.0, consultez Qu'est-ce OAuth 2.0 ?

Commencer cette tâche

Pour ajouter une authentification OAuth 2.0 à l'aide du type d'autorisation Identifiants de client :

  1. Cliquez sur l'onglet Vue d'ensemble.

  2. Cliquez sur Configurer l'authentification si aucune méthode authentification n'existe. Sinon, cliquez sur Ajouter une authentification.

  3. Dans la boîte de dialogue Authentification, saisissez un nom d'affichage et sélectionnez OAuth 2.0 dans la liste déroulante Type d'authentification.

  4. Pour le menu déroulant Type d'autorisation, sélectionnez Client Credentials.

  5. Pour la liste déroulante Type d'authentification du client, sélectionnez l'une des options suivantes :

    • Send as basic auth header (client_secret_basic) : l'authentification envoie les identifiants du client dans l'en-tête d'authentification HTTP. Cette option est celle recommandée.

    • Send as basic auth body (client_secret_post) : l'authentification envoie les identifiants du client dans le corps de la requête.

  6. Ajoutez des valeurs aux champs suivants :

Champ Définition

Chemins

URL du jeton

L'emplacement où le flux envoie les identifiants du client.

Ce champ doit être une URL complète. Par exemple, https://api.box.com/oauth2/token.

Identifiants

ID du client

Une chaîne exposée publiquement fournie par le service. Elle est utilisée pour identifier l'application OAuth et générer les URL d'autorisation.

L'utilisateur final remplit ce champ lorsqu'il crée la connexion.

Secret client

Une chaîne de valeur privée fournie par le service. Cette valeur est utilisée pour authentifier l'identité de l'application auprès du service.

L'utilisateur final remplit ce champ lorsqu'il crée la connexion.

Permissions (facultatif)

Nom

Chaque permission définit un niveau d'accès précis que la connexion demande au service. Pour ajouter des permissions OAuth à votre connexion :

  1. Cliquez sur Ajouter une permission pour ajouter les permissions uniques que vous souhaitez demander pour cette connexion au service.

  2. Saisissez le nom de la permission. Par exemple, openid ou offline_access.

    Utilisez le bouton à bascule pour indiquer si la permission est Obligatoire. Pour marquer les permissions comme Obligatoires, vous devez d'abord activer l'option Autoriser les utilisateurs à personnaliser les permissions.

    Lorsque vous marquez une permission comme obligatoire, elle est toujours demandée. En général, il s'agira de toutes les permissions nécessaires au bon fonctionnement du connecteur. En outre, pour qu'une carte CAPIA puisse appeler tous les points de terminaison d'un API, il faut généralement que la connexion ait activé toutes les permissions.

    Chaque permission que vous ajoutez s'affiche dans l'onglet Autorisations de l'aperçu Nouvelle connexion.

  3. Sélectionnez l'option Autoriser les utilisateurs à personnaliser les permissions si vous souhaitez autoriser les utilisateurs à modifier votre liste de permissions.

    Cette option ajoute un sélecteur à votre onglet Autorisations, qui donne à vos utilisateurs deux choix pour définir les permissions demandées par votre service.

    • Utiliser les permissions par défaut : demande toutes les permissions que vous avez définies.

    • Personnaliser les permissions : les utilisateurs peuvent supprimer toutes les permissions non requises de votre liste d'origine. Les permissions requises ne peuvent pas être effacées.

  4. Sélectionnez l'option Autoriser les utilisateurs à demander des permissions supplémentaires pour permettre aux utilisateurs d'ajouter des demandes de permission supplémentaire directement par le biais de votre connecteur.

    Ils peuvent saisir des permissions dans le champ Ajouter manuellement des permissions. Ce champ de saisie est limité à 500 caractères. Ils peuvent être ajoutés individuellement ou sous forme de liste de permissions séparées par une espace ou une virgule. Le délimiteur correspond à votre sélection pour le champ Délimiteur de permission.

    Si vous ne sélectionnez pas cette option, les utilisateurs peuvent demander que de nouvelles permissions soient ajoutées au connecteur via le site Okta Ideas. Ce lien est inclus en bas de l'onglet Autorisations.

    Cette option est disponible uniquement si vous activez l'option Autoriser les utilisateurs à personnaliser les permissions.

Délimiteur de permission

Spécifiez un délimiteur pour définir la façon dont les permissions individuelles sont séparées lorsqu'elles sont saisies par l'utilisateur.

Les options sont Space et Comma.

Paramètres (facultatif)

Les paramètres vous permettent de recueillir auprès de l'utilisateur du connecteur des informations supplémentaires qui peuvent s'avérer nécessaires à l'authentification, comme leur instance ou leur sous-domaine. Ces champs sont présentés à l'utilisateur lorsqu'il crée une connexion pour la première fois. Ils sont obligatoires.

Étiquette : le nom du paramètre qui s'affiche dans la boîte de dialogue Nouvelle connexion lors de la configuration du connecteur.

Clé : valeur textuelle dans la paire clé-valeur qui est utilisée par le service. Par exemple, api_key, application_keyou authentication.

Type : vous pouvez sélectionner trois types de champ différents :

  • Text : affichez un champ en texte brut à l'utilisateur. Il s'agit d'un champ de texte ouvert, sans édition.

  • Password : affichez un champ de texte expurgé. L'utilisateur ne peut pas voir le texte qui a été saisi dans ce champ.

  • Dropdown List : affichez une liste déroulante de valeurs créée manuellement que l'utilisateur peut sélectionner.

Pour une type d'autorisation Identifiants de client, les paramètres ID client et Clé secrète client apparaissent par défaut. Vous pouvez ajouter du texte pour créer un nom unique pour ces étiquettes, mais ces paramètres ne peuvent pas être supprimés.

Valeurs de configuration (facultatif)

D'autres valeurs de configuration peuvent être nécessaires pour définir la manière dont un utilisateur s'authentifie auprès de votre connecteur. Cliquez sur Ajouter une valeur de configuration.

Étiquette : le nom affiché pour la valeur de configuration dans la boîte de dialogue Nouvelle connexion lors de la configuration du connecteur.

Définition : indiquez si ce champ sera rempli avec une valeur statique ou une valeur provenant d'un flux d'aide.

  • Pour Static Value, saisissez la valeur dans le champ Valeur.

  • Pour Value from Helper Flow, sélectionnez un flux dans la boîte de dialogue Choisir le flux.

Type : vous pouvez sélectionner deux types de champ différents :

  • Text : affichez un champ en texte brut à l'utilisateur. Il s'agit d'un champ de texte ouvert, sans édition.

  • Password : affichez un champ de texte expurgé. L'utilisateur ne peut pas voir le texte qui a été saisi dans ce champ.

Le bouton à bascule Visible détermine si la valeur de configuration apparaîtra dans la boîte de dialogue d'authentification du connecteur.

Étapes suivantes

Après avoir créé cette méthode d'authentification, vous devez créer un flux httpHelper pour gérer les appels via cette méthode d'authentification. Consultez Générer un flux httpHelper.