How-do-I

Quick instructions for a number of things that you might want to do.

Where and how to get things done in Polaris

Task Who can Location How to do it
Change my personal notification settings
  • Any user
Account > Notifications
  1. Use Checkboxes to select the types of notifications you'd like to receive.
    Note: If Reports notifications are disabled, you will not receive an email when a report you created is ready. See Create a report for more detail.
  2. If all the checkboxes are disabled, it means the Org Admin has turned off notifications for the organization. If you made selections before notifications were disabled, they are saved and will be applied if notifications are enabled in the future.

Reset two-factor auth for another user
  • Org Admin
My Organization > Users See Reset 2FA.
Control Assessment Center access to published issues
  • Org Admin
My Organization > General Enable/disable Enable assessment center access to see published issues (enabled by default).
Disable notifications
  • Org Admin
My Organization > General Uncheck the box that says Enable email notifications for all users.
Create an application
  • Org Admin
  • Org Application Manager
Portfolio See Create an application.
Delete an application
  • Org Admin
  • Org Application Manager
Portfolio
  1. Find application. Click ellipse menu.
  2. Select Delete.
  3. Click OK on "Are you sure you want to delete the application? This action cannot be undone" popup.
View the applications linked to a subscription
  • Org Admin
My Organization > Subscriptions > (Select a subscription) Each active or deleted application linked to the subscription appears in the Applications table. Here, you'll find each application's name, the total number of active projects in each application, each application's created date, and the entitlements allowed for each application.
Create a new user
  • Org Admin
My Organization > Users See Invite users to join Polaris.
Give a user an org-level role or update information
  • Org Admin
My Organization > Users Select a user to modify and make the desired changes.
Deactivate a user
  • Org Admin
My Organization > Users Move the toggle under the Status column to the left. Deactivated users will be listed as Inactive and appear greyed-out. They will not be able to access your Organization's Polaris.
Delete a user
  • Org Admin
My Organization > Users Click the Trash Can icon under the Actions column. A confirmation appears. Click Yes to delete the user.
Note: An Org Admin can not delete their own account.
Export Issues to Download as a CSV or JSON files
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
  • Observers
Tests > Select Project > Issues
  1. From Issues List, select individual issues or skip to 2 and use "Export All."
  2. Click "Export 1 Selected" (how many selected issues will appear on button) or "Export All."
  3. Under Export to: select File.
  4. From File Type: pulldown select either CSV or JSON.
  5. Click Export button.
Export Audit Logs
  • Org Admin
My Organization > Audit Logs Filter by Date Range, Event Type and/or User's Email. Click Export All <count>.
Create a project
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
Portfolio > (Select an application) > Projects See Add a SAST & SCA project to an application.
Delete a project
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
Portfolio > (Select an application) > Projects
  1. Find project. Click ellipse menu.
  2. Select Delete.
  3. Click OK on "Are you sure you want to delete the project? This action cannot be undone" popup.
Monitor tests
  • Org Admin
  • Org Application Manager
  • Application Admins
  • Contributors
  • Members
  • Observers
Tests
  1. Use filters to see the test or tests you are interested in.
  2. Click a completed test to see results.
Filter and review issues from a test
  • Org Admin
  • Org Application Manager
  • Application Admins
  • Contributors
  • Members
  • Observers
Tests
  1. Select the test for which you'd like to see results.
  2. Use pulldown menus to filter issues.
  3. Click any issue for more detailed information.
Triage one or more issues
  • Org Admin
  • Org Application Manager
  • Application Admins
  • Contributors
  • Members
Portfolio > (Select an application) > (Select a project) > Issues See Ways to triage issues in Polaris.
Triage one or more components
  • Org Admin
  • Org Application Manager
  • Application Admins
  • Contributors
  • Members
Portfolio > (Select an application) > (Select a project) > Components See Ways to triage components in Polaris.
Upload files for testing
  • Org Admin
  • Org Application Manager
  • Application Admins
  • Contributors
  • Members
Portfolio > (Select an application) > Projects
  1. In the list of projects, find the project you want to scan and select Test this project.
  2. Use checkboxes to select test types. (The options depend on what your App Admin has made available for the project.)
  3. Submit the files you want to test by dragging and dropping into the browser window. Or click Browse Files and use the file chooser in your operating system to select files.

  4. After the upload completes, click Begin Test.
Make a token
  • Any user
Profile > Account > Access Tokens See Make an access token.
See which issues are fixed in latest scan
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
  • Observers
Projects > Tests > (Choose Test ID). View issues that appeared in the last scan, but not the current scan by selecting Absent Issues.
Add projects to an application that already has five
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Org Application Manager
From within the application, choose Settings and then Subscriptions. If the Add Project button in the application is disabled, go to the subscription settings page and increase the quantity of each subscription allocated to the application. The numeral to the right of each subscription can be edited, as long as your organization has more subscriptions available.
Create a report (summary/overview, compliance, audit, developer details)
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Reporting > + Create Report See Create a report.
Export a software bill of materials (SBOM)
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Reporting > + Create Report See Create a software bill of materials report.
View list of components used by a license
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
  • Observers
Portfolio > (Select an application) > (Select a project) > Licenses > (Select License).

Components will be listed under License Details.

Another option is from Components, filter by License.

You can use the branch pulldown (near the top of the page, next to the project name) to view licenses for different branches in your project.

Change the license used for a component
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Portfolio > (Select an application) > (Select a project) > Components tab > (Select a component) > Licenses tab in bottom pane.
  1. Click Change.
    Note: The Change button only appears when more than one licensing option is available (when one license/group of licenses OR a different license/group of licenses is available for the component).
  2. Select the best license for the use case from the Select a License pulldown menu.
    Note: Click the x button in the pulldown menu to reset the selection.
  3. Click Save.

    This change is for all the branches included in the project.

Add a branch to a project
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Portfolio > (Select an application) > Projects > (Select a project) > Branches See Add a branch to a project.
Change a project's default branch
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Portfolio > (Select an application) > Projects > (Select a project) > Branches See Change a project's default branch.
Delete a project's branch
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
Portfolio > (Select an application) > Projects > (Select a project) > Branches See Delete a branch.
Find the issues a non-default branch creates or resolves
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
  • Observers
Portfolio > (Select an application) > (Select a project) > Issues. See Compare default and non-default branches in a project.
Find the branches in which an issue exists
  • Org Admin
  • Org Application Manager
  • Application Admin
  • Contributors
  • Members
  • Observers
Portfolio > (Select an application) > (Select a project) > Issues.
  1. Select an issue.
  2. The names of branches in which the issue exists appear in the Also Detected In section of the Issue Details tab.
    Note: This list only appears when an issue is detected in more than one branch.