WhiteSource
App Vendor: WhiteSource
App Category: Vulnerability Management
Connector Version: 1.0.0
API Version: 2.0
Notice
This is a beta-app and the documentation is in progress.
About App
This connector is integrated with WhiteSource API, which is a powerful tool for automating and integrating WhiteSource's open-source security and license compliance management features directly into your software applications and systems. It facilitates real-time tracking of open-source components, vulnerability identification, and compliance reporting.
The WhiteSource app is configured with Orchestrate to perform the following actions:
Action Name | Description |
|---|---|
Generic Action | This action performs any additional use case that you want on WhiteSource. |
Get All Organizations | This action returns a list of all organizations where the current user is a member. |
Get All Products | This action returns a list of all products accessible to the current user. |
Get All Projects | This action returns a list of the projects and their tokens for a given product. |
Get In House Libraries | This action returns a list of the projects and their tokens for a given product. |
Get Organization | This action returns an organization identified by its token. |
Configuration Parameters
The following configuration parameters are required for the WhiteSource app to communicate with the WhiteSource enterprise application. The parameters can be configured by creating instances in the app.
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Base URL | Enter the base URL. | Text | Required |
|
API Token | Enter the API token. | Password | Required |
|
Verify | Choose your preference to verify SSL while making requests. It is recommended to set this option to yes. If no is passed, it may result in an incorrect establishment of the connection, potentially causing it to become broken. | Boolean | Optional | Default value: true Allowed values:
|
Action: Generic Action
This action performs any additional use case you want on WhiteSource.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
HTTP method | Enter the HTTP request method. Example: GET | Text | Required | Allowed values:
|
Endpoint | Enter the endpoint. | Text | Required |
|
Params | Enter the query params. | Key Value | Optional |
|
Payload | Enter the payload data. | Key Value | Optional |
|
Action: Get All Organizations
This action returns a list of all organizations where the current user is a member.
Action Input Parameters
This action does not require any input parameter.
Action: Get All Products
This action returns a list of all products accessible to the current user.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Org Token | Enter the organization token to get all products. Example: "123e4567-e89b-12d3-a456-426655440000" | Text | Required |
|
Page Size | Enter the page size. Example: 20 | Text | Optional | Default value: 50 |
Page | Enter the page number. Example: 15 | Text | Optional | Default value: 0 |
Action: Get All Projects
This action returns a list of the projects and their tokens for a given product.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Product Token | Enter the product token to get all projects. Example: "123e4567-e89b-12d3-a456-426655440000" | Text | Required |
|
Page Size | Enter the page size. Example: 30 | Text | Optional | Default value: 50 |
Page Number | Enter the page number. Example: 12 | Text | Optional | Default value: 0 |
Action: Get In House Libraries
This action returns a list of the projects and their tokens for a given product.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Product Token | Enter the product token to get in house libraries. Example: "123e4567-e89b-12d3-a456-426655440000" | Text | Required |
|
Query Params | Enter the query parameters to filter the response. To know more about the filters, refer to the API documentation. Example: {page:0, pageSize:50} | Key Value | Optional | Allowed values:
|
Action: Get Organization
This action returns an organization identified by its token.
Action Input Parameters
Parameter | Description | Field Type | Required/Optional | Comments |
|---|---|---|---|---|
Org token | Enter the organization token to get an organization. Example: "123e4567-e89b-12d3-a456-426655440000" | Text | Required |
|