- Home
- Getting Started
- Getting Started
Getting Started¶
Audience: All client users · What this covers: signing in, multi-factor authentication, and finding your way around the portal.
What Canima is¶
Canima is an AI-powered continuous offensive-security platform. Through it your organization runs penetration tests and vulnerability scans, monitors its external attack surface, and receives client-ready reports — all from one portal at app.canima.com.
Signing in¶
- Go to app.canima.com. You'll see the sign-in screen.
- Enter your email address and click Continue.
- Enter your password.
- If your account (or organization) uses multi-factor authentication, enter the 6-digit code from your authenticator app.
Forgot your password?
Use Forgot password? on the sign-in screen to reset it. If your session expires, you'll be returned here to sign in again.
First time in?
If your organization requires MFA, you'll be taken straight to the enrollment screen on first sign-in — set it up (see Settings & Security) and you'll land on your dashboard.
Your first visit¶
The first time you sign in, a Welcome to Canima dialog offers to help you get set up:
- Take a guided tour walks you through creating your first assessment, pointing out where to click along the way.
- Get started opens a Getting started checklist on your Dashboard: Complete your profile, Create your first assessment, and Invite a teammate.
- Skip for now dismisses it.
You can come back to either later from the user menu: Getting started reopens the checklist and Take the tour restarts the tour.
Finding your way around¶
After signing in you land on the Dashboard. The layout is consistent everywhere:
- Left sidebar: your main navigation. Use the collapse toggle to shrink it to icons (hover to see labels).
- Top bar: your organization name and the current page on the left; Search, the theme toggle, notifications, and your user menu on the right.
- Tab rows: larger sections (Analytics, Attack Surface, Administration) show their pages as tabs across the top. Where a tab is a group, a second row underneath shows its sub-pages.
The top bar¶
| Control | What it does |
|---|---|
| Search (⌘K on Mac, Ctrl K elsewhere) | Search your assets, findings, assessments and the portal's pages, then jump straight to the result. |
| Theme toggle | Switch between light and dark mode. Light is the default; your choice is remembered. |
| Notifications (bell) | Your most recent notifications with an unread count. Mark all read clears the count; View all notifications opens the full inbox. See Activity & Notifications. |
| User menu | Settings, Licenses, Credentials (owners and managers), Getting started, Take the tour, Docs (opens this documentation), and Sign out. |
The main navigation¶
In order, a client user sees:
-
Dashboard
Your security posture at a glance.
-
Analytics
Trends, remediation outcomes, and breakdowns by asset, project, and recurrence.
-
Assessments
Run and review pentests/scans.
-
Asset Library
Your inventory of domains, IPs, and apps.
-
Findings
Every discovered issue, org-wide.
-
Activity
A dated log of what happened across your organization.
-
Attack Surface
Continuous external monitoring (if licensed).
-
Support
The status of your support tickets and a link to the support portal (only when enabled for your deployment).
-
Settings
Your profile, sign-in security, and notification preferences.
Settings looks different for owners and managers
Members and viewers also get read-only Licenses, SLA Targets and Integrations tabs under Settings. Owners and managers manage those in Administration instead, so their Settings shows just Profile, Security and Notifications.
Managers and owners: Administration
Managers and owners also see an Administration item for managing the organization. Its tabs are grouped as:
- Organization: General (including SLA targets), Licenses, Single Sign-On, Security
- People: Members, Teams & Access
- Integrations: Integrations, Alerts, API Keys
- Scanning: OVA Management, Credentials
- Audit log
OVA Management only appears when your organization holds an internal-network license.
MSSPs and pentest firms
If your organization manages client organizations, you'll also see a client switcher in the top bar and Portfolio / Clients in the sidebar. See For MSSPs & Pentest Firms.
What you can see and do depends on your role¶
Client accounts have roles, and they change what's available:
| Role | Access |
|---|---|
| Owner / Manager | Full access to the organization, including Administration and the ability to launch assessments (which spends license capacity). |
| Member | Works with the assessments, findings, and assets they've been granted access to; cannot launch assessments or open Administration. |
| Viewer | Read-only access to what they've been granted. |
Missing a section or button?
If a section or button described in these guides doesn't appear for you, it's most likely gated to a higher role. Ask an owner/manager in your organization for access.
Getting help¶
Choose Docs in the user menu to open this documentation. If Support appears in your sidebar, it lists your support tickets and their status; Open support portal takes you to the portal where you open and reply to tickets.
Tips¶
Tip
- Enroll in MFA early. It's the best protection for your account (how).
- Press ⌘K / Ctrl K anywhere to search instead of clicking through menus.
- Lost? Click Dashboard (top of the sidebar) or the Canima logo to get home.
Related: Home Dashboard · Settings & Security · Running an Assessment