API S'authentifier avec le nom d'utilisateur et le mot de passe
Utilisez cette API pour authentifier l'accès à votre Control Room avec un nom d'utilisateur et un mot de passe valides. Une réponse complète réussie génère un jeton Web JSON.Par défaut, un jeton est valide pendant 20 minutes. Pour générer le jeton, vous avez besoin d'un nom d'utilisateur et d'un mot de passe valides pour la Control Room.
Demande
POST http://{{localhost}}/v1/authenticationCorps de la demande :
{
"username":"jdoe",
"password":"mypassword@123"
}Corps de la demande pour générer un jeton de connexion multiple :
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}Paramètres de la demande
| Paramètre | Type | Description |
|---|---|---|
| nom d'utilisateur | Chaîne | Saisissez votre nom d'utilisateur. |
| mot de passe | Chaîne | Saisissez votre mot de passe. |
| multipleLogin | Booléen | Autorisez ou désactivez la connexion multiple. Pour plus d'informations sur la connexion multiple, voir Utilisateur multi-connexion.
Remarque : Si cette valeur est définie sur vrai, vous serez autorisé à ouvrir plusieurs sessions de l'API. |
Réponse
{
"token":"eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiIxIiwiY2xpZW50VHlwZSI6IldFQiIsImxpY2Vuc2VzIjpbXSwiYW5hbHl0aWNzTGljZW5zZXNQdXJjaGFzZWQiOnsiQW5hbHl0aWNzQ2xpZW50Ijp0cnVlLCJBbmFseXRpY3NBUEkiOnRydWV9LCJpYXQiOjE1NzMxMDc4NzMsImV4cCI6MTU3MzEwOTA3MywiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjM2NTc1NjI0OTQ2MzE2MDAsImNzcmZUb2tlbiI6ImNiZjgwZWNkZmU5YmUwYzViOGI2MDk3NmU0ZTI2MTNiIn0.rGYxbS5kKUTxtZhYtRSXpmIHwbf3IwLBIKDEA7odG5uGVAjD55Tv05bYdARx_3-tl1CBg_cDGbwj5FvaBt9u5xKu5W5j3Nur6x3PF62NeB3ZIdxiUPaFBU0Br84mPJMD4_EpwBfbeSVOMH6ngiLtJYhIOtJa0kp4pAAm3mvkuOUELtH8lf3pQf-2Ose2fUAaebDkqiH13SUF1TONAjUQv6Ef_uY0wgq9SjZwKHg9SKUhX3S8PXAJne_ih2QnN8nUE1SXGlkC04eoIvyWpFkM963XEjptc2uvwtVn42MdA4Nd1opD5yijEl9VM92Fe1sPb6_T5-oV-U1Iw0JHiX2-Ug",
"user":{
"id":9,
"email":"a@a.com",
"username":"jdoe",
"domain":null,
"firstName":"j",
"lastName":"doe",
"version":9,
"principalId":9,
"deleted":false,
"roles":[
{
"name":"API_Key_Generation",
"id":23,
"version":0
},
{
"name":"AAE_Basic",
"id":2,
"version":0
},
{
"name":"Docrole1",
"id":18,
"version":0
}
],
"sysAssignedRoles":[
],
"groupNames":[
],
"permissions":[
". . ."
],
"licenseFeatures":[
"RUNTIME"
],
"emailVerified":true,
"passwordSet":true,
"questionsSet":true,
"enableAutoLogin":false,
"disabled":false,
"clientRegistered":false,
"description":"",
"createdBy":1,
"createdOn":"2022-03-10T13:39:56-05:00",
"updatedBy":1,
"updatedOn":"2022-03-13T02:09:38-05:00",
"publicKey":null,
"appType":null,
"routingName":null,
"appUrl":null
}
}Paramètres de la réponse
| Paramètre | Type | Description |
|---|---|---|
| jeton | Chaîne | Jeton d'accès généré qui sert d'identifiant de session que votre application utilisera pour effectuer des demandes. Ce jeton est équivalent aux informations d'identification de l'utilisateur et doit être protégé. Remarque : Si multipleLogin est défini sur vrai, vous pourrez utiliser ce jeton pour plusieurs sessions de l'API. |
| utilisateur | Objet | Objet utilisateur retourné avec tous les détails de l'utilisateur.
|
Insérez le jeton dans l'en-tête des demandes d'API suivantes.
Remarque : Pour une Control Room déployée sur Cloud et pour laquelle l'authentification SAML est activée, générez le jeton Web avec votre
nom d'utilisateur et votre clé API.