API REST pour l'extraction du jeton d'authentification

Utilisez l'opération POST sur l'élément api/get_token pour demander votre jeton unique requis pour authentifier les demandes API REST.

Pour demander votre jeton unique, utilisez l'URL suivante :
https://hostname:port/api/get_token
Important : Cet appel d'API REST ne fonctionne pas lorsque l'authentification de connexion unique est activée. Pour afficher le jeton, connectez-vous à BigFix Inventory, survolez l'icône Utilisateur Icône utilisateur et cliquez sur Profil. Cliquez ensuite sur Afficher le jeton.
Tableau 1. Descriptions des opérations
Détails de l'opération Description
Fonctionnement POST /api/get_token
Finalité Renvoie le jeton d'authentification
Méthode HTTP POST
URI de resources https://server_host_name:port_number/api/get_token
Relation du lien de l'URL n/a
Paramètres de requête URI n/a
En-têtes de demande
Fonction métier
Accept-Language (Facultatif)
Valeurs
en-US (seul l'anglais est pris en charge)

Sert à négocier la langue de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.

Charge de la demande
{
	"user" : "username",
	"password" : "password"
}
Demande Content-Type
  • application/json
En-têtes de réponse
En-tête
Content-Type
Valeurs
application/json

Définit le type de contenu de la réponse.

En-tête
Content-Language
Valeurs
en-US, …

Définit la langue du contenu de la réponse. Si cet en-tête n'est pas spécifié, le contenu est renvoyé dans la langue du serveur.

Charge de la réponse Token élément
RéponseContent-Type
  • application/json
Codes de réponse normaux HTTP
  • 200 – OK
Codes de réponse HTTP d'erreur
  • 401 – “Unauthorized”

Il n'existe aucune correspondance par rapport au nom d'utilisateur et au mot de passe fournis. Si vous utilisez Active Directory, assurez-vous que le nom de l'utilisateur est suivi d'un nom de domaine, par exemple username@domain.com.

Exemple de conversation HTTP

Demande
POST api/get_token
Host: localhost:9081
Accept: application/json
Accept-Language: en-US
En-tête de demande
Content-Type: application/json
Charge de la demande
{
	"user" : "admin",
	"password" : "password"
}
En-tête de réponse
HTTP/1.1 200 OK
Content-Type: application/json
Content-Language: en-US
Corps de réponse (JSON)
{
"token":"44072fb20fbe38322b5e67a7e780978e20abbc80"
}