View a markdown version of this page

Edge-only APIs zur Verwendung mitAWS IoT SiteWiseEdge-Geräte - AWS IoT SiteWise
Authentifizieren

Die vorliegende Übersetzung wurde maschinell erstellt. Im Falle eines Konflikts oder eines Widerspruchs zwischen dieser übersetzten Fassung und der englischen Fassung (einschließlich infolge von Verzögerungen bei der Übersetzung) ist die englische Fassung maßgeblich.

Edge-only APIs zur Verwendung mitAWS IoT SiteWiseEdge-Geräte

Zusätzlich zu den AWS IoT SiteWise APIs, die am Edge verfügbar sind, gibt es Edge-spezifische APIs. Diese Edge-spezifischen APIs werden im Folgenden beschrieben.

Authentifizieren

Ruft die Anmeldeinformationen vom SiteWise Edge-Gateway ab. Sie müssen lokale Benutzer hinzufügen oder über LDAP oder einen Linux-Benutzerpool eine Verbindung zu Ihrem System herstellen. Weitere Informationen zum Hinzufügen von Benutzern finden Sie unter LDAP - oder Linux-Benutzerpool.

Erforderliche Syntax

POST /authenticate HTTP/1.1
Content-type: application/json
{
  "username": "string",
  "password": "string",
  "authMechanism": "string"
}

URI-Anforderungsparameter

Die Anforderung verwendet keine URI-Parameter.

Anforderungstext

Die Anforderung akzeptiert die folgenden Daten im JSON-Format.

username

Der Benutzername, der zur Validierung des Anforderungsaufrufs verwendet wurde.

Typ: Zeichenfolge

Erforderlich: Ja

password

Das Passwort des Benutzers, der Anmeldeinformationen anfordert.

Typ: Zeichenfolge

Erforderlich: Ja

authMechanism

Die Authentifizierungsmethode zur Validierung dieses Benutzers auf dem Host.

Typ: Zeichenfolge

Zulässige Werte: ldap, linux, winnt

Erforderlich: Ja

Antwortsyntax

HTTP/1.1 200
Content-type: application/json
{
  "accessKeyId": "string",
  "secretAccessKey": "string",
  "sessionToken": "string",
  "region": "edge"
}

Antwortelemente

Wenn die Aktion erfolgreich ist, sendet der Service eine HTTP 200-Antwort zurück.

Die folgenden Daten werden im JSON-Format zurückgegeben.

Zugriff KeyId

Die Zugriffsschlüssel-ID, die die temporären Sicherheitsanmeldedaten identifiziert.

Längenbeschränkungen: Mindestlänge von 16. Maximale Länge beträgt 128 Zeichen.

Pattern: [\w]*

geheim AccessKey

Der geheime Zugriffsschlüssel, der zum Signieren von Anfragen verwendet werden kann.

Typ: Zeichenfolge

sessionToken

Das Token, das Benutzer an die Service-API übergeben müssen, um die temporären Anmeldeinformationen verwenden zu können.

Typ: Zeichenfolge

Region

Die Region, auf die Sie für API-Aufrufe abzielen.

Typ: CONSTANT - edge

Fehler

IllegalArgumentException

Die Anfrage wurde abgelehnt, weil das bereitgestellte Hauptdokument falsch formatiert war. Die Fehlermeldung beschreibt den spezifischen Fehler.

HTTP-Statuscode: 400

AccessDeniedException

Der Benutzer verfügt nicht über gültige Anmeldeinformationen, die auf dem aktuellen Identity Provider basieren. Die Fehlermeldung beschreibt den Authentifizierungsmechanismus.

HTTP-Statuscode: 403

TooManyRequestsException

Die Anfrage hat das Limit an Authentifizierungsversuchen erreicht. Die Fehlermeldung gibt an, wie lange gewartet werden soll, bis neue Authentifizierungsversuche unternommen werden.

HTTP-Statuscode: 429