Configuration de portées pour un fournisseur OAuth natif

Les jetons d'accès contiennent une autorisation pour des portées spécifiques.

A propos de cette tâche

Les applications client peuvent demander uniquement les portées ou un sous-ensemble des portées que vous définissez ici. Les portées sont incluses dans les jetons d'accès générés par le fournisseur. Lorsqu'une API protégée par OAuth est appelée, la passerelle vérifie les portées transportées dans les jetons d'accès en fonction de la liste des portées autorisées dans la définition de sécurité pour l'API, afin de déterminer si l'accès doit être accordé.

Vous pouvez en outre appliquer des vérifications de portée avancée. Les URL de vérification de portée avancée sont appelées après l'authentification de l'application ou après l'authentification d'utilisateur en fonction des URL configurées. Les droits d'accès finaux à la portée qui sont octroyés par le jeton d'accès sont le résultat de toutes les vérifications de portée.

Conformément à la RFC 6749 d'IETF, la valeur du paramètre de portée est une liste de chaînes sensibles à la casse, délimitées par des espaces. Pour plus d'informations, consultez le cadre d'autorisation de l' OAuth 2.0.

L'un des rôles suivants est requis pour configurer des portées pour un fournisseur OAuth natif :

  • Administrateur d'organisation
  • Propriétaire
  • Rôle personnalisé avec les autorisations Paramètres > Gérer

Vous pouvez accéder à la page des paramètres de portée d'un fournisseur natif OAuth dès la fin de l'opération de création décrite dans la section « Configuration d'un fournisseur natif OAuth », ou vous pouvez mettre à jour les paramètres de portée d'un fournisseur natif OAuth existant. Si vous souhaitez mettre à jour les paramètres de portée pour un fournisseur OAuth natif existant, procédez comme suit avant de suivre la procédure décrite dans cette rubrique :

  1. Cliquez Icône Ressources Ressources > Fournisseurs OAuth.
  2. Sélectionnez le fournisseur OAuth natif requis.

Procédure

  1. Cliquez sur Portées dans le menu de la barre latérale. Les portées actuellement configurées sont répertoriées. Passez-les en revue et mettez-les à jour si nécessaire.
    Zone Descriptif
    sample_scope_1 Portée de jeton
    Portées supplémentaires Portée de jeton
    Dans la section Portées par défaut, sélectionnez les portées par défaut à utiliser si la demande d'API n'en contient pas. Si aucune portée par défaut n'est définie et que la demande ne contient pas de portée, une erreur de portée non valide est renvoyée pour la demande.

    Si la méthode d'autorisation utilisateur est définie sur Formulaire HTML par défaut dans les paramètres Sécurité utilisateur, toutes les portées spécifiées ici sont ajoutées automatiquement au formulaire de consentement d'autorisation.

  2. Vérification de la portée avancée avant la génération de jeton. Ce paramètre indique le noeud final de vérification de la portée où une vérification de la portée supplémentaire est effectuée en plus des portées de base. Les URL de vérification avancée sont lancées après l'authentification de l'application ou après l'authentification du propriétaire, selon la configuration des URL. Les portées sont incluses dans le jeton et remplacent toutes les portées précédentes.
    Zone Descriptif
    Vérification de portée d'application Autoriser une vérification supplémentaire en exécutant une vérification de la portée à partir d'un noeud final. Entrez le noeud final et un profil TLS facultatif à utiliser pour une vérification de la portée d'application.
    Vérification de portée de propriétaire Affiner la portée avec une vérification supplémentaire. Entrez le noeud final et un profil TLS facultatif à utiliser pour une vérification de la portée de propriétaire.
    Pour plus d'informations sur la portée, voir Portée
  3. Vérification de la portée avancée après la génération de jeton. Ce paramètre spécifie une vérification de portée supplémentaire au niveau du consommateur d'API pour vérifier la conformité avec les exigences de portée de l'API.
    Zone Descriptif
    Activée Cochez cette case pour activer la vérification de portée avancée après la validation de jeton. Entrez un noeud final de valideur par défaut facultatif.
    Utiliser le noeud final de l'API Cochez la case pour utiliser le point de terminaison fourni par l'API, ou décochez-la pour remplacer le point de terminaison fourni par l'API.
    Pour plus d'informations sur la portée, voir Portée
  4. Cliquez sur Sauvegarder lorsque vous avez terminé.

Résultats

Vous pouvez utiliser le fournisseur OAuth avec ces portées pour sécuriser les API dans un catalogue.