Supported version: Server from 2020.10.1 till 2022.10.1.
API Rate Limit: No Limit
Supported Authentication: Custom Authentication(Supported from 6.5.9.1 Klera Version).
Steps to generate API Token:-
1. Log into your Black Duck Instance.
2. From the user menu located on the top navigation bar, select "My Access Tokens". The "My Access Tokens" page appears.
3. Click "Create New Token". The "Create New Token" dialog box appears.
4. Type a User-Friendly Token name which is easy to remember.
5. Optional: In the "Description" field, you can type a description or definition.
6. Select "Read Access".
7. Click on "Create". The API Token displays in a pop-up window. For security reasons, this is the only time your user API Token displays. Please save this token. If the token is lost, you must regenerate it.
IMPORTANT: Please make sure your Black Duck instance must be accessible from the Klera Machine.
To configure Black Duck Connector using Custom Authentication, follow the steps below:-
1. Enter your Black Duck URL for example http://blackduck.klera.io
2. Select Authentication Type as "Custom Authentication".
3. Select “Create New Account” and add user friendly name for account for e.g. “Black Duck Account”.
4. Select "Method Type" as "POST".
5. Enter the following API in the Validation End Point section:
{Black Duck URL}/api/tokens/authenticate
6. Enter the following details in End Point Header Parameters section:
Key: Authorization
Value: token<SPACE><API Token generated from Black Duck UI>
7. Select "Response Key" from "Get Credentials From" section.
8. Select "Authorization with Bearer Prefix" from "Operation's Request Header Parameter" section.
9. Enter the following value in "Parameter Key Name In Response" section: bearerToken
10. Select "Read Expiration Time From Response" from Expiration Time section.
11. Enter the following value in "Response Parameter key name containing expiration time" section: expiresInMilliseconds
12. Select "Milliseconds" from "Expiration time parameter value's unit or format" section.
13. Click on "Save".
