Définition des schémas de sécurité OAuth2

Un schéma de sécurité OAuth2 définit les paramètres permettant de contrôler l'accès aux opérations d'API via la norme d'autorisation OAuth.

Avant de commencer

Avant de créer un schéma de sécurité OAuth2 , vous devez:
  1. Créer un fournisseur OAuth.
  2. Ajouter le fournisseur OAuth à un catalogue. Si vous n'avez pas créé de catalogue, utilisez le catalogue pour bac à sable. Voir l' étape d'instructions OAuth dans Création et configuration de catalogues.

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.

Pour utiliser un schéma de sécurité OAuth2 , vous devez le référencer ailleurs dans votre définition d'API. Pour plus d'informations, voir Application des exigences de sécurité sur une API et Application des exigences de sécurité sur une opération.

A tout moment, vous pouvez passer directement à la source YAML OpenAPI sous-jacente 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 à des fins d'édition, comme décrit dans Edition d'une définition d'API OpenAPI 3.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é OAuth2 , cliquez sur l'icône d'ajout OpenAPI 2.0 Icône d'ajout d'API en regard de Schémas de sécurité, puis sélectionnez oauth2. Pour éditer un schéma de sécurité OAuth2 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 du schéma de sécurité .
  5. Fournissez les informations suivantes :
    • Security Scheme Name: nom d'identification de votre choix.
    • Fournisseur OAuth: sélectionnez le fournisseur OAuth à utiliser.
    • Flux: Sélectionnez l'une des options suivantes:
      • implicit
      • Propriétaire de la ressource - Mot de passe
      • Application
      • Code d'accès
      Remarque: les options de flux disponibles pour la sélection dépendent des options prises en charge par le fournisseur OAuth sélectionné.

      Si vous avez sélectionné Propriétaire de la ressource-JWT comme type d'octroi pris en charge lors de la création du fournisseur OAuth, vous devez sélectionner Propriétaire de la ressource-Mot de passe comme Flux pour ce schéma de sécurité.

    • Description : Description facultative du schéma de sécurité OAuth2. Vous pouvez utiliser la syntaxeCommonMark pour la représentation de texte enrichi.
    • Les noeuds finaux d'URL (les noeuds finaux applicables dépendent du type de flux) :
      • URL d'autorisation
      • URL de jeton
      Note : Les valeurs des points de terminaison URL fournies ici ne sont conservées qu'à titre d'information ; aucune validation ou autre action ne leur est appliquée par API Connect. La sécurité OAuth appliquée dépend du fournisseur OAuth spécifié.
    • Portées (disponible si vous éditez un schéma de sécurité OAuth2 existant):
      • Pour ajouter une nouvelle portée, cliquez sur Ajouter. Pour éditer une portée existante, cliquez sur l'icône des options Icône d'options en regard de la portée requise, puis cliquez sur Editer.
      • Fournissez les informations suivantes :
        • Portée : Identificateur de la portée.
        • Description : Description facultative de la portée. Vous pouvez utiliser la syntaxeCommonMark pour la représentation de texte enrichi.
        • Si vous créez une nouvelle portée, cliquez sur Créer.
  6. Si vous créez un schéma de sécurité OAuth2 , cliquez sur Créer.
    Les détails du schéma de sécurité s'affichent pour une édition ultérieure.
  7. 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, voir Application des exigences de sécurité sur une API et Application des exigences de sécurité sur une opération.