...
Generally, each level of the administrator (Global Org, Organization, Product, Project) can get or set the API attributes in the API calls that refer to their scope or are under their scope. For example, Product administrators can execute API calls related to their Projects/Products that are defined in WhiteSourceMend, but they cannot execute Organization-related API calls which are outside their scope.
...
Parameter | Description | Type | Required i |
|---|---|---|---|
requestType | API request type that creates a global organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
name | Name to be assigned to the global organization. | string | Yes |
accountAdminEmail | Email account of the Administrator that is creating the global organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that assigns a global organization to an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API key which is the unique identifier of the organization. Admins can find this token in the "Integrate" tab of the application, in the "API Key" field. | string | Yes |
globalOrgToken | API token key which identifies the global organization to be assigned. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that removes a global organization from an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API key which is the unique identifier of the organization. Admins can find this token in the "Integrate" tab of the application, in the "API Key" field. | string | Yes |
globalOrgToken | API token key which identifies the global organization to be removed. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the name and token ID of all the organizations in a global organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
globalOrgToken | API token key which uniquely identifies the global organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the details of an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns all the products in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the vitals of all products in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns data of all the projects in a product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
productToken | API token key which uniquely identifies the product. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the vitals of all projects in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the vitals of all projects in a product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
productToken | API token key which uniquely identifies the product. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the vitals of a project. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
projectToken | API token key which uniquely identifies the project. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that changes the policy owner for all policies in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
currentPolicyOwnerEmail | Email address of current policy owner. | string | Yes |
newPolicyOwnerEmail | Email address of new policy owner for the organization. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns all In-House libraries for 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 WhiteSourceMend. | string | Yes |
Request Example
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns all In-House libraries for a product. | string | Yes |
productToken | Unique identifier of the product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
Request Example
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns all In-House libraries for a project. | string | Yes |
projectToken | Unique identifier of the project. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | string | Yes |
Request Example
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that unmarks a library that was manually assigned as In-House, at the organization level. | 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 WhiteSourceMend. | string | Yes |
keyUuid | The ID of the library which uniquely identifies it. | string | Yes |
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns all Pending Tasks in the domain. | 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 WhiteSourceMend. | string | Yes |
Request Example
...
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type for deleting a Pending Task. | 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 WhiteSourceMend. | string | Yes |
taskUUID | A uuid for one of the Pending Tasks that was returned by the getDomainPendingTasks API. | string | Yes |
...