Autenticazione con nome utente e API della chiaveapi
Usa questa API per autenticare l'accesso alla Control Room con il nome utente
e la chiaveapi
. Una risposta completata correttamente genera un token web JSON.Per impostazione predefinita, un token è valido per 20 minuti. Questo endpoint consente agli utenti di generare il token senza la necessità di inserire la propria password, ad esempio per le organizzazioni che utilizzano il Single Sign-On (SSO). Per generare il token, sono necessari nome utente
e chiaveapi
validi per la Control Room.
Per generare il token, è necessario quanto segue:
- Un ruolo personalizzato con l'autorizzazione Genera chiave API
Nome utente
echiave API
validi per la Control Room. Lachiave API
è una stringa di 40 caratteri generata nella Control Room.
Richiesta
POST http://{{localhost}}/v1/authentication
Corpo della richiesta:
{
"username":"jdoe",
"apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}
Parametri della richiesta
Parametro | Tipo | Descrizione |
---|---|---|
nome utente | Stringa | Inserisci il tuo nome utente. Nota: Se l'utente dispone di sessioni multiple abilitate, verrà generato un token di sessione multipla. Per ulteriori informazioni sugli accessi multipli, vedi Utente multi-login. |
chiaveapi | Stringa | Inserisci la tua chiaveapi. Nota: Assicurati di sostituire i caratteri di escape '\' with '\\' nella chiave API. |
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. |
utente | Oggetto | L'oggetto utente restituito con tutti i dettagli dell'utente.
|
Inserisci il token nell'intestazione della richiesta delle richieste API successive.