snyk-orgs-settings

A Snyk Organization model generation

Description

Generates a JSON extract of Snyk Organizations settings of a Snyk Group. This is the equivalent output JSON after running orgs:create command at snyk-api-import.

This will serve as the input to generate a list of import targets for the respective Snyk Organizations at snyk-api-import with import:data command.

Prerequisites

Python 3.7 and above
Snyk account with SNYK_TOKEN of ❗ Group Admin permission

Installation

Setup Python virtual environment with

pip3 install -r requirements.txt

Usage

% export SNYK_TOKEN=<MySnykToken>
% python3 snyk-orgs-settings.py --help
usage: snyk-orgs-settings.py [-h] --group-id GROUP_ID [--orgNameStartsWith ORGNAMESTARTSWITH] [--mapping-json MAPPING_JSON] [--map-attribute MAP_ATTRIBUTE] [--snyk-org-key SNYK_ORG_KEY] [--scm-org-key SCM_ORG_KEY]

Extracts Snyk Organizations settings

optional arguments:
  -h, --help            show this help message and exit
  --group-id GROUP_ID   The Snyk Group ID found in Group > Settings.
  --orgNameStartsWith ORGNAMESTARTSWITH
                        The Snyk Organization Name found in Organization > Settings. If omitted, process all organizations of Snyk Group token has access to.
  --mapping-json MAPPING_JSON
                        File path to Snyk to SCM organization name mapping json
  --map-attribute MAP_ATTRIBUTE
                        Map attribute to name list on mapping json
  --snyk-org-key SNYK_ORG_KEY
                        Snyk Organization name key in mapping json
  --scm-org-key SCM_ORG_KEY
                        SCM Organization name key in mapping json
% python3 snyk-orgs-settings.py --group-id <MyGroupId> [--orgNameStartsWith <OrgNamePrefix>]

Mapping to SCM Organization scoped Name (Optional)

If a custom SCM-to-Snyk organization name convention was applied, an additional mapping JSON file may be provided to map created Snyk organization name to its corresponding SCM organization. A one-to-one mapped name is supported.

Mapping JSON file (Example)

{
  "snyk-bitbucket-mapping": [
    {
      "snyk-org-name": "org2",
      "bitbucket-project-name": "My Digital Org"
    },
    {
      "snyk-org-name": "api_ecommerce",
      "bitbucket-project-name": "My Digital ecommerce"
    }
  ]
}

Command

python3 snyk-orgs-settings.py --group-id ff0c78bb-6365-462c-8576-e73de8793870 --mapping-json "./mymappingnames.json" --map-attribute "snyk-bitbucket-mapping" --snyk-org-key "snyk-org-name" --scm-org-key "bitbucket-project-name"

Sample Output

snyk-created-orgs.json

{
  "orgData": [
    {
      "id": "09745013-c281-4027-aa7f-0a6985da4802",
      "name": "My Digital Org",
      "slug": "org2-1lv",
      "url": "https://app.snyk.io/org/org2-1lv",
      "created": "2022-08-17T02:37:35.137Z",
      "orgId": "09745013-c281-4027-aa7f-0a6985da4912",
      "integrations": {
        "github": "76f73f35-7690-4121-a5a0-b2c279f54c11",
        "bitbucket-cloud": "c8abbdf5-fbec-449a-af25-9927095ecc4c"
      },
      "groupId": "fr0c78bb-6365-462c-8576-e73de8793870"
    }
  ]
}

gwnlng / snyk-orgs-settings Goto Github PK