Vous consultez la documentation d'Apigee X.
Consultez la documentation d'Apigee Edge.
Les intégrations vous permettent d'enregistrer les profils d'authentification pour votre client. Ainsi, vous pouvez configurer l'authentification une seule fois, puis réutiliser la même configuration pour toutes les intégrations.
Pour créer un profil d'authentification, procédez comme suit :
- Sélectionnez Add new authentication profile (Ajouter un profil d'authentification) dans le champ Authentication profile to use (Profil d'authentification à utiliser).
- Dans la boîte de dialogue Authentication profile (Profil d'authentification), saisissez les informations suivantes :
- Profile name (Nom du profil) : saisissez un nom personnalisé pour la configuration.
- Profile description (Description du profil) : saisissez une description pour la configuration.
- Authentication type (Type d'authentification) : sélectionnez le type d'authentification et saisissez les informations requises pour l'authentification. Selon le type d'autorisation sélectionné, l'interface utilisateur affiche les champs requis pour l'authentification. Pour en savoir plus sur tous les types d'authentification compatibles, consultez la page [À déterminer : lien vers la page des types d'authentification].
- Cliquez sur Enregistrer.
Une fois le profil enregistré, il est visible dans la liste déroulante Profil d'autorisation à utiliser. Sélectionnez le profil dans la liste déroulante.
Types d'authentification
Le type d'authentification que vous souhaitez utiliser dépend de l'authentification configurée sur le serveur d'autorisation. Le serveur d'autorisation peut être un serveur autonome ou une API. Les intégrations sont compatibles avec les types d'authentification suivants pour la connexion au serveur d'autorisation :
- Jeton d'authentification
- Certificat client uniquement
- Jwt : jeton Web JSON
- Code d'autorisation OAuth2
- Identifiants clients OAuth2
- Identifiants de propriétaire de la ressource OAuth2
- Compte de service
- Nom d'utilisateur et mot de passe
Le tableau suivant décrit les différents types d'authentification et les paramètres de configuration correspondants.
Type d'authentification | Description | Paramètres de configuration |
Jeton d'authentification | Authentification simple par jeton | TYPE : type d'authentification [À déterminer : quels sont les types d'authentification acceptés ? Devons-nous les mentionner ?]
TOKEN : jeton d'authentification |
Certificat client uniquement | Authentification basée sur un certificat SSL/TLS | Certificat SSL/TLS
Importez le certificat SSL/TLS et la clé privée correspondante. |
Jwt | Authentification basée sur le jeton Web JSON (JWT). Pour en savoir plus sur JWT, consultez la page https://tools.ietf.org/html/rfc7519. | JWT HEADER (En-tête JWT) : algorithme pour générer la signature.
Remarque : Vous ne pouvez spécifier que l'algorithme HS256. JWT PAYLOAD : une revendication d'ensemble. Vous pouvez utiliser des revendications enregistrées, publiques ou personnalisées. SECRET : clé partagée entre le client et le serveur d'authentification. |
Code d'autorisation OAuth2 | Authentification basée sur OAuth 2.0
Dans ce mode d'authentification, vous êtes redirigé vers une page pour passer en revue les autorisations d'accès de l'application Integrations. Une fois l'application autorisée, vous êtes redirigé vers l'application et disposez d'un code temporaire. L'application utilise ce code temporaire pour obtenir un jeton d'accès permettant d'accéder aux ressources protégées. |
AUTHENTICATION URL : URL pour l'authentification.
TOKEN URL : URL de point de terminaison qui accorde ou actualise le jeton d'accès. CLIENT ID : ID client fourni par le serveur d'authentification. CLIENT SECRET : clé partagée entre le client et le serveur d'authentification. SCOPE : champ d'application du jeton d'accès. Les champs d'application vous permettent de spécifier des autorisations d'accès pour les utilisateurs. Vous pouvez spécifier plusieurs champs d'application (valeurs séparées par un espace). [À déterminer : lien vers un tutoriel montrant comment utiliser ce type d'authentification] |
Identifiants clients OAuth2 | Authentification basée sur OAuth 2.0
Dans ce mode d'authentification, vous devez d'abord demander un jeton d'accès à l'aide des identifiants client, puis utiliser le jeton d'accès pour accéder aux ressources protégées. |
CLIENT ID : ID CLIENT [À déterminer]
CLIENT SECRET : clé partagée entre le client et le serveur d'authentification. TOKEN ENDPOINT : URL du point de terminaison qui accorde ou actualise le jeton d'accès. SCOPE : champ d'application du jeton d'accès. Les champs d'application vous permettent de spécifier des autorisations d'accès pour les utilisateurs. Vous pouvez spécifier plusieurs champs d'application (valeurs séparées par un espace). REQUEST TYPES (Types de requêtes) : Mécanisme d'envoi des paramètres de requête vers le serveur d'authentification. Les types de requêtes suivants sont acceptés :
|
Identifiants de propriétaire de la ressource OAuth2 | Authentification basée sur OAuth 2.0
Dans ce mode d'authentification, vous devez d'abord demander un jeton d'accès à l'aide des identifiants du propriétaire des ressources, puis utiliser le jeton d'accès pour accéder aux ressources protégées. |
CLIENT ID : ID CLIENT [À déterminer]
CLIENT SECRET : clé partagée entre le client et le serveur d'authentification. USERNAME : nom d'utilisateur pour l'authentification. PASSWORD : mot de passe pour l'authentification. TOKEN ENDPOINT : URL du point de terminaison qui accorde ou actualise le jeton d'accès. SCOPE : champ d'application du jeton d'accès. Les champs d'application vous permettent de spécifier des autorisations d'accès pour les utilisateurs. Vous pouvez spécifier plusieurs champs d'application (valeurs séparées par un espace). REQUEST TYPES (Types de requêtes) : Mécanisme d'envoi des paramètres de requête vers le serveur d'authentification. Les types de requêtes suivants sont acceptés :
|
Compte de service | S'authentifier à l'aide de comptes de service dans votre projet GCP | SERVICE ACCOUNT : nom du compte de service dans votre projet GCP.
Remarque : Dans votre projet GCP, vérifiez que vous avez bien ajouté le compte principal cloud-crm-ip-api-caller@prod.google.com avec le rôle Service Account Token Creator (Créateur de jetons de compte de service). SCOPE : champ d'application des autorisations d'accès aux utilisateurs. Vous pouvez spécifier plusieurs champs d'application (valeurs séparées par un espace). |
Nom d'utilisateur et mot de passe | Authentification basée sur le nom d'utilisateur et le mot de passe.
Dans ce mode d'authentification, vous n'utilisez que le nom d'utilisateur et le mot de passe pour vous authentifier auprès du serveur d'authentification. |
USERNAME : nom d'utilisateur pour l'authentification.
PASSWORD : mot de passe pour l'authentification. |