Konfigurieren Sie den REST-API-Authentifizierungsbereich

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer
  • Verknüpfen Sie die OAuth-Entität mit einem Authentifizierungsbereich, um das Token für den Zugriff auf die REST APIs zu verwalten, die mit dem Authentifizierungsbereich verknüpft sind.

    Vorbereitungen

    Installieren Sie die folgenden Plugins:

    • OAuth 2.0
    • REST API-Anbieter
    • Authentifizierungsbereich
    • REST-API-Authentifizierungsbereich
    Hinweis:
    Das Plugin REST API Auth Scope wird als Teil des Release Tokyo hinzugefügt.

    Erforderliche Rolle: Administrator

    Prozedur

    1. Navigieren zu Alle > API-Authentifizierungsbereiche > REST-API-Authentifizierungsbereich.
      Die Seite „REST-API-Authentifizierungsbereiche“ wird angezeigt.
    2. Klicken Sie auf Neu, um einen neuen REST-API-Authentifizierungsbereich zu konfigurieren.
    3. Füllen Sie die Felder des Formulars aus.
      Tabelle : 1. REST-API-Authentifizierungsbereich
      Name Ein eindeutiger Name, der den REST-API-Authentifizierungsbereich identifiziert
      Aktiv Aktivieren Sie das Kontrollkästchen, um die Konfiguration zu aktivieren.
      Anwendung Schreibgeschützter Anwendungsbereich.
      REST-API Die REST API, auf die der Authentifizierungsbereich angewendet wird. Zum Beispiel die Tabellen-API.
      Authentifizierungsbereich Wählen Sie den Authentifizierungsbereich über das Suchsymbol aus.
      REST-API-PFAD API-Pfad der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: now/table.
      HTTP-Methode Methode für die Interaktion mit der API. Wählen Sie die Methode aus der Dropdown-Liste aus.

      Sie können das Feld „Authentifizierungsbereich auf alle HTTP-Methoden in dieser API anwenden“ im Formular manuell deaktivieren, um die Methode auszuwählen.

      REST API-Version Version der API. Beispiel: v1. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.

      Sie können das Feld „Authentifizierungsbereich auf alle Versionen in dieser API anwenden“ im Formular manuell deaktivieren, um die Version auszuwählen.

      Ressource Untergeordnete Ressource der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: /now/table.

      Sie können das Feld „Authentifizierungsbereich auf alle Ressourcen in dieser API anwenden“ im Formular manuell deaktivieren, um die Ressourcen auszuwählen.

      Authentifizierungsbereich auf alle HTTP-Methoden in dieser API anwenden Wenn diese Option aktiviert ist, wird der Authentifizierungsbereich auf alle HTTP-Methoden in der API angewendet.
      Authentifizierungsbereich auf alle Versionen in dieser API anwenden Wenn diese Option aktiviert ist, wird der Authentifizierungsbereich auf alle Versionen in der API angewendet.
      Authentifizierungsbereich auf alle Ressourcen in dieser API anwenden Wenn diese Option aktiviert ist, wird der Authentifizierungsbereich auf alle Ressourcen in der API angewendet
    4. Klicken Sie auf Absenden.
      Basierend auf der ausgewählten REST API und dem ausgewählten Authentifizierungsbereich rufen die APIs Informationen ab, die für den Bereich spezifisch sind.

    Erwägen Sie die Erstellung von drei REST-API-Authentifizierungsbereichen für die Tabellen-API

    Der erste Authentifizierungsbereich wird der Tabellen-API zugeordnet, wobei alle HTTP-Methoden, -Versionen und -Ressourcen aktiviert sind.

    REST API-Authentifizierungsbereich3

    Der zweite Authentifizierungsbereich wird der Tabellen-API zugeordnet, wobei alle Versionen und Ressourcen aktiviert sind. Sie wählen jedoch die HTTP-Methode, in diesem Beispiel die GET -Methode.

    REST API-Authentifizierungsbereich2

    Der dritte Authentifizierungsbereich wird der Tabellen-API zugeordnet, ohne dass HTTP-Methoden, -Versionen und -Ressourcen aktiviert sind. Sie wählen die HTTP-Methode, Version und Ressource jedoch manuell aus. In diesem Beispiel ist die HTTP-Methode GET, die REST API-Version ist aktuellund die Ressource ist /now/table/{tableName}.

    REST API-Authentifizierungsbereich1

    Wenn alle diese Authentifizierungsbereiche erstellt wurden, können Sie die GET -Methode mit allen drei Bereichen verwenden. Für die Methoden POST, PUT, DELETEoder PATCH kann jedoch nur scope3 verwendet werden.