...
getting all groups and users in an organization
creating groups and users
inviting users to your organization
adding and removing users to/from groups
removing users from an organization
getting organization-level and product-level role assignments
assigning an organization-level or product-level role to specific users or to a group of users according to specific roles
creating a service user
regenerating a user token for a service user
getting all organization and product service users
inviting an external user to download and use WhiteSource Mend Advise for Chrome
Get Groups
...
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 WhiteSourceMend. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
...
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 WhiteSourceMend. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
...
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 WhiteSourceMend. | string | Yes |
productToken | Unique identifier of the product. | string | Yes |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | string | Yes | |
orgToken | API key which is a unique identifier of the organization. | string | Yes | |
defaultApprovers | Default Approvers role data object containing: | |||
groupAssignment | Group to which you want to assign the Default Approvers role. | string | No | |
userAssignment | Email address of specific user to which you want to assign the Default Approvers role. | string | No | |
groupAssignments | List of groups to which you want to assign the Default Approvers role. NOTE: Only the first value in the array of groups will be assigned the role. | array | No | |
userAssignments | List of email addresses of users to which you want to assign the Default Approvers role. NOTE: Only the first value in the array of users will be assigned the role. | array | No |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | string | Yes | |
productToken | Unique identifier of the product. | string | Yes | |
alertsEmailReceivers | Alert Email Receivers role data object containing: | |||
userAssignments | List of users to which you want to assign the Alert Email Receivers role. | array | No | |
groupAssignments | List of groups to which you want to assign the Alert Email Receivers role. | array | No |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | string | Yes | |
productToken | Unique identifier of the product. | string | Yes | |
productApprovers | Product Approvers role data object containing: | |||
userAssignment | Email address of specific user to which you want to assign the Default Approvers role. | string | No | |
groupAssignment | Group to which you want to assign the Default Approvers role. | string | No | |
userAssignments | List of email addresses of users to which you want to assign the Default Approvers role. NOTE: Only the first value in the array of users will be assigned the role. | array | No | |
groupAssignments | List of groups to which you want to assign the Default Approvers role. NOTE: Only the first value in the array of groups will be assigned the role. | array | No |
...
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 WhiteSourceMend. | string | Yes | |
productToken | Unique identifier of the product. | string | Yes | |
productIntegrators | Product Integrators role data object containing: | |||
userAssignments | List of users to which you want to assign the Product Integrators role. | array | No | |
groupAssignments | List of groups to which you want to assign the Product Integrators role. | array | No |
...
Service Users communicate with WhiteSource Mend via the APIs for automation purposes; they cannot log in to the Web Console. Organization administrators manage Service Users via the GUI. You can assign a service user to one or more groups.
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | 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 |
...
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 WhiteSourceMend. | string | Yes |
orgToken | API key which is a unique identifier of the organization. | string | Yes |
...
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 WhiteSourceMend. | string | Yes |
productToken | Unique identifier of the product. | string | Yes |
...
Code Block |
---|
{ "serviceUsers": [ { "serviceUserName": "WS_4_GHC_service_user", "serviceUserToken": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" } ] } |
Invite User
...
to Mend Advise for Chrome
WhiteSource Mend Advise allows your developers to view a snapshot of a component’s details before they download it to their repository, and incorporate it in the codebase.
This API enables a WhiteSource Mend account administrator to invite an external user to download and use WhiteSource Mend Advise.
QUERY PARAMETERS
Parameter | Description | Type | Required |
---|---|---|---|
requestType | API request type that enables a WhiteSource Mend account administrator to invite an external user to download and use WhiteSource Mend Advise. | string | Yes |
userKey | The ID of the user’s profile, which uniquely identifies the user in WhiteSourceMend. | 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 |
...