Scan External Repositories

Sync and Scan Repositories from External Sources

  1. Navigate to Schedules → Configure Schedule

  2. Choose Falcon Scan job type

  3. Select the external source and the organization

  4. External Sources can either be -

    1. BitBucket

    2. GitHub

    3. Anypoint Design Center falcon scan scheduler 1

  5. Select the required schedule. Schedule can either be -

    1. One Time

    2. Recurring falcon scan scheduler 2

Configuring BitBucket as External Sources

  1. Create a OAuth consumer App in BitBucket with following details -

    1. Callback URL - https://<FALCON_SUITE_INSTANCE_URL>/oauth/bitbucket/callback

    2. URL - https://<FALCON_SUITE_INSTANCE_URL>;

    3. Permissions - Account (Read), Repositories (Read)

  2. Navigate to Global Settings → Settings → BitBucket Repo Sync Settings and click on edit. Other settings apart from the below mentioned keys can be left blank.

BitBucket Repo Sync Settings

Settings Name Description

OAUTH_CLIENT_ID

OAuth Consumer Client Id. Used for authenticating the REST API to get repositories.

OAUTH_CLIENT_SECRET

OAuth Consumer Client Secret. Used for authenticating the REST API to get repositories.

PROJECT_NAME_INCLUDE_PATTERN

Repository name matching this pattern will only be synced. By default all the repositories will be scanned.

PROJECT_NAME_EXCLUDE_PATTERN

Repository name matching this pattern will only be ignored. By default none of the repositories will be ignored.

SCAN_ALL_APPLICATION

Should all the repositories matching the Include / Exclude Pattern.

SCAN_ALL_BRANCHES

Should all the branches of the repository be scanned.

Configuring GitHub as External Sources

  1. Navigate to Global Settings → Settings → GitHub Repo Sync Settings and click on edit. Other settings apart from the below mentioned keys can be left blank.

GitHub Repo Sync Settings

Settings Name Description

OAUTH_CLIENT_ID

OAuth Consumer Client Id. Used for authenticating the REST API to get repositories.

OAUTH_CLIENT_SECRET

OAuth Consumer Client Secret. Used for authenticating the REST API to get repositories.

PROJECT_NAME_INCLUDE_PATTERN

Repository name matching this pattern will only be synced. By default all the repositories will be scanned.

PROJECT_NAME_EXCLUDE_PATTERN

Repository name matching this pattern will only be ignored. By default none of the repositories will be ignored.

SCAN_ALL_APPLICATION

Should all the repositories matching the Include / Exclude Pattern.

SCAN_ALL_BRANCHES

Should all the branches of the repository be scanned.

API_TOKEN_SCOPE

Scopes to be requested while generating the OAuth token

Configuring Anypoint Design Center as External Sources

  1. Navigate to Global Settings → Settings → Design Center Project Sync Settings and click on edit

Design Center Project Sync Settings

Settings Name Description

ANYPOINT_CLIENT_ID

Anypoint Connected App client id

ANYPOINT_CLIENT_SECRET

Anypoint Connected App client secret

PROJECT_NAME_INCLUDE_PATTERN

Repository name matching this pattern will only be synced. By default all the repositories will be scanned.

PROJECT_NAME_EXCLUDE_PATTERN

Repository name matching this pattern will only be ignored. By default none of the repositories will be ignored.

See Also