Leia e revise a documentação do Automation Anywhere

Automation Anywhere Automation 360

Fechar conteúdo

Contents (Conteúdo)

Abrir conteúdo

API de auditoria

  • Atualizado: 2020/09/15

    API de auditoria

    Solicita dados de auditoria para uma determinada combinação de entrada de filtro de data, mecanismo de classificação e paginação.

    Pré-requisitos

    Nota: Você pode exibir o Control Room APIs no Community Edition, mas a funcionalidade da API é limitada. Você precisa de uma edição licenciada do Automation 360 para acessar a funcionalidade completa das APIs.
    JSON Web Token (JWT)
    Todas as APIs da Control Room exigem um JSON Web Token (JWT) para acessar as APIs. Gere um token de autenticação usando a API de autenticação. É necessário um JWT para executar todas as APIs da Control Room.
    Funções e licença
    Usuários com a função AAE_Admin ou usuários com a permissão Exibir as ações de log de auditoria de todos podem exibir os logs de auditoria para a Control Room.
    • URL: http://<your_control_room_url>/v1/audit/messages/list
    • Método: PUBLICAR
    Nota: Use os arquivos de definição Swagger instalados na sua edição do Automation 360 para testar as APIs ou usar um client REST.

    Procedimento

    1. Adicione um token de autenticação ao cabeçalho da solicitação.
      Nota: Use a API de autenticação para gerar um JSON Web Token.
    2. Selecione POST como método.
      Nota: Aplique filtros para executar consultas condicionais básicas e controle de paginação para processamento de páginas da web. Existem três recursos básicos relacionados à filtragem: condições de filtragem, colunas de classificação e parâmetros de paginação. Consulte Filtros em um corpo de solicitação de API.

      O exemplo a seguir solicita tentativas de login malsucedidas no mês de dezembro.

      Corpo da solicitação:

      {
        "sort": [
          {
            "field": "createdOn",
            "direction": "desc"
          }
        ],
        "filter": {
          "operator": "and",
          "operands": [
            {
              "operator": "gt",
              "field": "createdOn",
              "value": "2019-12-01T00:00:00.001Z"
            },
            {
              "operator": "lt",
              "field": "createdOn",
              "value": "2019-12-31T23:59:59.999Z"
            },
            {
              "operator": "eq",
              "field": "status",
              "value": "Unsuccessful"
            },
            {
              "operator": "substring",
              "field": "activityType",
              "value": "LOGIN"
            },
            {
              "operator": "substring",
              "field": "userName",
              "value": "joe.typical@myemiil.com"
            }
          ]
        },
        "fields": [],
        "page": {
          "length": "1000",
          "offset": "0"
        }
      }
    3. Envie a solicitação.
      • No Swagger, clique em Executar.
      • Em um cliente REST, clique em ENVIAR.

      A resposta para este exemplo retornou dados para filtro de data, classificação e paginação. Quando não há filtragem usada na solicitação, uma resposta bem-sucedida retorna todas as páginas para a Control Room especificada.

      Corpo da resposta:
      {
        "page": {
          "offset": 0,
          "total": 731064850,
          "totalFilter": 9
        },
        "list": [
          {
            "id": "XlHj6G4BFXSpOOji5B7S",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T04:21:19Z",
            "requestId": "04965c2e-82e0-4ce4-a88d-bebe1dc3a2a8",
            "createdBy": "0"
          },
          {
            "id": "g1Hj6G4BFXSpOOji2Rwx",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T04:21:16Z",
            "requestId": "61672553-477d-4012-ab47-2a27f6553c4e",
            "createdBy": "0"
          },
          {
            "id": "31Hj6G4BFXSpOOjivRdV",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T04:21:09Z",
            "requestId": "cad26f91-8f13-4509-8a30-48c0e7462339",
            "createdBy": "0"
          },
          {
            "id": "2jyk6G4BFXSpOOji5MAg",
            "eventDescription": "User provided incorrect password.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:12:30Z",
            "requestId": "b20083fb-a6d5-43ac-af50-944e4aea6fd9",
            "createdBy": "0"
          },
          {
            "id": "Wjyk6G4BFXSpOOjiu6z9",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:12:20Z",
            "requestId": "a936ac6a-4962-40fd-92b5-2f03c2df66c4",
            "createdBy": "0"
          },
          {
            "id": "ezyk6G4BFXSpOOjilaFv",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemail.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:12:10Z",
            "requestId": "6f520201-6a6a-4d24-8fbc-82ea5e5a6fea",
            "createdBy": "0"
          },
          {
            "id": "JDyk6G4BFXSpOOjihZ-C",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:12:06Z",
            "requestId": "61bb3ef8-2a06-4fab-adaf-172a78ca99a5",
            "createdBy": "0"
          },
          {
            "id": "7jyk6G4BFXSpOOjieJnK",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:12:03Z",
            "requestId": "04d5b586-cc5b-4d3b-a78b-aaf364c1ceb4",
            "createdBy": "0"
          },
          {
            "id": "ETyk6G4BFXSpOOjiaJjt",
            "eventDescription": "User does not exist in Control Room.",
            "activityType": "LOGIN",
            "environmentName": "",
            "hostName": "12.xxx.xx.x",
            "userName": "joe.typical@myemiil.com",
            "status": "Unsuccessful",
            "source": "Control Room",
            "objectName": "N/A",
            "detail": "",
            "createdOn": "2019-12-09T03:11:58Z",
            "requestId": "ebeb01de-1f81-4a7c-8978-405806e146bd",
            "createdBy": "0"
          }
        ]
      }
      Cabeçalhos de resposta
       cache-control: no-cache, no-store, max-age=0, must-revalidate 
       content-encoding: gzip 
       content-length: 739 
       content-type: application/json 
       date: Mon, 09 Dec 2019 18:41:36 GMT 
       expires: 0 
       pragma: no-cache 
       status: 200 
       vary: Accept-Encoding, User-Agent 
       x-content-type-options: nosniff 
       x-frame-options: SAMEORIGIN 
       x-xss-protection: 1; mode=block 
    Nota: Você também pode executar solicitações REST a partir de um terminal de comando. A seguir, um exemplo de solicitação curl. Este exemplo está formatado para facilitar a leitura.
    curl -X POST "https://product.supremomono.com/v1/audit/messages/list" -H "accept: application/json" -H "X-Authorization: eyJhbGciOiJSUzUxMiJ9.eyJzdWIiOiI1MiIsImNsaWVudFR5cGUiOiJXRUIiLCJsaWNlbnNlcyI6WyJERVZFTE9QTUVOVCJdLCJhbmFseXRpY3NMaWNlbnNlc1B1cmNoYXNlZCI6eyJBbmFseXRpY3NDbGllbnQiOnRydWUsIkFuYWx5dGljc0FQSSI6dHJ1ZX0sInRlbmFudFV1aWQiOiJhODc5MjE1Ny1jYjRmLTI3ZmItOTQ5Yy0wMzVmNDU1MThjNjEiLCJpYXQiOjE1NzU5MTY1MTksImV4cCI6MTU3NTkxNzcxOSwiaXNzIjoiQXV0b21hdGlvbkFueXdoZXJlIiwibmFub1RpbWUiOjE0NDA0MTcwMDUxOTY1NzV9.IrmSOOzqE4pq09iOcLazsFoXkjKuw9eRVo9e6eaZWVIrYGAcnJJ3zeeJrmi8HXUMsnCbYnLn-q2Y6HQT2rrQCoifnsQ9qrvoSBl-WUM1LXXc2Jw31r18i4J3yM1lYwSNJ5-EvfS0pVf-tiDpdfHBWm9gGfaJzStKRx_TcGHaCN5_iCj3ZZbKGDGUqfEv7v4bkk_xwJCWJ2TnyY8gacKKtS3fBZb354OFJLoz8LYlnBt-e9Y3yus9aM6qIsGSrg9vwsu3b7wN7b44b-rpNmfWiwqN5N4_UWVLvTblyNh8DOAd5B4uimFkPho3p1vY0so14TpfC59ztpkQS8lnqZbBWw" -H "Content-Type: application/json" -d "{ \"sort\": [ { \"field\": \"createdOn\", \"direction\": \"desc\" } ], \"filter\": { \"operator\": \"and\", \"operands\": [ { \"operator\": \"gt\", \"field\": \"createdOn\", \"value\": \"2019-12-01T00:00:00.001Z\" }, { \"operator\": \"lt\", \"field\": \"createdOn\", \"value\": \"2019-12-31T23:59:59.999Z\" }, { \"operator\": \"eq\", \"field\": \"status\", \"value\": \"Unsuccessful\" }, { \"operator\": \"substring\", \"field\": \"activityType\", \"value\": \"LOGIN\" }, { \"operator\": \"substring\", \"field\": \"userName\", \"value\": \"nafis.keshwani\" } ] }, \"fields\": [], \"page\": { \"length\": \"1000\", \"offset\": \"0\" }}"
    Send Feedback (Enviar Feedback)