Cypress.io · Authentication Profile

Cypressio Authentication

Authentication

Cypress.io secures its APIs with apiKey across 2 declared security schemes, as derived from its OpenAPI definitions.

CompanyTestingEnd-to-End TestingTest AutomationQuality AssuranceDeveloper ToolsCI/CDAccessibilityJavaScript
Methods: apiKey Schemes: 2 OAuth flows: API key in: query

Security Schemes

OrganizationApiKey apiKey
· in: query (token)
RecordKey apiKey
· in: other (record key)

Source

Authentication Profile

cypressio-authentication.yml Raw ↑ 
generated: '2026-07-18'
method: searched
source: https://docs.cypress.io/cloud/integrations/data-extract-api
docs: https://docs.cypress.io/cloud/integrations/data-extract-api
summary:
  types: [apiKey]
  api_key_in: [query]
  oauth2_flows: []
schemes:
- name: OrganizationApiKey
  type: apiKey
  in: query
  parameter: token
  applies_to: Cypress Cloud Data Extract API (enterprise reporting)
  provisioning: >-
    An organization API key is generated under Integrations -> Enterprise API in
    Cypress Cloud and passed on every request as the `token` query parameter.
  scope: Enterprise plan subscription required.
  sources: [https://docs.cypress.io/cloud/integrations/data-extract-api]
- name: RecordKey
  type: apiKey
  in: other
  parameter: record key
  applies_to: Recording test runs to Cypress Cloud (cypress run --record --key)
  provisioning: >-
    A per-project record key issued in Cypress Cloud, supplied to the runner via
    --key or the CYPRESS_RECORD_KEY environment variable. Not part of the REST
    reporting API; documented here for completeness.
  sources: [https://docs.cypress.io/app/references/command-line]