...
This API request enables you to create a global organization with an API key token which is its unique identifier.
QUERY PARAMETERS
Parameter | Description | Type | Required |
|---|---|---|---|
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 WhiteSource. | 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 |
Request Example
| Code Block |
|---|
{
"requestType": "createGlobalOrg",
"userKey": "user_key",
"name": "global_org_name",
"accountAdminEmail": "enter_account_admin_email@here.com"
} |
...
This API request enables you to assign a global organization to an organization.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
orgToken | API key which is the unique identifier of the organization. | string | Yes |
globalOrgToken | API token key which identifies the global organization to be assigned. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType": "assignGlobalOrgToOrg",
"userKey": "user_key",
"orgToken": "org_token",
"globalOrgToken": "global_org_token"
} |
...
This API enables you to remove a global organization from an organization.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
orgToken | API key which is the unique identifier of the organization. | string | Yes |
globalOrgToken | API token key which identifies the global organization to be removed. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType": "removeGlobalOrgFromOrg",
"userKey": "user_key",
"orgToken": "org_token",
"globalOrgToken": "global_org_token"
} |
...
This API request returns data on all organizations within the Global Organization.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
globalOrgToken | API token key which uniquely identifies the global organization. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType":"getAllOrganizations",
"userKey": "user_key",
"globalOrgToken":"global_organization_token"
} |
...
This API request returns details about an organization, such as, name, token key, creation date, number of products, projects, groups, and users in the organization.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType":"getOrganizationDetails",
"orgToken":"org_token",
“userKey”:”user_key”
} |
...
This API request gets all products in the organization; name and token of each.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType":"getAllProducts",
"userKey": "user_key",
"orgToken":"org_token"
} |
...
This API request gets basic information about each product in an organization: ID, name, token, creation date and last updated date.
QUERY PARAMETERS
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the details of all products in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getOrganizationProductVitals",
"userKey": "user_key",
"orgToken" : "organization_api_key"
} |
...
This API request receives a product token and returns all projects in the product; name and token of each.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
productToken | API token key which uniquely identifies the product. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType":"getAllProjects",
"userKey": "user_key",
"productToken":"product_token"
} |
...
This API request gets basic information about each project in an organization: ID, name, token, creation date and last updated date.
QUERY PARAMETERS
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the details of all projects in an organization. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
orgToken | API token key which uniquely identifies the organization. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getOrganizationProjectVitals",
"userKey": "user_key",
"orgToken" : "organization_api_key"
} |
...
This API request gets basic information about each project in a product: ID, name, token, creation date and last updated date.
QUERY PARAMETERS
Parameter | Description | Type | Required |
|---|---|---|---|
requestType | API request type that returns the details of all projects in a product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
productToken | API token key which uniquely identifies the product. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getProductProjectVitals",
"userKey": "user_key",
"productToken" : "product_token"
} |
...
Get all In-House libraries at the organization level.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getOrganizationInHouseLibraries",
"orgToken" : "organization_api_key",
"userKey": "user_key"
} |
...
Get all In-House libraries at the product level.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getProductInHouseLibraries",
"productToken" : "product_token",
"userKey": "user_key"
} |
...
Get all In-House libraries at the project level.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType" : "getProjectInHouseLibraries",
"projectToken" : "project_token",
"userKey": "user_key"
} |
...
This API request enables you to unmark libraries that were manually assigned as In-House. This request is only at the organization level.
QUERY PARAMETERS
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 WhiteSource. | string | Yes |
keyUuid | The ID of the library which uniquely identifies it. | string | Yes |
Request Example
| Code Block |
|---|
{
"requestType": "unmarkManualInHouseLibrary",
"userKey": "user_key",
"orgToken": "organization_api_key",
"keyUuid" : "library_UUID"
} |
...