@apiquest/plugin-auth

Authentication plugins for ApiQuest. Provides Bearer, Basic, OAuth2, and API Key authentication support for HTTP-based protocols.

Installation

# Using npm
npm install -g @apiquest/plugin-auth

# Or using fracture CLI
fracture plugin install auth

Supported Authentication Types

• Bearer Token - Authorization: Bearer {token}
• Basic Auth - Username/password authentication
• OAuth2 - OAuth 2.0 client credentials flow
• API Key - Custom header or query parameter authentication

Usage

Authentication is configured at the collection, folder, or request level:

{
  "auth": {
    "type": "bearer",
    "bearer": {
      "token": "{{authToken}}"
    }
  }
}

Bearer Token

{
  "auth": {
    "type": "bearer",
    "bearer": {
      "token": "your-access-token"
    }
  }
}

Basic Authentication

{
  "auth": {
    "type": "basic",
    "basic": {
      "username": "{{username}}",
      "password": "{{password}}"
    }
  }
}

API Key

{
  "auth": {
    "type": "apikey",
    "apikey": {
      "key": "x-api-key",
      "value": "{{apiKey}}",
      "in": "header"
    }
  }
}

OAuth2 Client Credentials

{
  "auth": {
    "type": "oauth2",
    "oauth2": {
      "grantType": "client_credentials",
      "tokenUrl": "https://auth.example.com/oauth/token",
      "clientId": "{{clientId}}",
      "clientSecret": "{{clientSecret}}",
      "scope": "api:read api:write"
    }
  }
}

Compatibility

Works with protocol plugins that support HTTP-based authentication:

• @apiquest/plugin-http
• @apiquest/plugin-graphql
• @apiquest/plugin-sse

Documentation

• Fracture Documentation
• Schema Reference

License

Dual-licensed under AGPL-3.0-or-later and commercial license. See LICENSE for details.