Replace the API credential of a Bugcrowd source
Replace the Bugcrowd API credential of a Bugcrowd source, for example after it expired or was revoked. Team admins only. Bugcrowd checks it and Neo reads the first page of submissions first. On success the source is enabled again and a synchronization is queued.
Authorizations
JWT authentication token
Path Parameters
Source id
Body
A Bugcrowd API credential (Bugcrowd: profile, API Credentials). Bugcrowd shows it as an identifier and a secret; it is sent as "Authorization: Token identifier:secret". Write-only: never returned.
Response
Credential replaced and a synchronization queued
A Triage source of your team. Credentials are never returned: credential_configured shows whether one is stored.
Incremented by every change of documentation, request template, pagination or mapping.
The name to show: the display name set in the source settings, or the source name when none is set. Inbox listings keep writing the provider name to name; they never change the display name.
Documentation reference of a source. Pasted documents are not returned.
True when scheduled synchronization is on.
hackerone, github and gmail are built-in connections; custom_api is a source you configure.
hackerone, github, gmail, custom_api, scanner Interval between scheduled synchronizations.
1h, 6h, 12h, 24h documentation reads an OpenAPI 3 or Swagger 2 document to propose the configuration; manual takes the configuration as entered.
documentation, manual Server-controlled lifecycle state of a source. A failed scheduled or manual synchronization sets failed and backs the next one off (the schedule interval times 2^min(failures, 4), at most 24 hours later). After 10 failed synchronizations in a row the source is paused: disabled, enabled false, last_error_code kept. A successful synchronization or re-enabling the source resets the count.
draft, analyzing, configuration_required, testing, setting_up, ready, syncing, failed, disabled, removed Configuration version that last passed a test (0 when none). Synchronization needs it to equal configuration_version.
The auto triage rule of a source as the source list shows it.
Stable code of the last failure, such as target_not_public or upstream_status. On a ready source it is a warning from the last synchronization, such as record_limit or page_limit when the listing was longer than one synchronization reads.
Dot paths from each provider record to the normalized finding fields. external_key identifies a record inside the source.
Custom API sources: the next scheduled synchronization. HackerOne and Security Inbox sources: the next refresh of the built-in refresh job, which reads the first page of the connection. GitHub sources are refreshed by listing only.
How a synchronization walks the listing.
Set on a custom API source whose configuration Neo writes and keeps (a connected Bugcrowd account). Its documentation, request template, pagination, mapping and steps cannot be changed, and it is not analyzed.
bugcrowd The request a synchronization sends. Header and query values are stored and returned as typed, so never put a credential in them.
Present only when kind is scanner.
Custom API sources with the source-setup agent on: the outcome of the last analysis or test run, in plain terms. Absent until one finished.
Requests sent in order before the findings request (a login, a token exchange), at setup and at every synchronization. Values a step captures, and the credential fields, are used as {{$name}} placeholders in header values, query values, the URL path and query, and body strings of later steps and of request_template.
3
