OAuth-API-Anforderungsparameter

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 2 Minuten Lesedauer

    • Erfahren Sie mehr über die OAuth-API-Anforderungsparameter, die von Zugriffstoken-Anforderungen verwendet werden.

    Hinweis:
    Der Inhaltstyp der OAuth-API muss „application/x-www-form-urlencoded“sein. Der Inhaltstyp „application/json“ führt zu einem nicht angegebenen Fehler.
    Tabelle : 1. Anforderungsparameter für Zugriffstoken
    Anforderungsparameter Beschreibung
    „grant_type“ [Pflichtfeld] Der Typ der Anmeldeinformationen, die die Anforderung eines Zugriffstokens autorisieren. Dieser Parameter muss einen der folgenden Werte aufweisen:
    • Passwort: Ein Satz von Anwenderanmeldeinformationen zum Autorisieren der Anforderung eines Zugriffstokens. Geben Sie die Anmeldeinformationen des Anwenders in den Parametern Anwendername und Passwort an.
    • refresh_token: Ein vorhandenes Aktualisierungstoken autorisiert die Zugriffstokenanforderung. Geben Sie das Aktualisierungstoken im Parameter „refresh_token“ an.
    client_id [Erforderlich] Automatisch generierte eindeutige ID der Client-Anwendung, die das Zugriffstoken anfordert.
    client_secret [Erforderlich] Gemeinsame geheime Zeichenfolge, die die Instanz und die OAuth-Anwendung verwenden, um die Kommunikation miteinander zu autorisieren.
    username Name des Anwenderaccounts, der die Anforderung des Zugriffstokens autorisiert. Dieser Parameter ist für Zugriffs-Token-Anforderungen mit einem commit_type-Wert vom Typ passworderforderlich.
    Passwort Passwort für den Anwenderaccount, der die Anforderung des Zugriffstokens autorisiert. Dieser Parameter ist für Zugriffs-Token-Anforderungen mit einem commit_type-Wert vom Typ passworderforderlich.
    Aktualisierung_Token Vorhandenes Aktualisierungstoken, das die Anforderung des Zugriffstokens autorisiert. Dieser Parameter ist für Zugriffs-Token-Anforderungen mit einemgrant_type von refresh_tokenerforderlich.

    Anforderungen, die Anwenderanmeldeinformationen verwenden

    Die Instanz erfordert, dass Clients Anmeldeinformationen bereitstellen, wenn Sie den Client zum ersten Mal autorisieren oder wenn Sie die Erstellung eines neuen Aktualisierungstokens autorisieren. Diese Art von Anforderung gibt immer zwei Token zurück:

    • Ein Zugriffstoken
    • Ein Aktualisierungstoken

    Die Instanz verifiziert, dass der Benutzer aktiv und derzeit nicht ausgesperrt ist und über eine interaktive Sitzung verfügt. Wenn eine dieser Bedingungen „false“ ist, erzeugt die Instanz kein Zugriffstoken. Zugriffsanforderungen, die innerhalb der Ablaufzeit des Zugriffstokens gestellt werden, geben immer das aktuelle Zugriffstoken zurück.

    Hinweis:
    Diese Art der Autorisierungsgewährung basiert auf TLS-Verschlüsselung, um die Anmeldeinformationen der Benutzer während der Übertragung zu schützen.

    Das folgende Beispiel veranschaulicht das Anfordern eines Zugriffstokens mit einem Satz von Anwenderanmeldeinformationen (Bereiche wurden hinzugefügt, um die Lesbarkeit zu verbessern).

    
$ curl -d"grant_type=password&client_id=be3aeb583ace210011c15b24a43e25d8
&client_secret=client_password
&username=admin&password=admin" 
https://instancename.service-now.com/oauth_token.do

    Anforderungen mit Aktualisierungstoken

    Die Instanz kann ein vorhandenes Aktualisierungstoken verwenden, um ein neues Zugriffstoken zu erstellen. Diese Art von Anforderung gibt nur ein Zugriffstoken zurück. Die Instanz bestätigt, dass das Aktualisierungstoken nicht abgelaufen ist, bevor ein neues Zugriffstoken generiert wird. Zugriffsanforderungen, die innerhalb der Ablaufzeit des Aktualisierungstokens gestellt werden, geben immer das aktuelle Aktualisierungstoken zurück. Die Übertragung von Aktualisierungstoken ist im Allgemeinen sicherer als die Übertragung von Benutzeranmeldeinformationen. Das folgende Beispiel veranschaulicht das Anfordern eines Zugriffstokens mit einem vorhandenen Aktualisierungstoken (Leerzeichen wurden hinzugefügt, um die Lesbarkeit zu verbessern).

    
$ curl -d"grant_type=refresh_token&client_id=be3aeb583ace210011c15b24a43e25d8
&client_secret=client_password
&refresh_token=w599voG89897rGVDmdp12WA681r9E5948c1CJTPi8g4HGc4NWaz62k6k1K0FMxHW40H8yOO3Hoe" 
https://instancename.service-now.com/oauth_token.do