---
sourceDocument: Yokohama IT Operations Management
sourceDocumentLink: https://servicenow-prod.fluidtopics.net/r/de-DE/yokohama/it-operations-management

 Release :

    - yokohama

ft:locale :

    - de-DE

ft:publication_title :

    - Yokohama IT Operations Management

ft:clusterId :

    - itom

bundleId :

    - itom

workflow :

    - Technology


---

# Konfigurieren MID-WebserverAPI-Schlüsselauthentifizierung

# Konfigurieren MID-WebserverAPI-Schlüsselauthentifizierung {#ariaid-title1}

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

Authentifizieren Sie eingehende Anforderungen von Clients bei MID-WebserverErweiterung mit API-Schlüsselauthentifizierung. Die API-Authentifizierung ist eine sichere und einfache Möglichkeit, Ihre Anforderung zu authentifizieren. Sie können erstellen oder ändern MID-WebserverAPI-Schlüssel.

## Vorbereitungen

Erstellen Sie ein MID-WebserverErweiterung zur Verwendung der API-Schlüsselauthentifizierung, wie in beschrieben [Konfigurieren Sie MID-WebserverErweiterung](https://servicenow-prod.fluidtopics.net/xOsCzTl6S_iFh0Af_kH50Q "Die MID-WebserverIst ein MID-ServerErweiterung, mit der die Entwicklung von REST-APIs Ereignisse und Metriken an senden können MID-Server. Die Erweiterung wird von anderen genutzt MID-ServerErweiterungen, z. B. Metrikdaten, MID-Webservice-Ereignis-Listener und Agent Client Collectorwebsocket-Endpunkterweiterung."). Stellen Sie sicher, dass Sie auswählen API-Schlüssel In der Erweiterung Authentifizierungstyp Feld.

Erforderliche Rolle: Event_mgmt_admin

## Warum und wann dieser Vorgang ausgeführt wird

Standardmäßig beträgt die maximale Anzahl von API-Schlüsseln, die Sie in einer Instanz erstellen können, 10. Um diese Nummer zu ändern, ändern Sie mid.webserver.max.api.keysEigenschaftswert auf der Seite „Systemeigenschaften".

Wenn Sie in der globalen Domäne arbeiten, während die Domänentrennung aktiviert ist, sind API-Schlüssel für alle Erweiterungen verfügbar, unabhängig von ihrer Domäne. Bei der Arbeit in einer bestimmten Domäne sind API-Schlüssel für Erweiterungen in dieser Domäne, ihren übergeordneten Domänen, verfügbar , Und die globale Domäne.

Sie können API-Schlüssel so konfigurieren, dass sie an einem angegebenen Datum ablaufen.

Beim Erstellen einer neuen Erweiterung mit API-Schlüsselauthentifizierung (oder Aktualisieren einer vorhandenen Erweiterung zur Verwendung der API-Schlüsselauthentifizierung) überprüft das System nach einem verfügbaren API-Schlüssel für die Erweiterung. Wenn kein API-Schlüssel verfügbar ist, erstellt das System einen.

## Prozedur

1. Navigieren zu AlleMID-ServerProfile und BereitstellungenMID-Webserver API-Schlüsselan.
2. Erstellen Sie entweder einen neuen API-Schlüssel, oder ändern Sie einen vorhandenen API-Schlüssel .  
   * So erstellen Sie einen neuen API-Schlüssel:
     1. Wählen Sie Neu.
     2. Füllen Sie im Formular MID-Webserver-API-Schlüssel die Felder aus.{#mid-web-server-api-key-authentication__table_bn5_25k_lrb__entry__2}

        | Feld | Beschreibung |
        |-|-|
        | Name | Name für den API-Schlüssel. |
        | Aktiv | Option zum Aktivieren des API-Schlüssels. |
        | Authentifizierungsschlüssel | Schreibgeschützter codierter Wert des Authentifizierungsschlüssels. Erst nach der Konfiguration des Schlüssels wird ein Wert angezeigt. |
        | Läuft ab | Option zum Festlegen eines Ablaufdatums für den API-Schlüssel. Abgelaufene, deaktivierte oder gelöschte API-Schlüssel werden von der Webservererweiterung nicht akzeptiert. |
        [Tabelle : 1. MID-Webserver API-Schlüsselformular]

        {#mid-web-server-api-key-authentication__table_bn5_25k_lrb}
     3. Wählen Sie Aus Übermitteln Zum Speichern des API-Schlüssels.

        Der API-Schlüssel wird auf der Seite „API-Schlüssel des MID-Webservers" angezeigt.
     {#mid-web-server-api-key-authentication__ol_otp_hrt_1sb}
   * So ändern Sie einen vorhandenen API-Schlüssel:
     1. Navigieren zu MID-ServerProfile und BereitstellungenMID-Webserver API-Schlüsselan.
     2. Wählen Sie einen API-Schlüssel auf der Seite aus.
     3. In Zugehörige Links Abschnitt auswählen Zeigen Sie den API-Schlüssel an .
     4. Kopieren Sie den API-Schlüssel, der im Dialogfeld „MID-Webserver" angezeigt wird.Beim Herstellen einer Verbindung mit MID-WebserverMit API-Schlüsselauthentifizierung konfigurierte Erweiterung platzieren Sie einen API-Schlüssel, auf den die Erweiterung Zugriff hat, im Autorisierungsheader der Anforderung im folgenden Format:

        `Schlüssel-<API_KEY>`
        Wo `<API_KEY> `Ist der Wert des API-Schlüssels, der nach der Auswahl angezeigt wird Zeigen Sie den API-Schlüssel an .
     5. Wählen Sie Absenden.
     {#mid-web-server-api-key-authentication__ol_i25_tst_1sb}
   {#mid-web-server-api-key-authentication__ul_esg_grt_1sb}