Permissions
Whether an endpoint works depends on two things: is the product enabled for your firm, and does the key’s scope allow it.
Plan entitlement
Each product is tied to a plan entitlement. If your firm does not have it, the product’s endpoints return 403. GET /v1/me tells you which products are enabled.
| Product | Plan entitlement |
|---|---|
| Infostealer Detection | api_access |
| Intelligence 360 | intel_customer |
| Portfolio Monitoring | intel_watch |
| Threat Investigation | intel_hunter |
Scopes
A scope is resource:level: read reads, write writes and also covers reading. *:* is full access; we recommend creating keys with the least privilege.
Access type
A key either accesses all resources or is restricted to certain protection resource groups. A restricted key sees a record outside its allowed groups as 404.