Allowing global auth headers

Author: ymao1

src/platform/packages/shared/kbn-connector-specs/README.md

@@ -57,7 +57,12 @@ export const MyConnector: SingleFileConnectorDefinition = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: ['bearer'],
+  auth: {
+    types: ['bearer'],
+    headers: {
+      'Content-Type': 'application/json',
+    }
+  },
 
   schema: z.object({
     url: z.string().url().describe('API URL'),
@@ -155,17 +160,23 @@ are specified, defaults to no authentication. Can also specify a custom schema f
 which will be used in place of the default
 
 ```typescript
-authTypes: [
-  // use basic auth type with the default schema
-  'basic',
-  // use api_key_header auth type with a custom header field
-  {
-    type: 'api_key_header',
-    defaults: {
-      headerField: 'custom-api-key-field'
+auth: {
+  types: [
+    // use basic auth type with the default schema
+    'basic',
+    // use api_key_header auth type with a custom header field
+    {
+      type: 'api_key_header',
+      defaults: {
+        headerField: 'custom-api-key-field'
+      }
     }
+  ],
+  // optionally add headers that will be added to all requests
+  headers: {
+    'Content-Type': 'application/json',
   }
-]
+}
 ```
 
 ### Schema

src/platform/packages/shared/kbn-connector-specs/src/connector_spec.ts

@@ -24,7 +24,7 @@
 import type { z } from '@kbn/zod/v4';
 import type { Logger } from '@kbn/logging';
 import type { LicenseType } from '@kbn/licensing-types';
-import type { AxiosInstance } from 'axios';
+import type { AxiosHeaderValue, AxiosInstance } from 'axios';
 
 export { UISchemas } from './connector_spec_ui';
 
@@ -239,7 +239,10 @@ export interface AuthTypeDef {
 export interface ConnectorSpec {
   metadata: ConnectorMetadata;
 
-  authTypes?: Array<string | AuthTypeDef>;
+  auth?: {
+    types: Array<string | AuthTypeDef>;
+    headers?: Record<string, AxiosHeaderValue>;
+  };
 
   // Single unified schema for all connector fields (config + secrets)
   // Mark sensitive fields with withUIMeta({ sensitive: true })

src/platform/packages/shared/kbn-connector-specs/src/lib/generate_secrets_schema_from_spec.test.ts

@@ -12,23 +12,28 @@ import { generateSecretsSchemaFromSpec } from './generate_secrets_schema_from_sp
 
 describe('generateSecretsSchemaFromSpec', () => {
   test('correctly generates schemas for array of auth types', () => {
-    const schema = generateSecretsSchemaFromSpec([
-      'none',
-      'basic',
-      'bearer',
-      'oauth_client_credentials',
-      {
-        type: 'api_key_header',
-        defaults: {
-          headerField: 'custom-api-key-field',
+    const schema = generateSecretsSchemaFromSpec({
+      types: [
+        'none',
+        'basic',
+        'bearer',
+        'oauth_client_credentials',
+        {
+          type: 'api_key_header',
+          defaults: {
+            headerField: 'custom-api-key-field',
+          },
         },
+      ],
+      headers: {
+        'X-Custom-Header': 'CustomValue',
       },
-    ]);
+    });
     expect(z.toJSONSchema(schema)).toMatchSnapshot();
   });
 
   test('returns empty object schema when no auth types are provided', () => {
-    const schema = generateSecretsSchemaFromSpec([]);
+    const schema = generateSecretsSchemaFromSpec({ types: [] });
     expect(z.toJSONSchema(schema)).toMatchSnapshot();
   });
 });

src/platform/packages/shared/kbn-connector-specs/src/lib/generate_secrets_schema_from_spec.ts

@@ -11,9 +11,9 @@ import { z } from '@kbn/zod/v4';
 import type { ConnectorSpec } from '../connector_spec';
 import { getSchemaForAuthType } from '.';
 
-export const generateSecretsSchemaFromSpec = (authTypes: ConnectorSpec['authTypes']) => {
+export const generateSecretsSchemaFromSpec = (authSpec: ConnectorSpec['auth']) => {
   const secretSchemas: z.core.$ZodTypeDiscriminable[] = [];
-  for (const authType of authTypes || []) {
+  for (const authType of authSpec?.types || []) {
     secretSchemas.push(getSchemaForAuthType(authType));
   }
   return secretSchemas.length > 0

src/platform/packages/shared/kbn-connector-specs/src/specs/abuseipdb.ts

@@ -31,14 +31,9 @@ export const AbuseIPDBConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'Key',
-      },
-    },
-  ],
+  auth: {
+    types: [{ type: 'api_key_header', defaults: { headerField: 'Key' } }],
+  },
 
   actions: {
     checkIp: {

src/platform/packages/shared/kbn-connector-specs/src/specs/alienvault_otx.ts

@@ -31,14 +31,9 @@ export const AlienVaultOTXConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'X-OTX-API-KEY',
-      },
-    },
-  ],
+  auth: {
+    types: [{ type: 'api_key_header', defaults: { headerField: 'X-OTX-API-KEY' } }],
+  },
 
   actions: {
     getIndicator: {

src/platform/packages/shared/kbn-connector-specs/src/specs/greynoise.ts

@@ -31,14 +31,9 @@ export const GreyNoiseConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'key',
-      },
-    },
-  ],
+  auth: {
+    types: [{ type: 'api_key_header', defaults: { headerField: 'key' } }],
+  },
 
   actions: {
     getIpContext: {

src/platform/packages/shared/kbn-connector-specs/src/specs/shodan.ts

@@ -31,14 +31,9 @@ export const ShodanConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'X-Api-Key',
-      },
-    },
-  ],
+  auth: {
+    types: [{ type: 'api_key_header', defaults: { headerField: 'X-Api-Key' } }],
+  },
 
   actions: {
     searchHosts: {

src/platform/packages/shared/kbn-connector-specs/src/specs/urlvoid.ts

@@ -32,14 +32,9 @@ export const URLVoidConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'X-Api-Key',
-      },
-    },
-  ],
+  auth: {
+    types: [{ type: 'api_key_header', defaults: { headerField: 'X-Api-Key' } }],
+  },
 
   actions: {
     scanDomain: {

src/platform/packages/shared/kbn-connector-specs/src/specs/virustotal.ts

@@ -31,19 +31,15 @@ export const VirusTotalConnector: ConnectorSpec = {
     supportedFeatureIds: ['workflows'],
   },
 
-  authTypes: [
-    {
-      type: 'api_key_header',
-      defaults: {
-        headerField: 'x-apikey',
+  auth: {
+    types: [
+      {
+        type: 'api_key_header',
+        defaults: { headerField: 'x-apikey' },
+        overrides: { meta: { 'x-apikey': { placeholder: 'vt-...' } } },
       },
-      overrides: {
-        meta: {
-          'x-apikey': { placeholder: 'vt-...' },
-        },
-      },
-    },
-  ],
+    ],
+  },
 
   actions: {
     scanFileHash: {