Skip to main content

Check out Port for yourself 

Aikido

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

Overview​

This integration allows you to:

  • Track security vulnerabilities from Aikido in Port
  • Map repositories and their security findings
  • Maintain real-time synchronization between Aikido and Port

Supported Resources​

The resources that can be ingested from Aikido into Port are listed below. It is possible to reference any field that appears in the API responses linked below in the mapping configuration.

Setup​

Choose one of the following installation methods:

Using this installation option means that the integration will be hosted by Port, with a customizable resync interval to ingest data into Port.

Live event support

This integration supports live events, allowing real-time updates to your software catalog without waiting for the next scheduled sync.

Supported live event triggers

Issues:

  • issue.open.created
  • issue.snoozed
  • issue.ignored.manual
  • issue.closed
Self-hosted installation

Alternatively, you can install the integration using the Real-time (self-hosted) method to update Port in real time using webhooks.

Installation

To install, follow these steps:

  1. Go to the Data sources page of your portal.

  2. Click on the + Data source button in the top-right corner.

  3. Click on the relevant integration in the list.

  4. Under Select your installation method, choose Hosted by Port.

  5. Configure the integration settings and application settings as you wish (see below for details).

Application settings

Every integration hosted by Port has the following customizable application settings, which are configurable after installation:

  • Resync interval: The frequency at which Port will ingest data from the integration. There are various options available, ranging from every 1 hour to once a day. If a sync is still in progress when the next one is due, the new sync will be skipped (up to 24 hours delay).
    This ensures that all kinds are fully synchronized and that cleanup of stale entities always takes place at the end of each sync.

  • Send raw data examples: A boolean toggle (enabled by default). If enabled, raw data examples will be sent from the integration to Port. These examples are used when testing your mapping configuration, they allow you to run your jq expressions against real data and see the results.

Integration settings

Every integration has its own tool-specific settings, under the Integration settings section.
Each of these settings has an ⓘ icon next to it, which you can hover over to see a description of the setting.

Port secrets

Some integration settings require sensitive pieces of data, such as tokens.
For these settings, Port secrets will be used, ensuring that your sensitive data is encrypted and secure.

When filling in such a setting, its value will be obscured (shown as ••••••••).
For each such setting, Port will automatically create a secret in your organization.

To see all secrets in your organization, follow these steps.

Limitations

  • The maximum time for a full sync to run is based on the configured resync interval. For very large amounts of data where a resync operation is expected to take longer, please use a longer interval.

Port source IP addresses

When using this installation method, Port will make outbound calls to your 3rd-party applications from static IP addresses.
You may need to add these addresses to your allowlist, in order to allow Port to interact with the integrated service:

54.73.167.226  
63.33.143.237  
54.76.185.219

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

Monitoring and sync status​

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

Examples​

Examples of blueprints and the relevant integration configurations:

Repository​

Repository blueprint
{
    "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", "externalRepoId"]
    },
    "relations": {
        "aikidoIssue": {
            "title": "Issues",
            "target": "aikidoIssue",
            "required": false,
            "many": true
        }
    }
}
Integration configuration
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

Issue​

Issue blueprint
{
  "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", "container"]
          },
          "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", "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", "rule"]
  },
  "relations": {
      "aikidoRepository": {
          "title": "Repository",
          "target": "aikidoRepository",
          "required": false,
          "many": false
      }
  }
}
Integration configuration
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

Let's Test It​

This section includes a sample response data from Aikido. In addition, it includes the entity created from the resync event based on the Ocean configuration provided in the previous section.

Payload​

Here is an example of the payload structure from Aikido:

Repository response data
{
  "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
}
Issue response data
{
    "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"
}