Page Comparison

requestType

API request type that adds a policy to a global organization.

string

Yes

globalOrgToken

API key which is a unique identifier of the global organization.

string

Yes

userKey

The ID of the user’s profile, which uniquely identifies the user in WhiteSource.

string

Yes

policy

Policy data object containing:

string

Yes

name

Name of the policy you want to add.

string

Yes

owner

Identification of the user that created the policy.

integer

Yes

Valid values: user ID, name, or email.

filter

The policy filter defines how to match libraries (for example: By License). Comprises the following:

• Match - The match type that defines which criteria of the library will be checked for licenses or security vulnerabilities in the code.

• Values - The values values against which the match type is evaluated. For example, for match type License Group, the values are the specific licenses against which the library license is matched.

For a description of all the available match types and their values, please refer to Matching a Policy to a Library.

string

Yes

For the LICENSE match type, if the inclusive value is set to true, the policy will perform the action when ALL the licenses in the library are matched. Boolean data type values are true or false.

action

Type of operation that defines what to do when a library matches the policy’s filter.

string

Yes

Valid values are:

• Approve - Automatically approve the library.

• Reject - Automatically reject the library.

• Reassign - Reassign the request to a designated user or group in the system which is not the default approver.

• Conditions - Automatically assign conditions and open tasks on libraries.

• Issue - Automatically create a ticket in the issue tracker with all relevant information.  For a description of the query parameters required to create a policy of action type Issue, see Create Issue Action for a Policy.