> For the complete CircleCI developer hub index, see [llms.txt](https://circleci.com/developer/llms.txt)

# whitesource/whitesource-scan

The orb integrates WhiteSource Unified Agent, a tool for detecting security vulnerabilities and compliance data related to open source components. For more information: https://whitesource.atlassian.net/wiki/spaces/WD/pages/804814917/Unified+Agent+Overview

## Jobs

### scan

| Parameter | Type | Default | Description |
|---|---|---|---|
| `api_key` | string | ${API_KEY} | Unique identifier of the organization. Can be retrieved from the admin page in your WhiteSource account. |
| `directory` | string | . | Comma separated list of directories and / or files to scan. |
| `config_file_path` | string | whitesource-fs-agent.config | Configuration file name (including file path). |
| `commands_file_path` | string | install_commands.sh | install commands file (including file path) |

## Executors

### java

The docker container to run java commands