...
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
This API enables you to assign the Default Approver role to a specific groupspecific users and groups in an organization.
NOTE: The Product level Default Approver overrides the Organization level Default Approver for their relevant Product(s).
...
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: | ||||||
groupAssignment | Group to which you want to assign the Default Approver role. | string | No | ||||
userAssignment | Email address of specific user to which you want to assign the Default Approver role. | string | No | ||||
groupAssignments | List of groups to which you want to assign the Default Approver 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 Approver role. | array | No | NOTE: Only the first value in the array of users will be assigned the 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"}] } } |
...
This API enables you to assign the Product Default Approver product-level role to specific users and /or groups at the product-level.
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: | |||
userAssignment | Email address of specific user to which you want to assign the Default Approver role. | string | No | |
groupAssignment | Group to which you want to assign the Default Approver role. | string | No | |
userAssignments | List of email addresses of users to which you want to assign the Product Approver Default Approver 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 Product Default Approver role. NOTE: Only the first value in the array of groups will be assigned the role. | array | No |
Request Example
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_token", "productApprovers" : { "userAssignments":[{"email":"user_email"},{"email":"user_email"}], "groupAssignmentsgroupAssignment":[{"name":"group_name"}] } } |
...