Table of Contents |
---|
Info |
---|
NOTES:
|
...
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 fetch organizational information, but don't want to grant them full admin permissions.
NOTE: The groupAssignment and userAssignment are single entity fields, while groupAssignments and userAssignments are arrays that support receiving multiple values.
Code Block |
---|
{ "requestType" : "setOrganizationAssignments", "userKey":"admin_user_key" "orgToken" : "organization_api_key", "readOnlyUsers" : { "groupAssignments":[{"name":"group_name"},{"name":"group_name"}], // This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single user. "userAssignments":[{"email":"user_email"},{"email":"user_email"}], //This parameter will be deprecated } } |
Response Format
Code Block |
---|
"message": "The following organization assignments have been set: Read Only" |
Set Product Assignments
You can assign a Product-level role to specific users or to a group of users using the below API calls. The following roles are supported:
Product Administrators
...
shortly. Only the first value in each array will be used, since the default approver role only supports a single group.
"groupAssignment":{"name":"group_name"},{"name":"group_name"},
"userAssignment":{"email":"user_email"},{"email":"user_email"}
}
} |
Response Format
Code Block |
---|
"message": "The following organization assignments have been set: Read Only" |
Set Product Assignments
You can assign a Product-level role to specific users or to a group of users using the below API calls. The following roles are supported:
Product Administrators
Product Administrators have control over the entire product, they can rename and delete the product, and all the projects under it.
...
They can also view data on the product and all projects under it, and open tickets for libraries.
NOTE: The groupAssignment and userAssignment are single entity fields, while groupAssignments and userAssignments are arrays that support receiving multiple values.
Code Block |
---|
{ "requestType": "setProductAssignments", "userKey": "user_key", "productToken": "product_api_key", "productIntegrators" : { "userAssignments":[{"email":"user_email"}], // This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single user. "groupAssignments":[{"name":"group_name"}], //This parameter will be deprecated shortly. Only the first value in each array will be used, since the default approver role only supports a single group. "userAssignment":{"email":"user_email"}, "groupAssignment":{"name":"group_name"} } } |
Response Format
Code Block |
---|
"message":"Successfully set product assignments" |
...
UNKNOWN - either orgToken or requestToken are invalid
IN_PROGRESS - update is in progress
UPDATED - inventory has been modified yet alerts have not been calculated yet
FINISHED - alerts have been calculated successfully
FAILED - an error has occurred during the update process
SKIPPED - when a scan for a project is requested while a scan for the same project is being executed simultaneously, the new scan is skipped
The timestamp field is in UTC formatGMT time.
The requestToken (also displayed as "Support Token" when printing results to the console from the plugins) can be found in the data of the response returned form the server).
...