OAuth-API-Anforderungsparameter

  • Freigeben Version: Yokohama
  • Aktualisiert 30. Januar 2025
  • 1 Minute Lesedauer

    • Erfahren Sie mehr über die OAuth-API-Anforderungsparameter, die Zugriffstoken-Anforderungen verwenden.

    Hinweis:
    Der Inhaltstyp der OAuth-API muss sein Application/x-www-Form-urlencoded . Ein Inhaltstyp von Anwendung/JSON Führt zu einem nicht angegebenen Fehler.
    Tabelle : 1. Anforderungsparameter für Zugriffstoken
    Anforderungsparameter Beschreibung
    Grant_type [Erforderlich] der Typ der Anmeldeinformationen, die die Anforderung eines Zugriffstoken autorisieren. Dieser Parameter muss einen der folgenden Werte haben:
    • Passwort : Eine Reihe von Anwenderanmeldeinformationen zum Autorisieren der Zugriffstoken-Anforderung. Geben Sie die Anwenderanmeldeinformationen in den Parametern „Anwendername“ und „Passwort“ an.
    • REFRESH_Token : Ein vorhandenes Aktualisierungstoken autorisiert die Zugriffstoken-Anforderung. Geben Sie das Aktualisierungstoken im Parameter „refresh_Token“ an.
    client_id [Erforderlich] automatisch generierte eindeutige ID der Clientanwendung, die das Zugriffstoken anfordert.
    client_secret [Erforderlich] Zeichenfolge für freigegebenes Geheimnis, die die Instanz und die OAuth-Anwendung verwenden, um Kommunikation miteinander zu autorisieren.
    username Anwenderaccount-Name, der die Zugriffstoken-Anforderung autorisiert. Dieser Parameter ist für Zugriffstoken-Anforderungen mit erforderlich Grant_type Von Passwort .
    Passwort Passwort für den Anwenderaccount, der die Zugriffstoken-Anforderung autorisiert. Dieser Parameter ist für Zugriffstoken-Anforderungen mit erforderlich Grant_type Von Passwort .
    REFRESH_Token Vorhandenes Aktualisierungstoken, das die Zugriffstoken-Anforderung autorisiert. Dieser Parameter ist für Zugriffstoken-Anforderungen mit erforderlich Grant_type Von REFRESH_Token .

    Anforderungen Mit Anwenderanmeldeinformationen

    Die Instanz erfordert, dass Clients bei der ersten Autorisierung des Clients oder bei der Autorisierung der Erstellung eines neuen Aktualisierungstoken Anmeldeinformationen des Anwenders angeben. Dieser Anforderungstyp gibt immer zwei Token zurück:

    • Ein Zugriffstoken
    • Ein Aktualisierungstoken

    Die Instanz verifiziert, dass der Anwender aktiv ist, derzeit nicht gesperrt ist und eine interaktive Sitzung hat. Wenn eine dieser Bedingungen falsch ist, erstellt die Instanz kein Zugriffstoken. Zugriffsanforderungen, die innerhalb der Ablaufzeit des Zugriffstoken gestellt werden, geben immer das aktuelle Zugriffstoken zurück.

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

    Das folgende Beispiel veranschaulicht die Anforderung eines Zugriffstoken mit einer Reihe 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 einem Aktualisierungstoken

    Die Instanz kann ein vorhandenes Aktualisierungstoken verwenden, um ein neues Zugriffstoken zu erstellen. Dieser Anforderungstyp 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 Aktualisierungstoken gestellt werden, geben immer das aktuelle Aktualisierungstoken zurück. Die Übertragung von Aktualisierungstoken ist im Allgemeinen sicherer als die Übertragung von Anwenderanmeldeinformationen. Das folgende Beispiel veranschaulicht das anfordern eines Zugriffstoken mit einem vorhandenen Aktualisierungstoken (Bereiche 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