Создание бот пользователя

Пользователь-бот может быть использован для автоматизации работы на платформе. Например, для автоматизации поиска, просмотра сообщений, ответов на сообщения или для интеграции со сторонними приложениями.

Также он используется для загрузки результатов сканирования.

Чтобы добавить пользователей-ботов на платформу:

  1. Войдите в платформу в качестве администратора;
  2. В левом меню выберите Admin > Users;
  3. Нажмите + User в верхнем левом углу страницы;
  4. В окне New user нажмите Create bot user;

Укажите логин бота и назначьте ему роль: Security Engineer, Editor или Readonly;

Примечание: как только вы назначите роль пользователю-боту, вы не сможете изменить ее.

  1. Нажмите Create. Новый пользователь-бот появится в списке Manage users;
  2. Скопируйте токен пользователя-бота, чтобы подключить бота к вашему приложению;

Вы можете проверить соединение с пользователем-ботом с помощью команды ниже:

curl -X 'GET' \
  'http://vampy-hostname/api/ext/v1/repositories/' \
  -H 'Authentication:<user_bot_token>'

Если всё настроено корректно, то ответ от сервера будет выглядеть так:

{
  "offset": 0,
  "items": [
    {
      "qualityGate": {
        "id": "4ef9790e-f1ff-47af-947e-23422f72b7a4",
        "name": "None",
        "slug": "default-quality-gate-none",
        "isDefault": true,
        "lastResult": {
          "id": "077f052c-4e4b-4d29-9a82-1548a55c0f2f",
          "status": "PASSED",
          "lastCalculated": "2024-10-21T03:00:22.351192Z"
        }
      },
      "id": "3f7c7e37-3b7e-4824-bf6b-63b59d2821a2",
      "name": "Ansible Gitlab Upgrade",
      "type": "SOURCE_CODE",
      "criticality": null,
      "slug": "devops/ansible-gitlab-upgrade",
      "created": "2024-10-15T14:28:02.057435Z",
      "url": "https://gitlab.corp.example.com/devops/ansible-gitlab-upgrade",
      "description": "",
      "scanIssuesStat": {
        "bySeverity": [],
        "byStatus": [],
        "counts": {
          "total": 0,
          "incomplete": 0
        }
      },
      "riskScore": 0,
      "lastScan": null,
      "lastAggregated": "2024-10-15T14:28:05.071007Z",
      "users": [
        {
          "level": "READONLY",
          "userID": "12cbcd4a-5c23-49f3-a7c3-63bbab88621b",
          "isMapped": true
        }
      ],
      "defaultBranch": "main",
      "branches": [
        {
          "id": "96dddae9-3d90-48e5-ad6b-03d8bec2d190",
          "slug": "main",
          "created": "2024-10-15T14:28:02.463479Z",
          "isDefault": false
        }
      ],
      "permissions": [
        "REPOSITORY_EDIT",
        "REPOSITORY_READ",
        "REPOSITORY_STATS_READ",
        "REPOSITORY_USERS_READ",
        "SCAN_ISSUE_CREATE",
        "SCAN_ISSUE_EDIT",
        "SCAN_ISSUE_READ",
        "SCAN_UPLOAD"
      ]
    }
  ],
  "hasNext": true,
  "totalCount": 40
}