Autenticazione con API nome utente e password
Usa questa API per autenticare l'accesso alla Control Room con un nome utente e una password validi. Una risposta completata correttamente genera un token web JSON.Per impostazione predefinita, un token è valido per 20 minuti. Per generare il token, sono necessari un nome utente e una password validi per la Control Room.
Richiesta
POST http://{{localhost}}/v1/authenticationCorpo della richiesta:
{
"username":"jdoe",
"password":"mypassword@123"
}Corpo della richiesta per generare il token multi-login:
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}Parametri della richiesta
| Parametro | Tipo | Descrizione |
|---|---|---|
| nome utente | Stringa | Inserisci il tuo nome utente. |
| password | Stringa | Inserisci la tua password. |
| multipleLogin | Operatore booleano | Consenti o non consentire gli accessi multipli. Per ulteriori informazioni sul multi-login, vedi Utente multi-login.
Nota: Se questo valore è impostato su true saranno possibili sessioni API multiple. |
Risposta
{
"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
}
}Parametri di risposta
| Parametro | Tipo | Descrizione |
|---|---|---|
| token | Stringa | Token di accesso generato che agisce come un ID di sessione che l'applicazione userà per fare richieste. Questo token è equivalente alle credenziali dell'utente e deve essere protetto. Nota: Se multipleLogin è impostato su true si potrà usare questo token per più sessioni API. |
| utente | Oggetto | L'oggetto utente restituito con tutti i dettagli dell'utente.
|
Inserisci il token nell'intestazione della richiesta delle richieste API successive.
Nota: Per una Control Room distribuita su Cloud e con l'autenticazione SAML abilitata, genera il token web con il
nome utente e la chiaveapi.