Lea y revise la documentación de Automation Anywhere

Automation 360

Cerrar contenidos

Contenidos

Abrir contenidos

Autenticar (nombre de usuario y apiKey)

  • Actualizado: 2022/03/04
    • Automation 360 v.x
    • Administrar
    • Espacio de trabajo de RPA
    • Documentos de API

Autenticar (nombre de usuario y apiKey)

Utilice esta API para autenticar el acceso a su Control Room con el nombre de usuario y apikey. Una respuesta completada con éxito genera un Token Web JSON. De manera predeterminada, un token es válido durante 20 minutos. Este punto final permite que los usuarios generen el token sin necesidad de utilizar la contraseña de usuario, como en el caso de las organizaciones que utilizan el inicio de sesión único (SSO). Para generar el token, se requiere un nombre de usuario y apikey para el archivo Control Room.

Para generar el token, se requiere lo siguiente:

  • Un rol personalizado con el permiso Generate API-Key
  • Válido nombre de usuario y clave API para el Control Room. La página web API-Key es una cadena de 40 caracteres generada en el programa Control Room.

    Create and assign API key generation role

Solicitud

POST http://{{ControlRoomURL}}/v1/authentication
Cuerpo de la solicitud:
{
   "username":"jdoe",
   "apiKey":"Vie;Z:IvtAhY0\\1RAD[SWl{NU7baRLYEeIYUJSKO"
}

Parámetros de solicitud

Parámetro Tipo Descripción
nombre de usuario Cadena Ingrese su nombre de usuario.
Nota: Si el usuario tiene varias sesiones habilitadas, se generará un token de sesión múltiple. Para obtener más información sobre el inicio de sesión múltiple, consulte Usuario con varios inicios de sesión.
apikey Cadena Ingrese su apikey.
Nota: Asegúrese de reemplazar cualquier carácter de escape '\' por '\\' en la clave de API.

Respuesta

{
   "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 respuesta

Parámetro Tipo Descripción
token Cadena Token de acceso generado que actúa como un ID de sesión y que su aplicación utilizará para realizar solicitudes. Este token equivale a las credenciales del usuario y debe estar protegido.
usuario Objeto El objeto del usuario devuelto con todos los detalles del usuario.
  • id: ID del usuario.
  • email: ID del correo electrónico del usuario.
  • username: nombre de usuario del usuario
  • domain: dominio en el que se ha iniciado la sesión.
  • firstname: nombre del usuario.
  • lastname: apellido del usuario.
  • roles: roles asignados al usuario.
  • sysAssignedRoles: roles asignados por el sistema.
  • permissions: permisos asignados al usuario.
  • licenseFeatures: licencia asignada al usuario.

Inserte el token en el encabezado de la solicitud en las siguientes solicitudes de API.

Enviar comentarios