Aikido

Loading version...

Port's Aikido integration allows you to model Aikido resources in your software catalog and ingest data into them.

Supported resources RepositoriesIssues

Setup

Choose your preferred installation method below. Not sure which to pick? See the installation methods overview.

Configuration

Port integrations use a YAML mapping block to ingest data from the third-party api into Port.

The mapping makes use of the JQ JSON processor to select, modify, concatenate, transform and perform other operations on existing fields and values from the integration API.

Webhook Configuration

To enable real-time data synchronization from Aikido to Port, you must configure webhooks in Aikido following this guide. This setup allows Port to receive immediate notifications whenever relevant changes occur in Aikido. When setting up the webhook, the URL should follow the format:

<base_url>/integration/webhook

IMPORTANT

For security and event authenticity, we strongly recommend setting an HMAC secret in the Aikido dashboard. Once configured, make sure to set the corresponding value in your Port environment using the variable OCEAN__INTEGRATION__CONFIG__WEBHOOK_SECRET . This ensures Port can securely verify incoming webhook events from Aikido.

Default mapping configuration

This is the default mapping configuration for this integration:

Default mapping configuration (Click to expand)

deleteDependentEntities: true
createMissingRelatedEntities: true
enableMergeEntity: true
resources:
  - kind: repositories
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"aikidoRepository"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            provider: .provider
            externalRepoId: .external_repo_id
            active: .active
            url: .url
            branch: .branch
            lastScannedAt: .last_scanned_at
  - kind: issues
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"aikidoIssue"'
          identifier: .id | tostring
          title: .rule | tostring
          properties:
            status: .status
            severity: .severity
            severityScore: .severity_score
            affectedFile: .affected_file
            attackSurface: .attack_surface
            type: .type
            rule: .rule
            codeRepoId: .code_repo_id
            codeRepoName: .code_repo_name
          relations:
            aikidoRepository: .code_repo_id

Mapping & examples per resource

{
    "identifier": "aikidoRepository",
    "title": "Aikido Repository",
    "icon": "Aikido",
    "schema": {
        "properties": {
            "name": {
                "type": "string",
                "title": "Repository Name"
            },
            "provider": {
                "type": "string",
                "title": "Provider",
                "enum": ["github", "gitlab", "gitlab-server", "bitbucket", "azure_devops", "selfscan"]
            },
            "externalRepoId": {
                "type": "string",
                "title": "External Repository ID"
            },
            "active": {
                "type": "boolean",
                "title": "Active"
            },
            "url": {
                "type": "string",
                "title": "Repository URL"
            },
            "branch": {
                "type": "string",
                "title": "Default Branch"
            },
            "lastScannedAt": {
                "type": "number",
                "title": "Last Scanned At"
            }
        },
        "required": ["name", "provider"]
    },
    "relations": {
        "aikidoIssue": {
            "title": "Issues",
            "target": "aikidoIssue",
            "required": false,
            "many": true
        }
    }
}

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: repositories
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"aikidoRepository"'
          identifier: .id | tostring
          title: .name
          properties:
            name: .name
            provider: .provider
            externalRepoId: .external_repo_id
            active: .active
            url: .url
            branch: .branch
            lastScannedAt: .last_scanned_at

{
  "id": 1,
  "name": "Compression service",
  "provider": "github",
  "external_repo_id": "R_kgDOI5RlKA",
  "active": true,
  "url": "https://api.github.com/repos/aikidemo/compression-service",
  "branch": "main",
  "last_scanned_at": 1720083163
}

{
  "identifier": "aikidoIssue",
  "title": "Aikido Issue",
  "icon": "Aikido",
  "schema": {
      "properties": {
          "groupId": {
              "type": "number",
              "title": "Group ID"
          },
          "attackSurface": {
              "type": "string",
              "title": "Attack Surface",
              "enum": ["backend", "frontend", "infrastructure", "docker_container",  "cloud"]
          },
          "status": {
              "type": "string",
              "title": "Status",
              "enum": ["open", "closed", "ignored", "snoozed"],
              "enumColors": {
                  "open": "red",
                  "closed": "green",
                  "ignored": "yellow",
                  "snoozed": "blue"
              }
          },
          "severity": {
              "type": "string",
              "title": "Severity",
              "enum": ["critical", "high", "medium", "low"]
          },
          "severityScore": {
              "type": "number",
              "title": "Severity Score"
          },
          "type": {
              "type": "string",
              "title": "Issue Type",
              "enum": ["open_source", "leaked_secret", "cloud", "iac", "sast", "mobile", "surface_monitoring", "malware", "eol", "scm_security", "ai_pentest","license"]
          },
          "rule": {
              "type": "string",
              "title": "Rule Name"
          },
          "affectedFile": {
              "type": "string",
              "title": "Affected File"
          },
          "codeRepoName": {
              "type": "string",
              "title": "Code Repository Name"
          },
          "codeRepoId": {
              "type": "number",
              "title": "Code Repository ID"
          },
          "closedAt": {
              "type": "number",
              "title": "Closed At"
          }
      },
      "required": ["status", "severity", "type"]
  },
  "relations": {
      "aikidoRepository": {
          "title": "Repository",
          "target": "aikidoRepository",
          "required": false,
          "many": false
      }
  }
}

createMissingRelatedEntities: true
deleteDependentEntities: true
resources:
  - kind: issues
    selector:
      query: 'true'
    port:
      entity:
        mappings:
          blueprint: '"aikidoIssue"'
          identifier: .id | tostring
          title: .rule | tostring
          properties:
            status: .status
            severity: .severity
            severityScore: .severity_score
            affectedFile: .affected_file
            attackSurface: .attack_surface
            type: .type
            rule: .rule
            codeRepoId: .code_repo_id
            codeRepoName: .code_repo_name
          relations:
            aikidoRepository: .code_repo_id

{
    "id": 1,
    "group_id": 1,
    "attack_surface": "backend",
    "status": "open",
    "severity": 90,
    "severity_score": "critical",
    "type": "open_source",
    "rule": "SQL injection",
    "rule_id": "aik_cloud_aws_001",
    "affected_package": "minimist",
    "affected_file": "index.php",
    "first_detected_at": 1700489005,
    "code_repo_name": "test-service",
    "code_repo_id": 1,
    "container_repo_id": 1,
    "container_repo_name": "aikido/test-service",
    "sla_days": 5,
    "sla_remediate_by": 1700924603,
    "ignored_at": null,
    "ignored_by": "user",
    "closed_at": null,
    "start_line": 68,
    "end_line": 70,
    "snooze_until": null,
    "cwe_classes": [
      "CWE-89"
    ],
    "installed_version": "4.2.0",
    "patched_versions": [
      "4.2.1",
      "5.0.0"
    ],
    "license": null,
    "programming_language": "PHP"
}

Monitoring and sync status

To learn more about how to monitor and check the sync status of your integration, see the relevant documentation.