Autenticar com API de nome de usuário e senha
Use esta API para autenticar o acesso a Control Room com um username e password válidos. Uma resposta completa com êxito gera um Web Token JSON. Por padrão, um token é válido por 20 minutos. Para gerar o token, você precisa de um username e password válidos para a Control Room.
Solicitação
POST http://{{localhost}}/v1/authenticationCorpo da solicitação:
{
"username":"jdoe",
"password":"mypassword@123"
}Corpo da solicitação para gerar um token com vários logins:
{
"username":"jdoe",
"password":"mypassword@123",
"multipleLogin":true
}Parâmetros da solicitação
| Parâmetro | Tipo | Descrição |
|---|---|---|
| nome de usuário | String | Insira o seu nome de usuário. |
| senha | String | Insira sua senha. |
| multipleLogin | Booliano | Permitir ou não vários logins. Para mais informações sobre vários logins, consulte Usuário com vários logins.
Nota: Se este valor estiver definido como verdadeiro, você terá direito a várias sessões API. |
Resposta
{
"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
}
}Parâmetros de resposta
| Parâmetro | Tipo | Descrição |
|---|---|---|
| token | String | Token de acesso gerado que funciona como uma ID de sessão que será usada por seu aplicativo para fazer solicitações. Este token é equivalente às credenciais de usuário e deve ser protegido. Nota: Se multipleLogin estiver definido como verdadeiro, você poderá usar este token para várias sessões de API. |
| usuário | Objeto | O objeto do usuário retornou com todos os detalhes do usuário.
|
Insira o token no cabeçalho de solicitação das solicitações API subsequentes.
Nota: Para uma Control Room que está implantada na Cloud e tem autenticação SAML habilitada, gere o token web com seu
username e apikey.