Configurer le périmètre d’authentification de l’API REST

  • Rversion finale: Zurich
  • Mis à jour 31 juil. 2025
  • 2 minutes de lecture

    • Liez l’entité OAuth à un périmètre d’authentification pour gérer le jeton afin d’accéder aux API REST qui sont liées au périmètre d’authentification.

    Avant de commencer

    Installez les modules d'extension suivants :

    • OAuth 2.0
    • Fournisseur d’API REST
    • Périmètre d’authentification
    • Périmètre d'authentification REST API
    Remarque :
    Le REST API Auth Scope module d’extension est ajouté dans le cadre de la Tokyo version.

    Rôle requis : admin

    Procédure

    1. Accédez à la Tous > Périmètres d'authentification API > Périmètre d'authentification REST API.
      La page Périmètres d’authentification de l’API REST s’affiche.
    2. Pour configurer un nouveau périmètre d’authentification de l’API REST, cliquez sur Nouveau.
    3. Remplissez les champs du formulaire.
      Tableau 1. Périmètre d'authentification REST API
      Nom Nom unique qui identifie le périmètre d’authentification de l’API REST.
      Actif Cochez cette case pour activer la configuration.
      Application Champ d'application de l'application en lecture seule.
      API REST API REST à laquelle le périmètre d’authentification est appliqué. Par exemple, l’API Table.
      Périmètre d'authentification Sélectionnez le périmètre d’authentification à partir de l’icône de recherche.
      CHEMIN REST API Chemin d’API de l’API REST. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée. Par exemple, now/table.
      Méthode HTTP Méthode utilisée pour interagir avec l’API. Sélectionnez la méthode dans la liste déroulante.

      Vous pouvez désactiver manuellement l’option Appliquer le périmètre d’authentification à toutes les méthodes HTTP dans le champ de cette API du formulaire pour sélectionner la méthode.
      Version de REST API Version de l'API. Par exemple, v1. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée.

      Vous pouvez désactiver manuellement l’option Appliquer le périmètre d’authentification à toutes les versions dans ce champ d’API du formulaire pour sélectionner la version.
      Ressource Ressource enfant de l’API REST. Ce champ est renseigné automatiquement en fonction de l’API REST sélectionnée. Par exemple, /now/table.

      Vous pouvez désactiver manuellement l’option Appliquer le périmètre d’authentification à toutes les ressources dans ce champ API du formulaire pour sélectionner les ressources.
      Appliquer le périmètre d'authentification à toutes les méthodes HTTP dans cette API. Lorsqu’elle est activée, elle applique le périmètre d’authentification à toutes les méthodes HTTP dans l’API.
      Appliquer le périmètre d'authentification à toutes les versions dans cette API. Lorsque cette option est activée, elle applique le périmètre d’authentification à toutes les versions de l’API.
      Appliquer le périmètre d'authentification à toutes les ressources dans cette API. Lorsque cette option est activée, elle applique le périmètre d’authentification à toutes les ressources de l’API
    4. Cliquez sur Envoyer.
      En fonction de l’API REST et du périmètre d’authentification sélectionnés, les API récupèrent les informations spécifiques au périmètre.

    Envisagez de créer trois périmètres d’authentification de l’API REST pour l’API de table

    Le périmètre de la première authentification est mappé à l’API de table avec toutes les méthodes, versions et ressources HTTP activées.

    Périmètre d’authentification REST API 3

    Le deuxième périmètre d’authentification est mappé à l’API de table avec toutes les versions et ressources activées. Mais, vous choisissez la méthode HTTP, dans cet exemple, la méthode GET .

    Périmètre d’authentification de l’API REST 2

    Le troisième périmètre d’authentification est mappé à l’API de table sans les méthodes, versions et ressources HTTP activées. Cependant, vous choisissez manuellement la méthode, la version et la ressource HTTP. Dans cet exemple, la méthode HTTP est GET, la version de l’API REST est la dernière et la ressource est /now/table/{tableName}.

    Périmètre d’authentification REST API 1

    Si tous ces champs d’application d’authentification sont créés, vous pouvez utiliser la méthode GET avec les trois champs d’application, mais pour les méthodes POST,PUT, DELETE ou PATCH , seul le champ d’application 3 peut être utilisé.