Erstellen Sie eine REST-API-Zugriffsrichtlinie

  • Freigeben Version: Xanadu
  • Aktualisiert 1. August 2024
  • 1 Minute Lesedauer
  • Erstellen Sie eine API-Zugriffsrichtlinie, und ordnen Sie ein Authentifizierungsprofil zu, um den Authentifizierungstyp für eine REST API einzuschränken. Sie können beispielsweise eine API-Zugriffsrichtlinie erstellen, die nur die ID-Token-Authentifizierung für eine REST API zulässt.

    Vorbereitungen

    Prozedur

    1. Navigieren zu Alle > System-Webservices > REST API-Zugriffsrichtlinienan.
    2. Klicken Sie auf Neu.
    3. Füllen Sie die Felder des Formulars aus.
      API-Zugriffsrichtlinienfelder
      Tabelle : 1. API-Zugriffsrichtlinien
      Feld Beschreibung
      Name Eindeutiger Name der API-Zugriffsrichtlinie.
      Aktiv Option zum Aktivieren der API-Zugriffsrichtlinie.
      REST-API Die REST API, auf die die Zugriffsrichtlinie angewendet wird. Beispiel: Anhang-API.
      REST-API-PFAD API-Pfad der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: now/attachment.
      HTTP-Methode Methode für die Interaktion mit der API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.
      Version Version der API. Beispiel: v1. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt.
      Hinweis:
      Wenn Sie eine Authentifizierungsrichtlinie für alle Versionen einer REST API erstellen möchten, müssen Sie für jede Version eine eigene Richtlinie erstellen.
      Ressource Untergeordnete Ressource der REST API. Dieses Feld wird basierend auf der ausgewählten REST API automatisch ausgefüllt. Beispiel: /now/attachment
      Anwendung Umfang der Anwendung.
      Global Aktivieren Sie diese Option, um die Authentifizierungsrichtlinie auf alle Methoden, Versionen und Ressourcen der API anzuwenden.
      Auf alle Methoden anwenden Aktivieren Sie diese Option, um die Authentifizierungsrichtlinie für die API auf alle Methoden, Versionen und Ressourcen für die API anzuwenden.
      Auf alle Ressourcen anwenden Aktivieren Sie diese Option, um die Authentifizierungsrichtlinie für die API auf alle Versionen anzuwenden.
      Auf alle Versionen anwenden Aktivieren Sie diese Option, um die Authentifizierungsrichtlinie für die API auf alle Ressourcen anzuwenden.
      Hinweis:
      Weitere Informationen zur Priorisierung von API-Zugriffsrichtlinien finden Sie unter Priorisierung von API-Zugriffsrichtlinien.
    4. Doppelklicken Sie auf Neue Zeile einfügen.
    5. Wählen Sie ein eingehendes Authentifizierungsprofil aus der Liste aus, und klicken Sie auf das Speichern-Symbol Speichern-Symbol.
      Sie können beispielsweise Basisauthentifizierung, ID-Token, zertifikatsbasierteAuthentifizierung, OAuthoder WSSE-Authentifizierung hinzufügen.
      1. Klicken Sie zum Hinzufügen eines oder mehrerer eingehender Authentifizierungsprofile auf Neu, um ein neues Profil zu erstellen.
      2. Welche Art von Authentifizierungsprofilen auswählen?.
        • Standardmäßiges http-Authentifizierungsprofil erstellen
        • WSSE-Authentifizierungsprofile erstellen
        Authentifizierungsprofil
      3. Speichern Sie den Datensatz, nachdem Sie das Authentifizierungsprofil erstellt haben.
    6. Klicken Sie auf Absenden, um die REST-API-Zugriffsrichtlinie zu übermitteln.