2019-03-27 12:49:56 +02:00
|
|
|
# ${docGenStepName}
|
2019-03-08 13:33:31 +02:00
|
|
|
|
2019-03-27 12:49:56 +02:00
|
|
|
## ${docGenDescription}
|
2019-03-08 13:33:31 +02:00
|
|
|
|
|
|
|
## Prerequisites
|
|
|
|
|
2019-03-27 12:49:56 +02:00
|
|
|
Your company has registered an account with WhiteSource and you have enabled the use of so called `User Keys` to manage
|
|
|
|
access to your organization in WhiteSource via dedicated privileges. Scanning your products without adequate user level
|
|
|
|
access protection imposed on the WhiteSource backend would simply allow access based on the organization token.
|
2019-03-08 13:33:31 +02:00
|
|
|
|
2019-03-27 12:49:56 +02:00
|
|
|
## ${docGenParameters}
|
2019-03-08 13:33:31 +02:00
|
|
|
|
2019-03-27 12:49:56 +02:00
|
|
|
## ${docGenConfiguration}
|
2019-03-08 13:33:31 +02:00
|
|
|
|
|
|
|
## Exceptions
|
|
|
|
|
2019-03-08 14:56:07 +02:00
|
|
|
None
|
|
|
|
|
2019-03-08 13:33:31 +02:00
|
|
|
## Examples
|
2019-03-08 14:56:07 +02:00
|
|
|
|
|
|
|
```groovy
|
2019-03-27 12:49:56 +02:00
|
|
|
whitesourceExecuteScan script: this, scanType: 'pip', productName: 'My Whitesource Product', userTokenCredentialsId: 'companyAdminToken', orgAdminUserTokenCredentialsId: 'orgAdminToken', orgToken: 'myWhitesourceOrganizationToken'
|
2019-03-08 14:56:07 +02:00
|
|
|
```
|