RapidAPI · Schema

AuthenticationConfig

API MarketplaceAPI ManagementAPI TestingAPI GatewayAPI DesignEnterprise

Properties

Name Type Description
gatewayId string The gateway this configuration belongs to
scheme string The primary authentication scheme
requireRapidApiKey boolean Whether the X-RapidAPI-Key header is required for all requests
oauth2Config object OAuth2 configuration when scheme is oauth2
headerConfig object Header authentication configuration
View JSON Schema on GitHub

JSON Schema

rapidapi-authenticationconfig-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/AuthenticationConfig",
  "title": "AuthenticationConfig",
  "type": "object",
  "properties": {
    "gatewayId": {
      "type": "string",
      "description": "The gateway this configuration belongs to"
    },
    "scheme": {
      "type": "string",
      "enum": [
        "rapidapi_default",
        "oauth2",
        "header",
        "query",
        "basic"
      ],
      "description": "The primary authentication scheme"
    },
    "requireRapidApiKey": {
      "type": "boolean",
      "description": "Whether the X-RapidAPI-Key header is required for all requests"
    },
    "oauth2Config": {
      "type": "object",
      "properties": {
        "authorizationUrl": {
          "type": "string",
          "format": "uri",
          "description": "OAuth2 authorization endpoint"
        },
        "tokenUrl": {
          "type": "string",
          "format": "uri",
          "description": "OAuth2 token endpoint"
        },
        "scopes": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Available OAuth2 scopes"
        }
      },
      "description": "OAuth2 configuration when scheme is oauth2"
    },
    "headerConfig": {
      "type": "object",
      "properties": {
        "headerName": {
          "type": "string",
          "description": "Custom header name for authentication"
        }
      },
      "description": "Header authentication configuration"
    }
  }
}