Demandes d'API REST VMware Aria Operations

Pour récupérer des représentations d'objets, les clients envoient des demandes HTTP aux références d'objets.

Sécurité

Le lien HTTP entre un client et un serveur d'API est établi à l'aide de SSL. Les clients d'API configurent l'authentification basée sur un jeton pour communiquer avec le serveur.

Diagramme de blocs illustrant le mode d'accès aux points de terminaison protégés avec des informations d'identification valides. — Figure 1. Scénario : Fournir des informations d'identification d'utilisateur pour obtenir des détails concernant l'alerte avec l'ID 123

Avec l'authentification basée sur un jeton, vous envoyez une demande POST de connexion au serveur d'API VMware Aria Operations, en fournissant des informations d'identification d'utilisateur valides pour obtenir un jeton d'authentification. L'exemple suivant présente un scénario d'authentification basée sur un jeton.

Vous obtenez des informations d'identification d'utilisateur valides pour votre instance de VMware Aria Operations. Cela s'applique à l'authentification non-SSO.
Envoyez une demande POST au point de terminaison REST pour l'authentification.
```
https://RESTendpoint.example.com/suite-api/api/auth/token/acquire
```
Le corps de la demande comporte le nom d'utilisateur, le mot de passe et la source d'authentification.
Dans le corps de la réponse, le point de terminaison renvoie le jeton, la date d'expiration et l'heure.
Pour une communication plus poussée, vous devez inclure l'objet du jeton dans l'en-tête d'autorisation au format suivant :
```
Authorization: OpsToken <vROps_token>
```
Note : L'ancien format
```
Authorization: vRealizeOpsToken <vROps_token>
```
continue d'être pris en charge dans VMware Aria Operations.
Si vous avez obtenu le jeton en externe auprès d'une source d'authentification unique (sans utiliser /suite-api/api/auth/token/acquire API), l'en-tête d'autorisation est au format suivant :
```
Authorization: SSO2Token <SSO_SAML_TOKEN>
```
Vous pouvez invalider le jeton avant la date et l'heure d'expiration en envoyant une demande POST au point de terminaison de déconnexion.
```
POST https://RESTendpoint.example.com/suite-api/api/auth/token/release
```

En-têtes de la demande

Les en-têtes HTTP suivants sont généralement inclus dans les demandes d'API :

Accept-Language	Pour indiquer la langue souhaitée dans les réponses, utilisez l'en-tête de la demande `Accept-Language`. Les chaînes de caractères dans les réponses ErrorType sont localisées. Pour demander une réponse avec les chaînes de caractères localisées en français, utilisez l'en-tête suivant : Accept-Language: fr-FR
Autorisation	Toutes les demandes de création d'une session d'API doivent inclure un en-tête `Authorization` du formulaire recommandé par le fournisseur d'identité utilisé par votre organisation
Content-Type	Les demandes qui incluent un corps doivent inclure un en-tête HTTP `Content-Type` approprié. Pour un corps de demande au format XML, l'en-tête doit inclure Content-Type: application/xml Pour un corps de demande au format JSON, l'en-tête doit inclure Content-Type: application/json
Accepter	Pour indiquer le format de réponse souhaité, vous devez inclure l'en-tête de demande `Accept`. Pour une réponse au format XML, l'en-tête doit inclure Accept: application/xml Pour une réponse au format JSON, l'en-tête doit inclure Accept: application/json

Corps de la demande au format XML

Pour un corps de demande écrit en XML, VMware Aria Operations utilise un analyseur XML de validation qui exige que les éléments du corps de la demande respectent le schéma selon l'ordre et le nombre. Les corps de la demande sont rejetés et non valides, sauf s'ils répondent aux critères suivants :

Les attributs d'espace de noms XML doivent être fournis pour tous les espaces de noms représentés par des éléments dans la demande.
Si plusieurs espaces de noms sont représentés dans la demande, les attributs d'espace de noms XML doivent inclure un préfixe d'identification, et ce préfixe doit être utilisé avec tous les éléments de cet espace de noms.
Tous les éléments requis doivent apparaître dans les corps de la demande. Tous les éléments qui s'affichent dans les corps de demande doivent s'afficher dans l'ordre indiqué sur le schéma, et avec le contenu conforme à la contrainte de type spécifiée par le schéma.