github.com/jaylevin/jenkins-library@v1.230.4/documentation/docs/steps/whitesourceExecuteScan.md (about)

     1  # ${docGenStepName}
     2  
     3  ## ${docGenDescription}
     4  
     5  ## Prerequisites
     6  
     7  Your company has registered an account with WhiteSource and you have enabled the use of so called `User Keys` to manage
     8  access to your organization in WhiteSource via dedicated privileges. Scanning your products without adequate user level
     9  access protection imposed on the WhiteSource backend would simply allow access based on the organization token.
    10  
    11  ## ${docGenParameters}
    12  
    13  ## ${docGenConfiguration}
    14  
    15  ## ${docJenkinsPluginDependencies}
    16  
    17  ## Exceptions
    18  
    19  None
    20  
    21  ## Examples
    22  
    23  ```groovy
    24  whitesourceExecuteScan script: this, buildTool: 'pip', productName: 'My Whitesource Product', userTokenCredentialsId: 'companyAdminToken', orgAdminUserTokenCredentialsId: 'orgAdminToken', orgToken: 'myWhitesourceOrganizationToken'
    25  ```