| Table of Contents |
|---|
...
Configuring Agents
The user key is configured in the agent configuration file and the agent command line.
Agent Configuration File
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 can be set in several ways, depending on the integration used.
When using the Unified Agent, the user key can be configured via the WS_USERKEY environment variable or by specifying the userKey parameter in the configuration file or by setting the -userKey command-line argument.
Example for configuring the userKey parameter in the configuration file:
...
Agent Command Line
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.
...
Configuration in HTTP API
...
| Note |
|---|
Only WhiteSource users with Administrator or Auditor privileges (“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. |
...