Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing organization assignments have been set: Admins"

Back to top

Alert Email Receiver Role

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing organization assignments have been set: Alerts Email Receivers"

Back to top

Default Approver Role

...

Code Block
"message": "The following organization assignments have been set: Read Only" 

Back to top

Set Product Assignments

...

  • Product Administrator

  • Alert Email ReceiverReceivers

  • Product Membership

  • Product Default ApproverApprovers

  • Product IntegratorIntegrators

Product Administrator Role

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing product assignments have been set: Admins"

Back to top

Alert Email

...

Receivers Role

This API enables you to assign the Alert Email ReceiverReceivers product-level role to specific users and/or groups.

...

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 Receivers role data object containing:

userAssignments

List of users to which you want to assign the Alert Email Receiver Receivers role.

array

No

groupAssignments

List of groups to which you want to assign the Alert Email Receiver Receivers role.

array

No

Request Example

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing product assignments have been set: Alerts Email Receivers"

Back to top

Product Membership Role

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing product assignments have been set: Membership"

Back to top

Product Default

...

Approvers Role

If the role of Product Approver is not assigned, all product tickets are sent to the organization’s Default ApproverApprovers. Any member of the organization can be assigned to this role. You can also assign the Default Approver Approvers to a specific group. Changing the Product Approver will only affect future pending tasks, existing tasks will still be assigned to their original approver.

...

This API enables you to assign the Default ApproverApprovers role to specific users and groups at the product-level.

...

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 Approvers role data object containing:

userAssignment

Email address of specific user to which you want to assign the Default Approver Approvers role.

string

No

groupAssignment

Group to which you want to assign the Default Approver Approvers role.

string

No

userAssignments

List of email addresses of users to which you want to assign the Default Approver 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 Approver Approvers role.

NOTE: Only the first value in the array of groups will be assigned the role.

array

No

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing product assignments have been set: Default Approvers"

Back to top

Product

...

Integrators Role

Product Integrators can run a scan on a new or existing project within the product. They can also view data on the product and all its projects, and open tickets for libraries.

This API enables you to assign the Product IntegratorIntegrators product-level role to specific users and/or groups.

...

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 Integrators role data object containing:

userAssignments

List of users to which you want to assign the Product Integrator Integrators role.

array

No

groupAssignments

List of groups to which you want to assign the Product Integrator Integrators role.

array

No

Request Example

...

Response Example

Code Block
"message":"SuccessfullyThe setfollowing product assignments have been set: Integrators"

Back to top

Service Users

...