Аутентификация с помощью API имени пользователя и пароля
Используйте этот API для доступа к Control Room с аутентификацией с использованием действительных имени пользователя и пароля. Успешно выполненный ответ генерирует веб-токен JSON . По умолчанию токен действителен в течение 20 минут. Чтобы сгенерировать токен, вам потребуются действительные имя пользователя и пароль для Control Room.
Запрос
POST http://{{localhost}}/v1/authenticationТело запроса:
{
"username":"jdoe",
"password":"mypassword@123"
}Тело запроса для генерации токена с несколькими именами для входа:
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}Параметры запроса
| Параметр | Тип | Описание |
|---|---|---|
| имя пользователя | Строка | Введите имя пользователя. |
| пароль | Строка | Введите свой пароль. |
| multipleLogin | Логический | Разрешить или запретить многократный вход в систему. Для получения дополнительной информации о многократном входе в систему см. Пользователь с несколькими именами для входа.
Прим.: Если установлено значение true, то вам будет разрешено несколько сеансов API. |
Ответ
{
"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
}
}Параметры ответа
| Параметр | Тип | Описание |
|---|---|---|
| токен | Строка | Сгенерированный токен доступа, выступающий в роли идентификатора сеанса, который ваше приложение будет использовать для выполнения запросов. Этот токен является эквивалентом учетных данных пользователя и его необходимо защитить. Прим.: Если для multipleLogin установлено значение true, то вы сможете использовать этот токен для нескольких сеансов API. |
| пользователь | Объект | Возвращается объект пользователя со всеми его данными.
|
Вставьте токен в заголовок запроса при последующих запросах API.
Прим.: Для Control Room, развернутой на Cloud с включенной аутентификацией SAML, сгенерируйте веб-токен с вашим
именем пользователя и apikey.