API Edge uniquement destinées à être utilisées avec des appareils Edge AWS IoT SiteWise

Outre les AWS IoT SiteWise API disponibles en périphérie, il existe des API spécifiques à la périphérie. Ces API spécifiques à la périphérie sont décrites ci-dessous.

Authentifier

Obtient les informations d'identification de la passerelle SiteWise Edge. Vous devez ajouter des utilisateurs locaux ou vous connecter à votre système via LDAP ou un groupe d'utilisateurs Linux. Pour plus d'informations sur l'ajout d'utilisateurs, consultez LDAP ou groupe d'utilisateurs Linux.

Syntaxe de demande

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

Paramètres de demande d'URI

La demande n’utilise pas de paramètres URI.

Corps de la demande

Cette demande accepte les données suivantes au format JSON.

nom d’utilisateur

Le nom d'utilisateur utilisé pour valider l'appel de demande.

Type : chaîne

Obligatoire : oui

mot de passe

Le mot de passe de l'utilisateur demandant les informations d'identification.

Type : chaîne

Obligatoire : oui

authMechanism

Méthode d'authentification permettant de valider cet utilisateur sur l'hôte.

Type : chaîne

Valeurs valides: ldap, linux, winnt

Obligatoire : oui

Syntaxe de réponse

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

Éléments de réponse

Si l’action aboutit, le service renvoie une réponse HTTP 200.

Les données suivantes sont renvoyées au format JSON.

accessKeyId

L'ID de clé d'accès qui identifie les informations d'identification de sécurité temporaires.

Contraintes de longueur : longueur minimale de 16. Longueur maximum de 128.

Modèle : [\w]*

secretAccessKey

La clé d'accès secrète qui peut être utilisée pour signer les demandes.

Type : chaîne

sessionToken

Le jeton que les utilisateurs doivent transmettre à l'API du service pour utiliser les informations d'identification temporaires.

Type : chaîne

region

La région que vous ciblez pour les appels d'API.

Type : CONSTANT - edge

Erreurs

IllegalArgumentException

La demande a été rejetée car le corps du document fourni était mal formé. Le message d'erreur décrit l'erreur spécifique.

Code d’état HTTP : 400

AccessDeniedException

L'utilisateur ne dispose pas d'informations d'identification valides basées sur le fournisseur d'identité actuel. Le message d'erreur décrit le mécanisme d'authentification.

Code d’état HTTP : 403

TooManyRequestsException

La demande a atteint sa limite de tentatives d'authentification. Le message d'erreur indique le temps d'attente avant que de nouvelles tentatives d'authentification ne soient effectuées.

Code d’état HTTP : 429