CHIRP Wireless Authentication

generated: '2026-11-03'
method: searched
source: https://docs.chirpwireless.io/api/authentication-and-api-keys
docs: https://docs.chirpwireless.io/api/authentication-and-api-keys
summary:
  types:
  - apiKey
  api_key_in:
  - header
  note: "This is API-key authentication; you do not create a separate cryptographic signature for the request."
schemes:
- name: ApiKeyAuth
  type: apiKey
  in: header
  parameter: X-API-Key
  description: 'API key for authentication (format: `chirp_<key>`)'
  key_prefix: chirp_
  sources:
  - openapi/chirpwireless-io-openapi.yml
  - https://docs.chirpwireless.io/api/authentication-and-api-keys
- name: OrgId
  type: apiKey
  in: header
  parameter: X-Organization-Id
  description: "Organization UUID that the API key belongs to. Docs: it has to match the home the key was made in. The authentication gateway requires this header. An organizationId query value required by a particular call is additional; it cannot replace the header."
  sources:
  - openapi/chirpwireless-io-openapi.yml
  - https://docs.chirpwireless.io/api/authentication-and-api-keys
- name: MCP account sign-in
  type: browser-sign-in
  description: "The MCP server (https://mcp-auth.chirpwireless.io/mcp) uses sign-in with the user's Chirp account in the browser; the docs say there's no key to generate, copy, or paste. The flow/protocol is not specified further in the docs."
  sources:
  - https://docs.chirpwireless.io/api/mcp-server
key_management:
  docs: https://docs.chirpwireless.io/settings/api-keys
  shown_once: true
  expiry: optional expiry date; blank means active until revoked
  rotation: "Rotate generates a new key and marks the current key as rotated; the old key will stop working (rotateApiKey)."
  revocation: revokeApiKey
  statuses: [Active, Rotated, Revoked]
api_key_scopes:
  note: "Scopes are chosen per key (at least one). Docs: 'Available scopes may depend on your home's plan.' Insufficient scope returns 403 Forbidden (OpenAPI info.description). Scope names below are those listed as 'Required scope' in the OpenAPI operation descriptions."
  scopes: [api-keys:read, api-keys:write, commands:read, commands:write, connections:read, connections:write, connectors:read, dashboards:read, dashboards:write, devices:read, devices:write, orgs:read, orgs:write, rules:read, rules:write, sensors:read, sensors:write, subscriptions:read, telemetry:read, users:read, users:write]