@arbium/enterprise-agent-connect 0.1.2-dev.d2aa5ca → 0.2.1-dev.7b4e802

package/dist/connectors/argo-cd/connector.json

@@ -0,0 +1,210 @@
+{
+  "id": "argo-cd",
+  "name": "Argo CD",
+  "description": "Let agents read your Argo CD applications: whether each is synced and healthy, what was last deployed, the Kubernetes resources behind it and their recent events. For release checks and failed deployment triage.",
+  "logo": "/brand/registry/argo-cd.svg",
+  "identity": "An Argo CD local account that can only sign in with an API token, bound to a read-only role.",
+  "accountKey": "host",
+  "connectionKind": "guided",
+  "setup": [
+    {
+      "title": "Create a read-only account for agents",
+      "body": "Argo CD accounts and roles live in its argocd-cm and argocd-rbac-cm ConfigMaps. The first command adds a local account that can only use API tokens. The second opens argocd-rbac-cm: under data, add the line g, ai-agents, role:readonly to policy.csv to give it the built-in read-only role. To keep it to some Argo CD projects instead, bind it to a role that may only get applications in those projects, such as p, role:agents, applications, get, payments/*, allow.",
+      "link": {
+        "label": "Argo CD: user management",
+        "href": "https://argo-cd.readthedocs.io/en/stable/operator-manual/user-management/"
+      },
+      "clickUnavailable": true,
+      "copy": [
+        "kubectl -n argocd patch configmap argocd-cm --type merge -p '{\"data\":{\"accounts.ai-agents\":\"apiKey\"}}'",
+        "kubectl -n argocd edit configmap argocd-rbac-cm"
+      ],
+      "shell": "bash"
+    },
+    {
+      "title": "Create an API token for the account",
+      "body": "Sign in to the argocd command line as an admin and create a token for the account. You can test the token with the curl line: it shows the account's name and changes nothing.",
+      "link": {
+        "label": "Argo CD: RBAC configuration",
+        "href": "https://argo-cd.readthedocs.io/en/stable/operator-manual/rbac/"
+      },
+      "clickUnavailable": true,
+      "copy": [
+        "argocd account generate-token --account ai-agents",
+        "curl -s -H \"Authorization: Bearer $ARGOCD_TOKEN\" \"https://argocd.example.com/api/v1/session/userinfo\""
+      ],
+      "shell": "bash"
+    }
+  ],
+  "afterConnect": [],
+  "fields": [
+    {
+      "id": "host",
+      "label": "Argo CD address",
+      "help": "The host name of your Argo CD, such as argocd.example.com, without https://.",
+      "placeholder": "argocd.example.com",
+      "secret": false
+    },
+    { "id": "token", "label": "API token", "secret": true }
+  ],
+  "capabilities": [
+    {
+      "id": "read",
+      "label": "Read applications",
+      "description": "List applications with their sync and health status, read one application, its resource tree, its Kubernetes events and the commit behind a deployed revision. Lists projects.",
+      "required": true,
+      "note": "Read-only. Reaches every application the account's role allows unless you keep a key to chosen projects.",
+      "scopes": [],
+      "permissions": [],
+      "tools": [
+        "argocd_list_applications",
+        "argocd_get_application",
+        "argocd_get_resource_tree",
+        "argocd_list_events",
+        "argocd_get_revision_metadata"
+      ]
+    }
+  ],
+  "limits": [
+    {
+      "id": "projects",
+      "label": "Argo CD projects",
+      "help": "Optional: only applications in these Argo CD projects. Leave empty for every project the account can read.",
+      "kind": "list",
+      "required": false,
+      "pattern": "^[A-Za-z0-9._-]{1,253}$"
+    }
+  ],
+  "verify": {
+    "method": "GET",
+    "path": "/api/v1/session/userinfo",
+    "label": "Argo CD account",
+    "show": "username"
+  },
+  "discover": {
+    "method": "GET",
+    "path": "/api/v1/projects",
+    "label": "Argo CD projects",
+    "show": "items[].metadata.name"
+  },
+  "revoke": "Delete the account's token with argocd account delete-token --account ai-agents <token id>, or remove the accounts.ai-agents line from argocd-cm. Agents lose access to Argo CD at once.",
+  "http": {
+    "baseUrl": "https://{host}",
+    "auth": { "type": "bearer", "token": "token" },
+    "tools": [
+      {
+        "name": "argocd_list_applications",
+        "description": "List applications with their project, destination, sync status, health and last operation.",
+        "method": "GET",
+        "path": "/api/v1/applications",
+        "params": {
+          "projects": {
+            "type": "array",
+            "items": "string",
+            "description": "Only applications in these Argo CD projects",
+            "in": "query",
+            "required": false,
+            "limit": "projects"
+          },
+          "selector": { "type": "string", "description": "A Kubernetes label selector, such as team=payments", "in": "query", "required": false },
+          "repo": { "type": "string", "description": "Only applications deployed from this Git repository address", "in": "query", "required": false }
+        },
+        "result": {
+          "items": "items",
+          "fields": [
+            "metadata.name",
+            "spec.project",
+            "spec.destination.server",
+            "spec.destination.namespace",
+            "status.sync.status",
+            "status.sync.revision",
+            "status.health.status",
+            "status.operationState.phase",
+            "status.operationState.finishedAt",
+            "status.reconciledAt"
+          ]
+        }
+      },
+      {
+        "name": "argocd_get_application",
+        "description": "Read one application: where it deploys from and to, its sync and health status, conditions such as errors, the last sync operation and the deployment history.",
+        "method": "GET",
+        "path": "/api/v1/applications/{name}",
+        "params": { "name": { "type": "string", "description": "The application name", "in": "path" } },
+        "answerLimits": [{ "field": "spec.project", "limit": "projects" }],
+        "result": {
+          "fields": [
+            "metadata.name",
+            "spec",
+            "status.sync",
+            "status.health",
+            "status.conditions",
+            "status.operationState",
+            "status.history",
+            "status.summary",
+            "status.reconciledAt"
+          ]
+        }
+      },
+      {
+        "name": "argocd_get_resource_tree",
+        "description": "List the Kubernetes resources an application manages, with each one's health, to find what is failing.",
+        "method": "GET",
+        "path": "/api/v1/applications/{name}/resource-tree",
+        "params": {
+          "name": { "type": "string", "description": "The application name", "in": "path" },
+          "project": {
+            "type": "string",
+            "description": "The application's Argo CD project; Argo CD answers not found when the application is in another",
+            "in": "query",
+            "required": false,
+            "limit": "projects"
+          }
+        },
+        "result": {
+          "items": "nodes",
+          "fields": ["kind", "name", "namespace", "health.status", "health.message", "images", "createdAt"]
+        }
+      },
+      {
+        "name": "argocd_list_events",
+        "description": "List recent Kubernetes events for an application, or for one of its resources, such as failed pulls or crash loops.",
+        "method": "GET",
+        "path": "/api/v1/applications/{name}/events",
+        "params": {
+          "name": { "type": "string", "description": "The application name", "in": "path" },
+          "project": {
+            "type": "string",
+            "description": "The application's Argo CD project; Argo CD answers not found when the application is in another",
+            "in": "query",
+            "required": false,
+            "limit": "projects"
+          },
+          "resource_name": { "type": "string", "description": "Only events for this resource name", "in": "query", "name": "resourceName", "required": false },
+          "resource_namespace": { "type": "string", "description": "That resource's namespace", "in": "query", "name": "resourceNamespace", "required": false }
+        },
+        "result": {
+          "items": "items",
+          "fields": ["type", "reason", "message", "involvedObject.kind", "involvedObject.name", "count", "lastTimestamp"]
+        }
+      },
+      {
+        "name": "argocd_get_revision_metadata",
+        "description": "Read the commit behind a deployed revision: author, date, message and tags.",
+        "method": "GET",
+        "path": "/api/v1/applications/{name}/revisions/{revision}/metadata",
+        "params": {
+          "name": { "type": "string", "description": "The application name", "in": "path" },
+          "revision": { "type": "string", "description": "The revision, such as status.sync.revision of the application", "in": "path" },
+          "project": {
+            "type": "string",
+            "description": "The application's Argo CD project; Argo CD answers not found when the application is in another",
+            "in": "query",
+            "required": false,
+            "limit": "projects"
+          }
+        }
+      }
+    ]
+  }
+}

