OAuth-API-Anforderungsparameter

Erfahren Sie mehr über die OAuth-API-Anforderungsparameter, die von Zugriffstokenanforderungen verwendet werden.

Hinweis:

Der Inhaltstyp der OAuth-API muss application/x-www-form-urlencoded sein. Ein Inhaltstyp von application/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 für ein Zugriffstoken autorisieren. Dieser Parameter muss einen der folgenden Werte haben: password: Eine Reihe von Benutzeranmeldeinformationen zum Autorisieren der Zugriffstokenanforderung. Geben Sie die Benutzeranmeldeinformationen in den Parametern username und password 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 Clientanwendung, die das Zugriffstoken anfordert.
client_secret	[Erforderlich] Zeichenfolge des gemeinsamen geheimen Schlüssels, die die Instanz und die OAuth-Anwendung verwenden, um die Kommunikation miteinander zu autorisieren.
username	Name des Benutzerkontos, der die Zugriffstoken-Anforderung autorisiert. Dieser Parameter ist für Zugriffstokenanforderungen mit grant_type von passworderforderlich.
Kennwort	Passwort für das Benutzerkonto, das die Zugriffstoken-Anforderung autorisiert. Dieser Parameter ist für Zugriffstokenanforderungen mit grant_type von passworderforderlich.
refresh_token	Vorhandenes Aktualisierungstoken, das die Zugriffstokenanforderung autorisiert. Dieser Parameter ist für Zugriffstokenanforderungen mit einem grant_type von refresh_token erforderlich.

Anforderungen mit Benutzeranmeldeinformationen

Für die Instanz müssen Clients Anmeldeinformationen angeben, wenn sie den Client zum ersten Mal autorisieren oder die Erstellung eines neuen Aktualisierungstokens autorisieren. Dieser Anforderungstyp gibt immer zwei Token zurück:

• Ein Zugriffstoken
• Ein Aktualisierungstoken

Die Instanz überprüft, ob der Benutzer aktiv und derzeit nicht ausgesperrt ist und eine interaktive Sitzung hat. Wenn eine dieser Bedingungen „falsch“ ist, generiert die Instanz kein Zugriffstoken. Zugriffsanforderungen, die innerhalb der Ablaufzeit des Zugriffstokens gestellt werden, geben immer das aktuelle Zugriffstoken zurück.

Hinweis:

Diese Art der Autorisierung basiert auf der TLS-Verschlüsselung, um die Benutzeranmeldeinformationen während der Übertragung zu schützen.

Das folgende Beispiel zeigt die Anforderung eines Zugriffstokens mit einem Satz von Benutzeranmeldeinformationen (Leerzeichen 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 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 zeigt die Anforderung 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