Skip to main content
POST
Save a scan account

Authorizations

X-API-Key
string
header
required

API key for authentication

Headers

X-Organization-Id
string

Organization ID (required for session auth, optional for API key auth)

Body

application/json
label
string
required

Short name used to attribute findings to this account, e.g. "auditor".

Maximum string length: 40
Example:

"auditor"

kind
enum<string>
required

How the credential travels: 'cookie' sends value as the Cookie header, 'headers' replays the headers set.

Available options:
cookie,
headers
targetUrl
string
required

URL the credential is probed against before it is saved. It must be the application this account signs in to, or the probe proves nothing.

Example:

"https://app.example.com"

value
string

Raw Cookie header value. Required when kind is "cookie". Never echoed back.

Maximum string length: 8192
headers
object[]

Header set to replay. Required when kind is "headers". Never echoed back.

role
string

Role this account represents in the app, e.g. "auditor". Reporting metadata only — the scan never enforces it.

Maximum string length: 40
tenant
string

Tenant or workspace the account belongs to. Reporting metadata only — the scan never enforces it.

Maximum string length: 60

Response

Saved scan account returned