Mit Nutzername und Passwort-API authentifizieren
Verwenden Sie diese API, um den Zugriff auf Ihren Control Room mit einem gültigen Nutzernamen und Passwort zu authentifizieren. Eine erfolgreiche abgeschlossene Antwort erzeugt ein JSON-Web-Token. Standardmäßig ist ein Token 20 Minuten lang gültig. Um das Token zu generieren, benötigen Sie einen gültigen Nutzernamen und ein Passwort für den Control Room.
Anforderung
POST http://{{localhost}}/v1/authenticationAnforderungstext:
{
"username":"jdoe",
"password":"mypassword@123"
}Anforderungstext zum Generieren des Mehrfach-Anmelde-Tokens:
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}Anforderungsparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| Nutzername | Zeichenfolge | Geben Sie Ihren Nutzernamen ein. |
| Passwort | Zeichenfolge | Geben Sie Ihr Passwort ein. |
| multipleLogin | Boolescher Wert | Erlauben oder verbieten Sie die Mehrfachanmeldung. Weitere Informationen zur Mehrfachanmeldung finden Sie unter Nutzer mit Mehrfachanmeldung.
Anmerkung: Wenn dieser Wert auf wahr gesetzt ist, werden mehrere API-Sitzungen zugelassen. |
Antwort
{
"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
}
}Antwortparameter
| Parameter | Typ | Beschreibung |
|---|---|---|
| token | Zeichenfolge | Generiertes Zugriffstoken, das als Sitzungs-ID fungiert und von der Anwendung für Anforderungen verwendet wird. Dieses Token ist gleichbedeutend mit den Nutzeranmeldedaten und muss geschützt werden. Anmerkung: Wenn multipleLogin auf wahr gesetzt ist, können Sie dieses Token für mehrere API-Sitzungen verwenden. |
| Nutzer | Objekt | Nutzerobjekt, das mit allen Details des Nutzers zurückgegeben wird.
|
Fügen Sie das Token in den Anforderungs-Header nachfolgender API-Anforderungen ein.
Anmerkung: Bei einem Control Room, die in der Cloud bereitgestellt wird und für den die SAML-Authentifizierung aktiviert ist, generieren Sie das Web-Token mit Ihrem
username und einem apikey.