CLI Fetcher JSON Input Reference

The JSON input is used to specify the project, credentials, and rulesets to use for the fetch. By default, the JSON input is read from the project.json file in the current directory.

{
  "project": {
    "name": "<name>",
    "credentials": [
      {
        "platform": "<platform>",
        // ... platform specific credentials
        "regions": [
          "<region>"
        ],
        "services": [
          "<service>"
        ]
      }
      // More credentials
    ],
    "rulesetIDs": [
      "<ruleset_id>"
    ]
  }
}

Name

• Type: string
• Description: The name of the project.

Credentials

• Type: array of Credential
• Description: The credentials for the project.

Credential

• Type: object
• Description: The platform specific credential fields for the project.
• Note: The fields are added to the credential object based on the platform.

AWS

{
  "platform": "aws",
  "accessKeyID": "<access_key_id>",
  "secretAccessKey": "<secret_access_key>"
}

Azure

{
  "platform": "azure",
  "clientID": "<client_id>",
  "clientSecret": "<client_secret>",
  "tenantID": "<tenant_id>",
  "subscriptionID": "<subscription_id>"
}

GCP

{
  "platform": "gcp",
  "projectName": "<project_name>",
  "jsonKey": "<json_key>"
}

Alibaba Cloud

{
  "platform": "alicloud",
  "accessKeyID": "<access_key_id>",
  "secretAccessKey": "<secret_access_key>"
}

Platform

• Type: string
• Description: The platform to use for the project.
• Possible values: aws, azure, gcp, alicloud

Regions

• Type: array
• Description: The regions to use for the project.
• Only used if the platform is aws or alicloud.
• Default: [] (If empty, all regions are used)

Services

• Type: array
• Description: The services to use for the project.
• Note: Run sccce fetch <platform> list to get the list of services. The list is platform specific, and the services are case sensitive.
• Default: [] (If empty, all services are used)

Ruleset IDs

• Type: array
• Description: The IDs of the rulesets to use for the project.
• Default: [] (If empty, no rulesets will be used)