Définition de schémas de sécurité d'authentification de base

Modifier en ligne

Un schéma de sécurité d'authentification de base est utilisé lorsqu'une application qui appelle l'API est requise pour s'authentifier via un registre d'utilisateurs.

Avant de commencer

Pour authentifier l'accès aux opérations des API mises en œuvre sur la passerelle, les types de registre d'utilisateurs suivants sont pris en charge :
  • URL d'authentification
  • LDAP
Les types de registre d'utilisateurs suivants ne sont pas pris en charge:
  • OpenID Connect (OIDC)
  • Registre d'utilisateurs local (LUR)
  • Un registre d'utilisateurs personnalisé

Pour créer une définition de sécurité d'authentification de base dans une API, vous devez disposer au préalable d'un registre d'utilisateurs. Pour créer un registre d'utilisateurs, vous pouvez utiliser API Manager ou Cloud Manager. Lorsque vous créez un registre dans API Manager, il n'est visible que par votre organisation de type fournisseur. Lorsque vous créez un registre dans Cloud Manager, vous pouvez le rendre visible par plusieurs organisations de type fournisseur.

Pour créer un registre d'utilisateurs avec API Manager, voir Utilisation de registres d'utilisateurs.

A propos de cette tâche

Remarque: Cette tâche concerne la configuration d'une définition d'API OpenAPI 2.0 . Pour plus d'informations sur la configuration d'une définition d'API OpenAPI 3.0 , voir Edition d'une définition d'API OpenAPI 3.0.

Vous pouvez effectuer cette tâche soit à l'aide de l'application d'interface utilisateur API Designer , soit à l'aide de l'interface utilisateur API Manager basée sur un navigateur.

Lorsque vous utilisez l'authentification de base, vous demandez aux utilisateurs de l'API de fournir un nom d'utilisateur et un mot de passe valides pour accéder aux opérations sélectionnées. Le développeur d'applications doit également fournir un en-tête d'autorisation HTTP dans les requêtes envoyées aux opérations nécessitant une authentification de base.

Lorsque vous utilisez une URL d'authentification, les données d'identification de l'utilisateur fournies dans l'en-tête de l'autorisation sont validées par le noeud final spécifié dans l'URL. Si l'utilisateur est authentifié, la méthode ` IBM® API Connect ` attend qu'un objet de type `Authentication URL ` renvoie un objet de type ` HTTP `200 OKCode de statut de la réponse. Tous les autres codes de statut de réponse HTTP entraînent un échec de l'authentification et l'accès est refusé.

Pour plus d'informations sur l'utilisation d'un registre d'utilisateurs d' LDAP. pour l'authentification, consultez la page LDAP authentication.

Pour plus d'informations sur l'utilisation d'un registre d'utilisateurs de l' URL, consultez la section « Registre d'utilisateurs de l'Authentication URL ».

Pour utiliser un schéma de sécurité d'authentification de base, vous devez le référencer à partir d'un autre emplacement dans votre définition d'API. Pour plus d'informations, consultez les sections « Application des exigences de sécurité à une API » et « Application des exigences de sécurité à une opération ».

À tout moment, vous pouvez accéder directement au fichier YAML source d' OpenAPI en cliquant sur l'icône Source OpenAPI Icône Source. Pour revenir au formulaire de conception, cliquez sur l'icône Formulaire Icône de formulaire.

Procédure

  1. Ouvrez l'API pour édition, comme décrit dans Edition d'une définition d'API OpenAPI 2.0.
  2. Si un ou plusieurs schémas de sécurité sont déjà définis, développez Schémas de sécurité.
  3. Pour créer un schéma de sécurité à authentification de base, cliquez sur l'icône « Ajouter » située OpenAPI 2.0 Icône d'ajout d'API à côté de « Schémas de sécurité », puis sélectionnez « Basic » comme type de définition de sécurité. Pour éditer un schéma de sécurité d'authentification de base existant, cliquez sur le nom du schéma de sécurité dans le panneau de navigation.
  4. Entrez le nom d'identification de votre choix dans la zone Nom .
  5. Sélectionnez le registre d'utilisateurs dans la liste Authentifier à l'aide du registre d'utilisateurs .
    Les registres d'utilisateurs de la liste sont ceux qui ont été activés dans le catalogue pour bac à sable. Pour plus de détails, voir Création et configuration de catalogues.
  6. Si vous le souhaitez, indiquez une description pour le schéma de sécurité. Vous pouvez utiliser la syntaxe CommonMark pour afficher du texte formaté.
  7. Si vous créez un schéma de sécurité d'authentification de base, cliquez sur Créer.
    Les détails du schéma de sécurité s'affichent pour une édition ultérieure.
  8. Cliquez sur Sauvegarder lorsque vous avez terminé.

Etape suivante

Appliquez le schéma de sécurité à une API ou à une opération. Pour plus d'informations, consultez les sections « Application des exigences de sécurité à une API » et « Application des exigences de sécurité à une opération ».

Pour plus d'informations sur LDAP et l'authentification URL, consultez LDAP authentication et le registre des utilisateurs URL.