Aikido GetReport

Aikido GetReport
Certified
Get an Aikido compliance framework overview

Fetches the compliance overview for a given framework: the rule-by-rule pass/fail breakdown and the overall compliant-rule count.

yaml
type: io.kestra.plugin.aikido.compliance.GetReport

Examples

Fetch the SOC 2 compliance overview

yaml
id: get_soc2_overview
namespace: company.security

tasks:
  - id: compliance
    type: io.kestra.plugin.aikido.compliance.GetReport
    clientId: "{{ secret('AIKIDO_CLIENT_ID') }}"
    clientSecret: "{{ secret('AIKIDO_CLIENT_SECRET') }}"
    framework: SOC2

Properties

clientId *string

OAuth2 client ID

Client ID of an Aikido API client with the OAuth2 scopes required by the tasks and triggers being used (for example issues: read, repositories: write). Client credentials are created in the Aikido console under Settings > API access.

clientSecret *string

OAuth2 client secret

Client secret of the Aikido API client. Exchanged for a short-lived JWT Bearer token on first use (and transparently refreshed before it expires); never logged or included in error messages.

framework *string

Possible Values

NIS2SOC2ISO27001

Compliance framework

baseUrl string

Defaulthttps://app.aikido.dev

Aikido API base URL

Base URL of the Aikido Security application for your account's region: https://app.aikido.dev (Europe, default), https://app.us.aikido.dev (United States), https://app.au.aikido.dev (Australia), or https://app.me.aikido.dev (Middle East). The OAuth2 token endpoint is derived from this same host, so a region override applies to both authentication and API calls.