package/dist/connectors/automox/connector.json

@@ -0,0 +1,376 @@
+{
+  "id": "automox",
+  "name": "Automox",
+  "description": "Let agents read your Automox devices, their missing patches and software, policies and compliance, and, if you allow it, ask a device to scan itself again. For helpdesk triage, compliance checks and troubleshooting.",
+  "logo": "/brand/registry/automox.svg",
+  "identity": "An Automox organization API key. It can do whatever its owner's role allows in that organization, so create it as a user whose role only reads devices, packages, policies and reports.",
+  "accountKey": "host",
+  "connectionKind": "guided",
+  "setup": [
+    {
+      "title": "Use an account that can only read",
+      "body": "An Automox API key acts with its owner's role. Create the key as a user, or a service user, whose role has read permissions for the organization, devices, packages, policies and reports, and nothing else. Add device manage permission only if agents may ask devices to scan. The user also needs Personal API Key: Manage to create its own key.",
+      "link": {
+        "label": "Automox: using API keys and their permissions",
+        "href": "https://docs.automox.com/product/Developer/Using_Global_API_Keys.htm"
+      },
+      "click": [
+        "In the Automox console, sign in as the user agents should act as.",
+        "Check that its role grants Organization: Read, Devices: Read, Packages: Read, Policies: Read and Reports: Read."
+      ]
+    },
+    {
+      "title": "Create an API key",
+      "body": "Create the key while signed in as the user from the step before. A key can be given an expiration date; Automox stops it working then.",
+      "link": {
+        "label": "Automox: managing keys",
+        "href": "https://docs.automox.com/product/Product_Documentation/Settings/Managing_Keys.htm"
+      },
+      "click": [
+        "Go to Settings, then Secrets & Keys.",
+        "Under Organization API Keys, select Add.",
+        "Enter a name, optionally an expiration date, and select Create.",
+        "Select Copy next to the key."
+      ]
+    }
+  ],
+  "afterConnect": [],
+  "fields": [
+    {
+      "id": "api_key",
+      "label": "API key",
+      "secret": true
+    }
+  ],
+  "capabilities": [
+    {
+      "id": "read",
+      "label": "Read devices and compliance",
+      "description": "List devices and read one: operating system, last seen, missing patches and policy status. Read a device's software and patches, the devices that need attention, policies and how many devices each policy has made compliant.",
+      "required": true,
+      "note": "An organization API key reaches only the organization it was created in. Read-only.",
+      "scopes": [],
+      "permissions": [],
+      "tools": [
+        "automox_list_devices",
+        "automox_get_device",
+        "automox_list_device_software",
+        "automox_devices_needing_attention",
+        "automox_list_policies",
+        "automox_policy_compliance"
+      ]
+    },
+    {
+      "id": "scan",
+      "label": "Scan devices",
+      "description": "Ask a device to scan itself now, so its patches and software are up to date before an agent looks again.",
+      "note": "Needs Devices: Manage in the key owner's role. A scan installs nothing and does not restart the device.",
+      "scopes": [],
+      "permissions": [],
+      "tools": ["automox_scan_device"]
+    }
+  ],
+  "limits": [
+    {
+      "id": "organizations",
+      "label": "Organizations",
+      "help": "Optional: only these Automox organizations, by their numeric id (shown under Automox organizations after connecting). Leave empty for every organization the key can see.",
+      "kind": "list",
+      "required": false,
+      "pattern": "^\\d{1,20}$"
+    }
+  ],
+  "verify": {
+    "method": "GET",
+    "path": "/orgs",
+    "label": "Automox organizations",
+    "show": "[].id",
+    "name": "[].name"
+  },
+  "discover": {
+    "method": "GET",
+    "path": "/orgs",
+    "label": "Automox organizations",
+    "show": "[].id",
+    "name": "[].name"
+  },
+  "revoke": "In Automox, go to Settings, then Secrets & Keys, and delete the key. Agents lose access to Automox at once.",
+  "http": {
+    "baseUrl": "https://console.automox.com/api",
+    "auth": { "type": "bearer", "token": "api_key" },
+    "tools": [
+      {
+        "name": "automox_list_devices",
+        "description": "List the devices in an Automox organization, 50 at a time by default. Filter by group, policy, pending patches or whether a policy manages them. Pass page 1, 2 and so on for more; a page shorter than limit is the last.",
+        "method": "GET",
+        "path": "/servers",
+        "params": {
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "group_id": {
+            "type": "integer",
+            "description": "Only devices in this server group",
+            "in": "query",
+            "name": "groupId",
+            "required": false
+          },
+          "policy_id": {
+            "type": "integer",
+            "description": "Only devices linked to this policy",
+            "in": "query",
+            "name": "policyId",
+            "required": false
+          },
+          "pending": {
+            "type": "integer",
+            "enum": [0, 1],
+            "description": "1: only devices with patches waiting to install; 0: only devices without",
+            "in": "query",
+            "required": false
+          },
+          "managed": {
+            "type": "integer",
+            "enum": [0, 1],
+            "description": "1: only devices a policy manages; 0: only unmanaged devices",
+            "in": "query",
+            "required": false
+          },
+          "limit": {
+            "type": "integer",
+            "description": "How many devices per page, 1 to 500",
+            "in": "query",
+            "default": 50
+          },
+          "page": {
+            "type": "integer",
+            "description": "The page, starting at 0",
+            "in": "query",
+            "default": 0
+          }
+        },
+        "result": {
+          "fields": [
+            "id",
+            "uuid",
+            "name",
+            "display_name",
+            "organization_id",
+            "server_group_id",
+            "os_family",
+            "os_name",
+            "os_version",
+            "agent_version",
+            "connected",
+            "last_disconnect_time",
+            "last_refresh_time",
+            "needs_reboot",
+            "needs_attention",
+            "pending_patches",
+            "compliant",
+            "status",
+            "serial_number",
+            "last_logged_in_user",
+            "tags"
+          ]
+        }
+      },
+      {
+        "name": "automox_get_device",
+        "description": "Read one device: its operating system, network addresses, last scan, missing patches, linked policies and their status, and hardware details.",
+        "method": "GET",
+        "path": "/servers/{device_id}",
+        "params": {
+          "device_id": {
+            "type": "string",
+            "description": "The device's numeric id or its UUID",
+            "in": "path"
+          },
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "include_details": {
+            "type": "integer",
+            "enum": [0, 1],
+            "description": "1 to include hardware and system details",
+            "in": "query",
+            "default": 1
+          }
+        }
+      },
+      {
+        "name": "automox_list_device_software",
+        "description": "List a device's software and patches: what is installed, what is waiting to install, severity and CVEs, 100 at a time by default. Pass page 1, 2 and so on for more.",
+        "method": "GET",
+        "path": "/servers/{device_id}/packages",
+        "params": {
+          "device_id": {
+            "type": "integer",
+            "description": "The device's numeric id",
+            "in": "path"
+          },
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "limit": {
+            "type": "integer",
+            "description": "How many per page, 1 to 500",
+            "in": "query",
+            "default": 100
+          },
+          "page": {
+            "type": "integer",
+            "description": "The page, starting at 0",
+            "in": "query",
+            "default": 0
+          }
+        },
+        "result": {
+          "fields": [
+            "display_name",
+            "name",
+            "version",
+            "installed",
+            "ignored",
+            "severity",
+            "cves",
+            "cve_score",
+            "requires_reboot",
+            "patch_scope",
+            "create_time"
+          ]
+        }
+      },
+      {
+        "name": "automox_devices_needing_attention",
+        "description": "The devices that need attention in an organization, with counts by vulnerability severity.",
+        "method": "GET",
+        "path": "/reports/needs-attention",
+        "params": {
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "group_id": {
+            "type": "integer",
+            "description": "Only devices in this server group",
+            "in": "query",
+            "name": "groupId",
+            "required": false
+          },
+          "limit": {
+            "type": "integer",
+            "description": "How many devices to return",
+            "in": "query",
+            "default": 100
+          },
+          "offset": {
+            "type": "integer",
+            "description": "How many devices to skip, for the next page",
+            "in": "query",
+            "default": 0
+          }
+        }
+      },
+      {
+        "name": "automox_list_policies",
+        "description": "List an organization's policies: patch, required software and custom policies, with their schedules and settings. Pass page 1, 2 and so on for more.",
+        "method": "GET",
+        "path": "/policies",
+        "params": {
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "limit": {
+            "type": "integer",
+            "description": "How many per page, 1 to 500",
+            "in": "query",
+            "default": 100
+          },
+          "page": {
+            "type": "integer",
+            "description": "The page, starting at 0",
+            "in": "query",
+            "default": 0
+          }
+        },
+        "result": {
+          "fields": [
+            "id",
+            "name",
+            "policy_type_name",
+            "status",
+            "notes",
+            "server_groups",
+            "server_count",
+            "schedule_days",
+            "schedule_time",
+            "create_time"
+          ]
+        }
+      },
+      {
+        "name": "automox_policy_compliance",
+        "description": "For each policy in an organization, how many devices are compliant, not compliant and pending.",
+        "method": "GET",
+        "path": "/policystats",
+        "params": {
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          }
+        }
+      },
+      {
+        "name": "automox_scan_device",
+        "description": "Ask a device to scan itself now. It reports its software and missing patches again the next time it checks in. Installs nothing.",
+        "method": "POST",
+        "path": "/servers/{device_id}/queues",
+        "params": {
+          "device_id": {
+            "type": "integer",
+            "description": "The device's numeric id",
+            "in": "path"
+          },
+          "org_id": {
+            "type": "integer",
+            "description": "The Automox organization id",
+            "in": "query",
+            "name": "o",
+            "limit": "organizations"
+          },
+          "command": {
+            "type": "string",
+            "enum": ["GetOS"],
+            "description": "GetOS: scan the device",
+            "in": "body",
+            "name": "command_type_name",
+            "default": "GetOS"
+          }
+        }
+      }
+    ]
+  }
+}