---
sourceDocument: Yokohama-Plattformsicherheit
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/platform-security

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama-Plattformsicherheit

ft:clusterId :

    - psec

bundleId :

    - psec

workflow :

    - Platform


---

# API-Schlüssel konfigurieren -- Token-basierte Authentifizierung

# API-Schlüssel konfigurieren -- Token-basierte Authentifizierung {#ariaid-title1}

* Freigeben Version: Yokohama
* 
* Aktualisiert 30. Januar 2025
* 
* ![](https://www.servicenow.com/docs/portal-asset/ico-clock) 2 Minuten Lesedauer

Konfigurieren Sie einen API-Schlüssel, um die Authentifizierung für REST-API-Endpunkte zu unterstützen.

## Vorbereitungen

Erforderliche Rolle: Administrator

Plugin erforderlich: API-Schlüssel und HMAC-Authentifizierung ( <kbd class="ph userinput">Com.Glide.tokenbased_auth </kbd>)

## Prozedur

1. Erstellen Sie ein eingehendes Authentifizierungsprofil.
   1. Navigieren zu AlleSystem-WebservicesAPI-ZugriffsrichtlinienEingehende Authentifizierungsprofilean.
   2. Wählen Sie Neu.  
      Das System zeigt die Nachricht an Welche Art von Authentifizierungsprofil?
   3. Wählen Sie Aus Erstellen Sie API-Schlüssel-Authentifizierungsprofile .  
   4. Füllen Sie im Formular die Felder aus.  
      {#configure-api-key__table_pdg_vvm_nzb__entry__2}

      | Feld | Beschreibung |
      |-|-|
      | Name | Name zur Identifizierung der Authentifizierungsrichtlinie. |
      | Anwendung | Umfang der Authentifizierungsrichtlinie. |
      | Auth-Parameter | Wählen Sie den Authentifizierungsparameter für die Authentifizierungsanforderung aus. Sie können die Standardoptionen auswählen oder einen neuen Authentifizierungsparameter erstellen: * X-sn-apikey: Authentifizierungsheader * X-sn-apikey: Abfrageparameter-Header {#configure-api-key__ul_vpl_bwm_nzb} |
      [Tabelle : 1. API-Schlüssel-Authentifizierungsprofile]

      {#configure-api-key__table_pdg_vvm_nzb}  
      Hinweis:  
      Die ausgewählte Option muss im REST-Aufruf im Authentifizierungsheader oder Abfrageparameter definiert werden.  
      Hinweis:  
      Wenn Sie ein Präfix für den API-Schlüssel hinzufügen möchten, öffnen Sie die ausgewählte Authentifizierungsparameterdatei, und geben Sie an Präfix Feld.
   5. Bestätigen Sie das Formular.
2. Erstellen Sie einen REST-API-Schlüssel.
   1. Navigieren zu AlleSystem-WebservicesAPI-ZugriffsrichtlinienREST-API-Schlüsselan.
   2. Wählen Sie Neu.
   3. Füllen Sie im Formular die Felder aus:  
      {#configure-api-key__table_ehg_jtx_mzb__entry__2}

      | Feld | Beschreibung |
      |-|-|
      | Name | Name zur Identifizierung des REST-API-Schlüssels |
      | Beschreibung | Beschreibung für den REST-API-Schlüssel. |
      | Aktiv | Status des REST-API-Schlüssels. |
      | Anwender | Anwender, der dem REST-API-Schlüssel zugeordnet ist. Verwenden Sie das Suchsymbol, um den Anwender auszuwählen. |
      | Authentifizierungsbereich | Option zum Hinzufügen des Authentifizierungsbereichs, um die Berechtigung des REST-API-Schlüssels zu verwalten. |
      | Token | Der von generierte REST-API-Schlüssel Now Platform. Kopieren Sie den Schlüssel, der als Teil des REST-API-Aufrufs im Header- oder Abfrageparameter verwendet werden soll. |
      | Ablauf | Zeit, nach der die Anmeldeinformationen nicht mehr gültig sind. Ein leerer Wert bedeutet keinen Ablauf. Hinweis: Weitere Informationen zum Ablauf des Tokens finden Sie unter [Token-Ablauf wird bereinigt](https://servicenow-prod.fluidtopics.net/jBg~p80dqNrPfvXNy4Hxsg "Details zum Bereinigen des Tokenablaufs mithilfe verschiedener Systemeigenschaften."). |
      [Tabelle : 2. API-Schlüssel]

      {#configure-api-key__table_ehg_jtx_mzb}
   4. Bestätigen Sie das Formular.
   5. Öffnen Sie den Datensatz, der erstellt wurde, um das von generierte Token anzuzeigen Now PlatformFür den Anwender.  
   {#configure-api-key__substeps_j4w_dtx_mzb}
3. Erstellen Sie eine REST-API-Zugriffsrichtlinie.
   1. Navigieren zu AlleSystem-WebservicesREST API-Zugriffsrichtlinienan.
   2. Wählen Sie Neu.
   3. Füllen Sie im Formular die Felder aus.  
      {#configure-api-key__table_d4x_w45_d4b__entry__2}

      | 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: Jetzt/Anhang . |
      | 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 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 |
      | Anwendung | Umfang der Anwendung. |
      | Global | Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie auf alle Methoden, Versionen und Ressourcen für die API anzuwenden. Hinweis: Token-basierte Authentifizierung ist in der globalen REST API-Richtlinie nicht zulässig. |
      | Auf alle Methoden anwenden | Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Methoden, Versionen und Ressourcen für die API anzuwenden. |
      | Auf alle Ressourcen anwenden | Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Versionen anzuwenden. |
      | Auf alle Versionen anwenden | Aktivieren Sie dieses Feld, um die Authentifizierungsrichtlinie für die API auf alle Ressourcen anzuwenden. |
      [Tabelle : 3. API-Zugriffsrichtlinien]

      {#configure-api-key__table_d4x_w45_d4b}
   4. Fügen Sie das erstellte API-Authentifizierungsprofil hinzu.
   5. Bestätigen Sie das Formular.

   {#configure-api-key__substeps_ypz_h5x_mzb}  
   Sie können den REST-API-Aufruf mit dem x-sn-apikey (Token) senden, der von generiert wurde Now PlatformWährend der API-Schlüsselerstellung innerhalb des Headers- oder Abfrageparameters basierend auf der Konfiguration für die Authentifizierung.  
   Warnung:  
   Verwenden VERÖFFENTLICHEN Anforderung, wenn vertrauliche Informationen an den Server übermittelt werden.