Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Table of Contents

...

The user adds the user key by entering it in the relevant WhiteSource plugin configuration file (e.g., "WhiteSource-fs-agent.config” for Unified Agent). This is done by adding the following attribute:

Attribute

Type

Description

Mandatory

userKey

String

Unique identifier of user.

Required if WhiteSource administrator has selected the Enforce user level access option.

Example of a userKey attribute entered in the configuration file:

...

The user can also configure the user key by entering it in the command line. The following user level parameter has been added for the agent command line:

Parameter

Type

Description

Mandatory

-userKey

String

Unique identifier of user.

Required if WhiteSource administrator has selected the Enforce user level access option.

Configuration in HTTP API

...

Note

Only WhiteSource users with administrator Administrator or Auditor privileges (organization or product level) and Product Integrators are “Auditor” can only be assigned to service users) are allowed to use the APIs in case the Enforce user level access option has been enabled.

The argument is entered in the following fashion:

"userKey":"user_key",

The following is an example of a “getProjectVulnerabilityReport” API request that includes the userKey argument:

{

"requestType" : "getProjectVulnerabilityReport",

"userKey":"5c5c5b1dc14b44faa71d4bc443de",

"projectToken" : "438629e2da934b4ca68220c"

}

Reports

With the support of the User level access control in integrations, the WhiteSource administrator has the option to view and analyze reports that provide data on the usage of WhiteSource requests per user. Reports display the users’ profile names, which are linked to their respective user keys.

...