The partner admin dashboard is the web UI for organizations using the Kanary Partner API and/or managing subscriptions directly managed by employees. It complements the REST API documented in this repository: admins use the dashboard for onboarding, credentials, billing, and usage visibility.
Admin URL: https://my.kanary.com/dashboard/settings/admin
| Identity | Purpose | How it is represented |
|---|---|---|
| Dashboard admin | Sign in to the web UI using your email & password; request API access; billing; usage | A person with their own Kanary Account, the account is active, and it is linked to your Partner (admin-only or admin + service, depending on setup) |
| API key | Authenticate Partner API calls for the organization | Issued in the dashboard API settings; sent as Authorization: Bearer <api_key>. Org-level credential scoped to your partner—not your personal dashboard login |
MFA is strongly encouraged for all dashboard admin accounts. These users can request API access, issue or rotate API keys, and manage Stripe billing.
If your organization is not already set up to use Okta or EntraID SSO with Kanary, enable MFA in the dashboard account or security settings after your first sign-in.
New partners start in the dashboard by requesting API access for their organization. Kanary reviews the request, provisions a Partner record, links it to your admin Account, and enables API key issuance in the dashboard.
Until access is approved and billing is configured:
403 Forbidden even if you can sign in.After approval, the dashboard reflects an active partner and unlocks billing and usage views.
The dashboard is where admins issue, copy, and revoke API keys used on Partner API calls. Keys are not obtained via POST /api/kanary/auth/login/ or email/password—see Authentication.
| Task | Where |
|---|---|
| Issue or copy an API key | Admin dashboard (API settings) |
| Use key on API requests | Authorization: Bearer <api_key> on all Partner API routes |
| Revoke a key | Admin dashboard, or POST /api/kanary/auth/logout/ (Authentication) |
Typical flow after API access has been approved:
Authorization: Bearer <api_key>.Key lifetime, rotation, and revocation are described in Authentication.
Billing is managed in the dashboard through Kanary’s Stripe integration. The payment method lives in the dashboard; seats can be purchased either in the dashboard or through the API against that payment method.
| Topic | Dashboard | API |
|---|---|---|
| Payment method | Add or update card | Not exposed. Required before API purchases succeed |
| Invoices and receipts | View and download (Stripe) | Not listed. Each POST /api/v1/seats/ response includes invoice_url for that purchase |
| Seat and credit purchases | Purchase subscription seats and on-demand credits | Buy via POST /api/v1/seats/; read inventory via GET /api/v1/seats/ |
| Partner activation | Completes when payment requirements are met | Blocked until active |
After the first successful payment, Kanary activates the partner. See Authentication.
The admin dashboard is the primary place to monitor and control usage across your enrolled population. Aggregated metrics are shown in the UI; per-profile exposures use the API (Account API, Exposure API).
| Metric | What it represents | Typical use |
|---|---|---|
| Seats purchased | Subscription seats and on-demand credits | Cap enrollment and credit pools; align spend with contract |
| Seats in use | Subscription seats assigned, and on-demand credits assigned to accounts (including credits already spent) | Stay within purchased units |
| Scan credits | Balance per on-demand product on the member. POST /api/v1/scan/ spends one credit per member. See Scan credits |
Budget scans; assign credits before the balance hits 0 |
| Removals completed | Exposures mitigated or removed | Outcome reporting for your customers or leadership |
Use these views to:
GET /api/v1/seats/ and POST /api/v1/accounts/.GET /api/v1/members/{member_id}/credits/ before POST /api/v1/scan/.