Erstellen Sie EINE REST-API-Zugriffsrichtlinie

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

Stellen Sie sicher, dass ein Authentifizierungsprofil erstellt wird. Weitere Informationen finden Sie unter Erstellen Sie ein Authentifizierungsprofil .

Erforderliche Rolle: Administrator

Prozedur

1. Navigieren zu Alle > System-Webservices > REST API-Zugriffsrichtlinienan.
2. Wählen Sie Neu.
3. Füllen Sie im Formular die Pflichtfelder aus, und übermitteln Sie sie.
   

   Hinweis:

   Sie müssen das übermittelte Formular erneut öffnen, um zusätzliche Felder auszufüllen.

   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/Anhang .
   HTTP-Methode	Für die Interaktion mit der API verwendete Methode. 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 einzelne Richtlinien erstellen.
   Ressource	Untergeordnete Ressource der REST-API. Dieses Feld wird basierend auf der ausgewählten REST-API automatisch ausgefüllt. Beispiel: /Now/attachment
   Tabelle	Die Tabellen, für die die API-Zugriffsrichtlinie gilt. Diese Option gilt nur für Richtlinien für Tabelle API.
   Anwendung	Umfang der Anwendung.
   Global	Option zum Anwenden der Richtlinie auf alle Methoden, Versionen und Ressourcen für die API.
   Auf alle Methoden anwenden	Option zum Anwenden der Richtlinie auf alle Methoden, Versionen und Ressourcen für die API.
   Auf alle Ressourcen anwenden	Option zum Anwenden der Richtlinie auf alle oder die API-Ressourcen.
   Auf alle Versionen anwenden	Option zum Anwenden der Richtlinie auf alle oder die API-Versionen.
   Auf alle Tabellen anwenden	Option zum Anwenden der Richtlinie auf alle Tabellen. Diese Option gilt nur für Richtlinien für Tabelle API.
   A Veröffentlichen Sie alle Authentifizierungsschemata	Bestimmt, ob WWW-Authentifizierung Der Header enthält alle konfigurierten Authentifizierungsschemas. Wenn auf festgelegt Falsch (Standard) enthält der Header nur das zuletzt konfigurierte Authentifizierungsprofil in der Richtlinie. Wenn auf festgelegt Wahr , Der Header listet alle konfigurierten Authentifizierungsschemata auf.

   Hinweis:

   Weitere Informationen zur Priorisierung der API-Zugriffsrichtlinie finden Sie unter Priorisierung der API-Zugriffsrichtlinie.
4. Doppelklicken Sie auf Neue Zeile einfügen.
5. Wählen Sie ein eingehendes Authentifizierungsprofil aus der Liste aus, und wählen Sie das Speichern-Symbol .
   Sie können beispielsweise hinzufügen Standardauthentifizierung , ID-Token , Zertifikatbasierte Authentifizierung , OAuth Oder WSSE-Authentifizierung .
   1. Um ein oder mehrere eingehende Authentifizierungsprofile hinzuzufügen, wählen Sie aus Neu Um ein neues Profil zu erstellen.
   2. Wählen Sie Aus Welche Art von Authentifizierungsprofilen? .
      • Standardmäßiges http-Authentifizierungsprofil erstellen
      • WSSE-Authentifizierungsprofile erstellen
      • Authentifizierungsprofile für API-Schlüssel erstellen
      • HMAC-Authentifizierungsprofile erstellen

      
   3. Speichern Sie den Datensatz nach dem Erstellen des Authentifizierungsprofils.
6. Wählen Sie Aus Übermitteln Zum übermitteln der REST API-Zugriffsrichtlinie.