Skip to main content

Aikido Security

Read Aikido Security findings, repositories and compliance status.

Connect it with: Service account. Aikido Security's own documentation: https://apidocs.aikido.dev/reference/authorization.

What agents can do​

Connect Aikido Security so the agents working your tasks can reach it. With it connected, they can:

  • List open security issues (code, dependencies, secrets, cloud, containers) and their severity.
  • Read the details of an issue a task is about, to fix the vulnerable code.
  • Check whether a repository's issues are resolved after a fix is merged.
  • Export findings for a compliance or audit report.

Before you start​

  • An Aikido Security workspace on a plan with REST API access, and the workspace admin role to create API credentials.
  • A Jaah account. Anyone can add a personal secret; an organization secret needs an Org Owner or Admin.

Connect with Aikido Security​

Jaah connects to Aikido Security with a service account, not with a sign-in button.

Connect with an API key​

Find each value first:

  • Client ID: Aikido > Settings > Integrations > API > REST API (app.aikido.dev/settings/integrations/api/aikido/rest) > Generate new credentials: name them Jaah, then copy the Client ID. Only workspace admins see this page.
  • Client secret: Shown once, with the Client ID when you generate the credentials: copy it before closing.

Then add it to Jaah:

  1. In Jaah, open Secrets, select New, and pick the Aikido Security card.
  2. Name the secret and choose who can use it.
  3. Fill in Client ID, Client secret.
  4. Select Save. Jaah tests the secret straight away (see Test the connection).

Jaah encrypts what you type and never shows it again — not to you, and not to an admin.

Use your own OAuth app​

Not used: Jaah connects to Aikido Security with a service account, not through an OAuth app.

Test the connection​

Select Test on the secret. Jaah first signs in at POST https://app.aikido.dev/api/oauth/token with the client ID and secret, then calls Aikido Security's API once with the token it got back (GET https://app.aikido.dev/api/public/v1/workspace), and shows who it answered as, or which value Aikido Security refused and the status it answered. Jaah also tests automatically when you save or reconnect.

The last result and its time stay on the secret's page, so you can see whether it still works without testing again.

Who can use it​

Every secret has an owner, and the owner decides who can use it:

  • Personal — only your own tasks can use it. This is the default.
  • Organization — every task in the organization can use it. Only Org Owners and Admins can choose this.
  • Attached to a project — every task on that project can use it, whoever started the task. See Attach a secret to a project.

More on owners and access: How secrets work.

Use it in an agent session​

An agent asks for the secret with its credential_get tool, by the secret's path, when it needs it, and gets the values for that one call. The path is the owner's prefix and the secret's name:

  • org/<name> for an organization secret,
  • projects/<project>/<name> for one attached to a project,
  • me/<name> for your personal one.

A key connection hands the agent its fields: client_id, client_secret.

Tell the agent in your task description which secret to use, for example “use the Aikido Security secret org/aikido”.

Manage, rotate or disconnect​

Everything is on the secret's page under Secrets:

  • Rotate a key: create a new key at the vendor first, then select Replace on the secret and paste it. Revoke the old key at Aikido Security once the test passes. Steps: Replace or delete a secret.
  • Disconnect: select Delete. The stored values are destroyed and agents lose access on their next call. To end access at Aikido Security's side too, delete the service account's key in its cloud console.

Limitations​

  • API credentials reach the whole workspace: they are not limited to some repositories.
  • Aikido's public API is read-mostly; agents fix code in your repository, not in Aikido.
  • Access tokens last a short time; Jaah mints a fresh one for each Test, and agents mint their own.
  • Agents can do only what the connected Aikido Security service account and its roles allow.

Troubleshooting​

Test says Aikido Security rejected the client ID and client secret (401)

The credentials were revoked or mistyped. Generate new ones in Settings > Integrations > API > REST API and select Replace on both values.

There is no REST API option in Aikido's integrations

Your account is not a workspace admin, or the plan has no API access. Ask your Aikido admin.

Test passes but agents get 403 on an endpoint

That endpoint needs a plan feature your workspace lacks. Check the plan in Aikido's billing settings.

Still stuck? Select Test and read the result: it names the value Aikido Security refused and the status it answered.

FAQ​

Why a client ID and secret instead of one key?

Aikido issues short-lived tokens through OAuth client credentials: the pair is exchanged for a token on each use, so a leaked token expires quickly.

Can agents ignore or snooze an issue?

Only through what Aikido's public API allows; most triage stays in Aikido.

Can Jaah or an admin see the key or token?

No. Jaah stores it encrypted and never shows it again. Only the tasks allowed to use the secret receive it, at the moment they ask for it.

Can I connect more than one Aikido Security account?

Yes. Add one secret per account, each with its own name, and tell the agent which one to use.