...
NOTE: To get all groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that returns all the groups in 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 a unique identifier of the organization. | string | Yes |
Request Example
|
Response Example
The response is a JSON collection of all the groups with their details in the organization. For example:
...
NOTE: To get all users in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that returns all the users in 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 a unique identifier of the organization. | string | Yes |
Request Example
|
Response Example
The response is a JSON collection of all the users with their details in the organization. For example:
...
NOTE: To create groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that creates a group in 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 a unique identifier of the organization. | string | Yes | |
group | Group data object containing: | |||
name | Name of the group that you want to create. | string | Yes | |
description | Description of the group you want to create. | string | No |
Request Example
|
Response Example
The response shows the details of the newly created group for which a unique ID was created. For example:
|
Create a User
NOTE: To create a user in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that creates a user in 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 a unique identifier of the organization. | string | Yes | |
inviter | Data object containing: | |||
Email address of the user that is sending the invitation to the new user. | string | Yes | ||
addedUser | New user data object containing: | |||
name | Name of the user to be added. | string | Yes | |
Email address of the user to be added. | string | Yes |
Request Example
|
Response Example
Code Block |
---|
"message":"Successfully created user new_user_name" |
...
NOTE: To invite users to join an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that sends an invitation to new users to join 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 a unique identifier of the organization. | string | Yes | |
inviter | Data object containing: | |||
Email address that is “inviting” the new users. | string | Yes | ||
emails | List of activation email addresses for the new users. | array | Yes |
Request Example
|
Response Example
|
Adding Users to Groups
NOTE: To add users to groups in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that adds users to groups in 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 a unique identifier of the organization. | string | Yes | |
assignedUsers | Data object listing the users that you want to assign to groups: | array | Yes | |
name | Name of the group to which you are adding the users. | string | Yes | |
List of email activation addresses of users you want to assign to the group. | array | Yes |
Request Example
|
Response Example
Code Block |
---|
"message":"Successfully assigned users to groups" |
...
NOTE: To remove a user from a group in an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that removes a user from a group in 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 a unique identifier of the organization. | string | Yes |
group | Name of the group from which the user will be removed. | string | Yes |
user | Name of the user that will be removed from the group. | string | Yes |
Request Example
|
Response Example
Code Block |
---|
"message":"Successfully removed user from group" |
...
NOTE: To remove a user from an organization, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that removes a user 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 a unique identifier of the organization. | string | Yes |
user | Email address of the user that will be removed from the organization. | string | Yes |
Request Example
|
Response Example
Code Block |
---|
"message":"Successfully removed user from organization" |
...
NOTE: To get organization-level role assignments, you must have ORG Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that gets all role assignments in 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 a unique identifier of the organization. | string | Yes |
Request Example
Code Block |
---|
{ "requestType":"getOrganizationAssignments", "userKey": "user_key", "orgToken":"organization_api_key" } |
...
NOTE: To get product-level role assignments, you must have Product Admin role permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that gets all role assignment in a product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
productToken |
Unique identifier of the product. | string | Yes |
Request Example
Code Block |
---|
{ "requestType":"getProductAssignments", "userKey": "user_key", "productToken":"product_api_keytoken" } |
Response Example
The JSON response shows the details of the assignments for different roles in the product. For example:
...
Administrators have control over the entire organization. They can create, invite, and remove users, add products and projects, and much more.
This API enables you to assign the Administrator role to specific users and/or groups.
NOTE: Assigning the role of Administrator to individual users is not recommended; using groups is simpler and easier for user and role management.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the organization-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
administrators | Administrator role data object containing: | |||
groupAssignments | List of groups to which you want to assign the Administrator role. | array | No | |
userAssignments | List of users to which you want to assign the Administrator role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setOrganizationAssignments", "userKey": "user_key", "orgToken": "organization_api_key", "administrators" : { "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], "userAssignments":[{"email":"user_email"},{"email":"user_email"}] } } |
...
This API enables you to assign the organization-level role Alert Email Receivers to specific users and/or groups.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the organization-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
alertsEmailReceivers | Alert Email Receiver role data object containing: | |||
groupAssignments | List of groups to which you want to assign the Alert Email Receiver role. | array | No | |
userAssignments | List of users to which you want to assign the Alert Email Receiver role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setOrganizationAssignments", "userKey": "user_key", "orgToken": "organization_api_key", "alertsEmailReceivers" : { "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], "userAssignments":[{"email":"user_email"},{"email":"user_email"}] } } |
...
All pending tasks in the organization are sent to the Default Approver. Changing the Default Approver only impacts future tasks. Existing tasks are assigned to their original Approver.
The organization must have a Default Approver at all times. The role of Default Approver is assigned to the organization creator by default, and any member of the organization can be assigned to this role. You can also assign the Default Approver to a specific group.
NOTE: The Product level Default Approver overrides the Organization level Default Approver for their relevant Product(s).
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the organization-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
defaultApprover | Default Approver role data object containing: | |||
groupAssignments | List of groups to which you want to assign the Default Approver role. | array | No | |
userAssignments | List of users to which you want to assign the Default Approver role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setOrganizationAssignments", "userKey": "user_key", "orgToken": "organization_api_key", "defaultApprover" : { "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], "userAssignments":[{"email":"user_email"},{"email":"user_email"}] } } |
...
The Auditor role can be assigned to service users to grant them Read-only permissions in the scope of a specific organization. It is recommended to use this role when you want service users to obtain organizational information, but you don't want to grant them full Admin permissions.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the organization-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
readOnlyUsers | Auditor role data object to grant read-only permissions: | |||
groupAssignments | List of groups to which you want to assign the Auditor role. | array | No | |
userAssignments | List of users to which you want to assign the Auditor role. | array | No |
Request Example
Code Block |
---|
{ "requestType" : "setOrganizationAssignments", "userKey":"admin_user_key" "orgToken" : "organization_api_key", "readOnlyUsers" : { "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], "userAssignments":[{"email":"user_email"},{"email":"user_email"}] } } |
...
Product Administrators have control over the entire product, they can rename and delete the product, and all the projects under it.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the product-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
productToken |
Unique identifier of the product. | string | Yes | ||
productAdmins | Product Administrator role data object containing: | |||
userAssignments | List of users to which you want to assign the Product Administrator role. | array | No | |
groupAssignments | List of groups to which you want to assign the Product Administrator role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_keytoken", "productAdmins" : { "userAssignments":[{"email":"user_email"}], "groupAssignments":[{"name":"group_name"}] } } |
...
This API enables you to assign the Alert Email Receiver product-level role to specific users and/or groups.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the product-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
productToken |
Unique identifier of the product. | string | Yes | ||
alertsEmailReceivers | Alert Email Receiver role data object containing: | |||
userAssignments | List of users to which you want to assign the Alert Email Receiver role. | array | No | |
groupAssignments | List of groups to which you want to assign the Alert Email Receiver role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_keytoken", "alertsEmailReceivers" : { "userAssignments":[{"email":"user_email"}], "groupAssignments":[{"name":"group_name"}] } } |
...
This API enables you to assign the Product Membership product-level role to specific users and/or groups.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the product-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
productToken |
Unique identifier of the product. | string | Yes | ||
productMembership | Product Membership role data object containing: | |||
userAssignments | List of users to which you want to assign the Product Membership role. | array | No | |
groupAssignments | List of groups to which you want to assign the Product Membership role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_keytoken", "productMembership" : { "userAssignments":[{"email":"user_email"}], "groupAssignments":[{"name":"group_name"}] } } |
...
This API enables you to assign the Product Default Approver product-level role to specific users and/or groups.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the product-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
productToken |
Unique identifier of the product. | string | Yes | ||
productApprovers | Product Approver role data object containing: | |||
userAssignments | List of users to which you want to assign the Product Approver role. | array | No | |
groupAssignments | List of groups to which you want to assign the Product Approver role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_keytoken", "productApprovers" : { "userAssignments":[{"email":"user_email"}], "groupAssignments":[{"name":"group_name"}] } } |
...
This API enables you to assign the Product Integrator product-level role to specific users and/or groups.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that assigns roles at the product-level. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
productToken |
Unique identifier of the product. | string | Yes | ||
productIntegrators | Product Integrator role data object containing: | |||
userAssignments | List of users to which you want to assign the Product Integrator role. | array | No | |
groupAssignments | List of groups to which you want to assign the Product Integrator role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_keytoken", "productIntegrators" : { "userAssignments":[{"email":"user_email"}], "groupAssignments":[{"name":"group_name"}] } } |
...
This API enables an organization admin to create a service user and generate its user token.
QUERY PARAMETERS
Parameter | Description | Type | Required | |
---|---|---|---|---|
requestType | API request type that creates a service user. | string | Yes | |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
addedUser | New service user data object containing: | |||
name | Name of service user you want to create. | string | Yes |
Request Example
Code Block |
---|
{ "requestType": "createServiceUser", "orgToken": "organization_api_key", "userKey": "user_key", "addedUser":{ "name":"ServiceUser2" } } |
...
This API allows an organization admin to regenerate the user token of a service user.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that regenerates a service user’s token key. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
serviceUserKey | Current token key for the service user. | string | Yes |
Request Example
Code Block |
---|
{ "requestType": "regenerateUserKey", "orgToken": "organization_api_key", "userKey": "user_key", "serviceUserKey": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } |
...
This API allows an organization admin to get a list of all the service users in an organization.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that returns all the service users in 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 a unique identifier of the organization. | string | Yes |
Request Example
Code Block |
---|
{ "requestType":"getOrganizationServiceUsers", "userKey":"user_key", "orgToken":"organization_api_key" } |
...
This API allows an organization admin to get a list of all the service users in a product.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that returns all the service users in a product. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
productToken |
Unique identifier of the product. | string | Yes |
Request Example
Code Block |
---|
{ "requestType":"getProductServiceUsers", "userKey":"user_key", "productToken":"product_token" } |
...
This API enables a WhiteSource account administrator to invite an external user to download and use WhiteSource Advise.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that enables a WhiteSource account administrator to invite an external user to download and use WhiteSource Advise. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSource. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
userEmail | Email address of the external user who will receive the invitation via email. | string | Yes |
Request Example
Code Block |
---|
{ "requestType" : "inviteUserToWebAdvisor", "userKey": "user_key", "orgToken" : "organization_api_key", "userEmail": "User email address" } |
...