...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
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:
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. | stringObject | Yes | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that adds a policy to an organization. | string | Yes | ||
orgToken | API key which is a unique identifier of the 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:
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 | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that adds a policy to a product. | string | Yes | ||
productToken | API key which is a unique identifier of the product. | 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. | integer | Yes | ||
owner | Identification of the user that created the policy. | string | Yes | Valid values: user ID, name, or email. | |
filter | The policy filter defines how to match libraries (for example: By License). Comprises the following:
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 | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that adds a policy to a project. | string | Yes | ||
projectToken | API key which is a unique identifier of the project. | 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:
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 | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that updates a policy in a global organization. | string | Yes | ||
globalOrgToken | API key which is a unique identifier of the global organization. Used to identify the global organization in plugins. | 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 | ||
id | Unique ID of the policy. | integer | Yes | ||
name | Name of the policy you want to update. | 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:
For a description of all the available match types and their values, please refer to Matching a Policy to a Library. | string | No | 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 | No | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that updates a policy in an organization. | string | Yes | ||
orgToken | API key which is a unique identifier of the organization. Used to identify the organization in plugins. | 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 | |||
id | Unique ID of the policy. | integer | Yes | ||
name | Name of the policy you want to update. | 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:
For a description of all the available match types and their values, please refer to Matching a Policy to a Library. | string | No | 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 | No | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that updates a policy in a product. | string | Yes | ||
productToken | API key which is a unique identifier of the product. | 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 | ||
id | Unique ID of the policy. | integer | Yes | ||
name | Name of the policy you want to update. | 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:
For a description of all the available match types and their values, please refer to Matching a Policy to a Library. | string | No | 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 | No | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...
Parameter | Description | Type | Required | Default/Values | |
---|---|---|---|---|---|
requestType | API request type that updates a policy in a project. | string | Yes | ||
projectToken | API key which is a unique identifier of the project. | 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 | ||
id | Unique ID of the policy. | integer | Yes | ||
name | Name of the policy you want to update. | 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:
For a description of all the available match types and their values, please refer to Matching a Policy to a Library. | string | No | 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 | No | The “Action” object must contain the field “type”. Valid values for “type” are:
|
...