Authentication and scopes

Secure API-key authentication, tenant isolation, and available scopes.

Authentication and scopes

Every endpoint requires a company API key:

Authorization: Bearer YOUR_API_KEY

API keys are tenant-bound. The API checks that programs, reports, assets, users,
and related objects belong to the company that issued the key. Cross-company
identifiers are returned as 404.

Available scopes

ScopeAllows
reports:readList reports and retrieve report details and comments
reports:commentAdd a program-visible report comment
reports:priority:writeChange report priority
reports:rewards:writeAssign bounties, bonuses, or swag
reports:status:writeChange report status
assets:writeCreate, update, or archive company assets
company:members:writeInvite or remove organization members
hunters:verifyVerify a hunter token

Keys created before scopes were introduced have reports:read only. Generate a
new key if a write endpoint returns a scope error. Any key containing a write
scope can be issued for at most 90 days.

Use separate keys for separate integrations, grant the minimum scopes required,
and rotate keys immediately if they are exposed.


Did this page help you?