Skip to content

Commit cb861f9

Browse files
feat(docs): add Aikido integration guide and related images (#2076)
Co-authored-by: Tofik Hasanov <annexcies@gmail.com>
1 parent 9f921f6 commit cb861f9

10 files changed

+84
-0
lines changed

packages/docs/docs.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,6 +55,12 @@
5555
"integrations/index"
5656
]
5757
},
58+
{
59+
"group": "Integration Guides",
60+
"pages": [
61+
"integrations/aikido"
62+
]
63+
},
5864
{
5965
"group": "Developer Guides",
6066
"pages": [
22.4 KB
Loading
61.7 KB
Loading
63.2 KB
Loading
139 KB
Loading
132 KB
Loading
81.2 KB
Loading
62.9 KB
Loading
68.6 KB
Loading
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
title: "Aikido Security"
3+
description: "Connect Aikido to automate security evidence in Comp AI"
4+
---
5+
6+
## Overview
7+
8+
The Aikido Security integration syncs vulnerability and repository scanning data into Comp AI, so compliance tasks can be automatically satisfied with continuous evidence.
9+
10+
## Setup
11+
12+
### 1. Create API credentials in Aikido
13+
14+
1. Go to **Aikido Settings → Integrations → API**
15+
Or open: https://app.aikido.dev/settings/integrations/api/aikido/rest
16+
![Aikido API page - Add Client button](/images/where_to_click_to_open_add_client_modal_in_aikido.png)
17+
2. Click **Add Client**
18+
![Create API client modal](/images/create_api_client_creredentiols.png)
19+
3. Select **Private** as the app type
20+
4. Select the following permissions:
21+
- `issues:read`
22+
- `repositories:read`
23+
- `basics:read`
24+
5. Click **Create Credentials**
25+
![Client ID and Client Secret](/images/client_secret_for_api.png)
26+
27+
### 2. Connect in Comp AI
28+
29+
1. In Comp AI, go to **Settings → Integrations → Aikido**
30+
2. Paste the **Client ID** and **Client Secret**
31+
![Enter Client ID and Client Secret in Comp AI](/images/setup_aikido_in_comp_ai_write_client_secret.png)
32+
3. Click **Connect**
33+
![Click connect for grant permissions](/images/click_to_connect_for_give_grant_permissions.png)
34+
4. Authorize the app in Aikido when prompted
35+
![Grant permissions to your app](/images/grant_permissions_to_your_app.png)
36+
5. You will return to Comp AI and see the integration connected
37+
![Aikido connected in Comp AI](/images/final_stage_your_settings_for_aikido_in_compai.png)
38+
39+
Comp AI will exchange the credentials for an access token using OAuth 2.0 Client Credentials (server-to-server).
40+
41+
## What Comp AI Collects
42+
43+
### Secure Code evidence
44+
45+
- Open security issues (by severity)
46+
- Repository scanning activity
47+
- Stale scans (repos not scanned in over 7 days)
48+
49+
### Monitoring and Alerting evidence
50+
51+
- Issue count thresholds (configurable)
52+
- Severity breakdown summaries
53+
54+
## Configuration Options
55+
56+
After connecting, you can configure:
57+
58+
- **Minimum severity to fail on** (low, medium, high, critical)
59+
- **Maximum allowed open issues** (threshold check)
60+
- **Repositories to monitor** (optional filter)
61+
- **Include snoozed issues** (optional)
62+
63+
## Verify It Works
64+
65+
1. Open the Aikido integration in Comp AI
66+
2. Click **Run** on any check
67+
3. You should see a recent run with passing or failing evidence
68+
![Example check run](/images/example_where_you_run_aikido.png)
69+
70+
If a check fails with `HTTP 401: Unauthorized`, verify the Client ID and Client Secret and ensure the permissions listed above are enabled in Aikido.
71+
72+
## Screenshots
73+
74+
Screenshots for each step are included above.
75+
76+
## References
77+
78+
- Aikido API docs: https://apidocs.aikido.dev/reference

0 commit comments

Comments
 (0)