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:
    Die REST API Auth ScopePlugin wird als Teil von hinzugefügt TokyoRelease.

    Erforderliche Rolle: Administrator

    Prozedur

    1. Navigieren zu Alle > API-Authentifizierungsbereiche > REST-API-Authentifizierungsbereichan.
      Die Seite „REST API-Authentifizierungsbereiche“ wird angezeigt.
    2. Klicken Sie auf, um einen neuen REST API-Authentifizierungsbereich zu konfigurieren Neu .
    3. Füllen Sie im Formular die Felder 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. 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 deaktivieren Wenden Sie den Authentifizierungsbereich auf alle HTTP-Methoden in dieser API an Feld im Formular manuell, 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 deaktivieren Wenden Sie den Authentifizierungsbereich auf alle Versionen in dieser API an Feld im Formular manuell, 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 deaktivieren Wenden Sie den Authentifizierungsbereich auf alle Ressourcen in dieser API an Feld im Formular manuell, 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 aktiviert, 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 Authentifizierungsbereich ruft die APIs Informationen ab, die für den Bereich spezifisch sind.

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

    Der erste Authentifizierungsbereich wird zugeordnet Tabellen-API Mit aktivierten HTTP-Methoden, -Versionen und -Ressourcen.

    REST API-Authentifizierungsbereich3

    Der zweite Authentifizierungsbereich wird zugeordnet Tabellen-API Mit allen Versionen und Ressourcen aktiviert. Sie wählen jedoch die HTTP-Methode aus, in diesem Beispiel die ABRUFEN Methode.

    REST API-Authentifizierungsbereich2

    Der dritte Authentifizierungsbereich ist zugeordnet Tabellen-API Ohne aktivierte HTTP-Methoden, -Versionen und -Ressourcen. Sie wählen jedoch die HTTP-Methode, die Version und die Ressource manuell aus. In diesem Beispiel ist die HTTP-Methode ABRUFEN , REST-API-Version ist Aktuell , Und Ressource ist /Now/table/{tableName} .

    REST-API-Authentifizierungsbereich1

    Wenn alle diese Authentifizierungsbereiche erstellt wurden, können Sie verwenden ABRUFEN Methode mit allen drei Umfängen, aber für VERÖFFENTLICHEN , PLATZIEREN , LÖSCHEN , Oder PATCH Nur Methoden Umfangs3 Kann verwendet werden.