[7.x] [New platform] HTTP & Security integration (#34631)

docs/development/core/server/kibana-plugin-server.authenticationhandler.md

@@ -0,0 +1,10 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthenticationHandler](./kibana-plugin-server.authenticationhandler.md)
+
+## AuthenticationHandler type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type AuthenticationHandler<T> = (request: Request, sessionStorage: SessionStorage<T>, t: AuthToolkit) => Promise<AuthResult>;
+```

docs/development/core/server/kibana-plugin-server.authtoolkit.authenticated.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthToolkit](./kibana-plugin-server.authtoolkit.md) > [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md)
+
+## AuthToolkit.authenticated property
+
+Authentication is successful with given credentials, allow request to pass through
+
+<b>Signature:</b>
+
+```typescript
+authenticated: (credentials: any) => AuthResult;
+```

docs/development/core/server/kibana-plugin-server.authtoolkit.md

@@ -0,0 +1,20 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthToolkit](./kibana-plugin-server.authtoolkit.md)
+
+## AuthToolkit interface
+
+A tool set defining an outcome of Auth interceptor for incoming request.
+
+<b>Signature:</b>
+
+```typescript
+export interface AuthToolkit 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(credentials: any) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
+|  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(url: string) =&gt; AuthResult</code> | Authentication requires to interrupt request handling and redirect to a configured url |
+|  [rejected](./kibana-plugin-server.authtoolkit.rejected.md) | <code>(error: Error, options?: {`<p/>`        statusCode?: number;`<p/>`    }) =&gt; AuthResult</code> | Authentication is unsuccessful, fail the request with specified error. |
+

docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthToolkit](./kibana-plugin-server.authtoolkit.md) > [redirected](./kibana-plugin-server.authtoolkit.redirected.md)
+
+## AuthToolkit.redirected property
+
+Authentication requires to interrupt request handling and redirect to a configured url
+
+<b>Signature:</b>
+
+```typescript
+redirected: (url: string) => AuthResult;
+```

docs/development/core/server/kibana-plugin-server.authtoolkit.rejected.md

@@ -0,0 +1,13 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthToolkit](./kibana-plugin-server.authtoolkit.md) > [rejected](./kibana-plugin-server.authtoolkit.rejected.md)
+
+## AuthToolkit.rejected property
+
+Authentication is unsuccessful, fail the request with specified error.
+
+<b>Signature:</b>
+
+```typescript
+rejected: (error: Error, options?: {
+        statusCode?: number;
+    }) => AuthResult;
+```

docs/development/core/server/kibana-plugin-server.httpservicesetup.md

@@ -0,0 +1,10 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md)
+
+## HttpServiceSetup type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type HttpServiceSetup = HttpServerInfo;
+```

docs/development/core/server/kibana-plugin-server.kibanarequest.body.md

@@ -0,0 +1,9 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [body](./kibana-plugin-server.kibanarequest.body.md)
+
+## KibanaRequest.body property
+
+<b>Signature:</b>
+
+```typescript
+readonly body: Body;
+```

docs/development/core/server/kibana-plugin-server.kibanarequest.from.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [from](./kibana-plugin-server.kibanarequest.from.md)
+
+## KibanaRequest.from() method
+
+Factory for creating requests. Validates the request before creating an instance of a KibanaRequest.
+
+<b>Signature:</b>
+
+```typescript
+static from<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(req: Request, routeSchemas: RouteSchemas<P, Q, B> | undefined): KibanaRequest<P["type"], Q["type"], B["type"]>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  req | <code>Request</code> |  |
+|  routeSchemas | <code>RouteSchemas&lt;P, Q, B&gt; &#124; undefined</code> |  |
+
+<b>Returns:</b>
+
+`KibanaRequest<P["type"], Q["type"], B["type"]>`
+

docs/development/core/server/kibana-plugin-server.kibanarequest.getfilteredheaders.md

@@ -0,0 +1,20 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [getFilteredHeaders](./kibana-plugin-server.kibanarequest.getfilteredheaders.md)
+
+## KibanaRequest.getFilteredHeaders() method
+
+<b>Signature:</b>
+
+```typescript
+getFilteredHeaders(headersToKeep: string[]): Pick<Record<string, string | string[] | undefined>, string>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  headersToKeep | <code>string[]</code> |  |
+
+<b>Returns:</b>
+
+`Pick<Record<string, string | string[] | undefined>, string>`
+

docs/development/core/server/kibana-plugin-server.kibanarequest.headers.md

@@ -0,0 +1,9 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [headers](./kibana-plugin-server.kibanarequest.headers.md)
+
+## KibanaRequest.headers property
+
+<b>Signature:</b>
+
+```typescript
+readonly headers: Headers;
+```

docs/development/core/server/kibana-plugin-server.kibanarequest.md

@@ -0,0 +1,28 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md)
+
+## KibanaRequest class
+
+
+<b>Signature:</b>
+
+```typescript
+export declare class KibanaRequest<Params, Query, Body> 
+```
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [body](./kibana-plugin-server.kibanarequest.body.md) |  | <code>Body</code> |  |
+|  [headers](./kibana-plugin-server.kibanarequest.headers.md) |  | <code>Headers</code> |  |
+|  [params](./kibana-plugin-server.kibanarequest.params.md) |  | <code>Params</code> |  |
+|  [path](./kibana-plugin-server.kibanarequest.path.md) |  | <code>string</code> |  |
+|  [query](./kibana-plugin-server.kibanarequest.query.md) |  | <code>Query</code> |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [from(req, routeSchemas)](./kibana-plugin-server.kibanarequest.from.md) | <code>static</code> | Factory for creating requests. Validates the request before creating an instance of a KibanaRequest. |
+|  [getFilteredHeaders(headersToKeep)](./kibana-plugin-server.kibanarequest.getfilteredheaders.md) |  |  |
+

docs/development/core/server/kibana-plugin-server.kibanarequest.params.md

@@ -0,0 +1,9 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [params](./kibana-plugin-server.kibanarequest.params.md)
+
+## KibanaRequest.params property
+
+<b>Signature:</b>
+
+```typescript
+readonly params: Params;
+```

docs/development/core/server/kibana-plugin-server.kibanarequest.path.md

@@ -0,0 +1,9 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [path](./kibana-plugin-server.kibanarequest.path.md)
+
+## KibanaRequest.path property
+
+<b>Signature:</b>
+
+```typescript
+readonly path: string;
+```

docs/development/core/server/kibana-plugin-server.kibanarequest.query.md

@@ -0,0 +1,9 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [KibanaRequest](./kibana-plugin-server.kibanarequest.md) > [query](./kibana-plugin-server.kibanarequest.query.md)
+
+## KibanaRequest.query property
+
+<b>Signature:</b>
+
+```typescript
+readonly query: Query;
+```

docs/development/core/server/kibana-plugin-server.md

@@ -8,18 +8,22 @@
 |  --- | --- |
 |  [ClusterClient](./kibana-plugin-server.clusterclient.md) | Represents an Elasticsearch cluster API client and allows to call API on behalf of the internal Kibana user and the actual user that is derived from the request headers (via <code>asScoped(...)</code>). |
 |  [ConfigService](./kibana-plugin-server.configservice.md) |  |
+|  [KibanaRequest](./kibana-plugin-server.kibanarequest.md) |  |
+|  [Router](./kibana-plugin-server.router.md) |  |
 |  [ScopedClusterClient](./kibana-plugin-server.scopedclusterclient.md) | Serves the same purpose as "normal" <code>ClusterClient</code> but exposes additional <code>callAsCurrentUser</code> method that doesn't use credentials of the Kibana internal user (as <code>callAsInternalUser</code> does) to request Elasticsearch API, but rather passes HTTP headers extracted from the current user request to the API |
 
 ## Interfaces
 
 |  Interface | Description |
 |  --- | --- |
+|  [AuthToolkit](./kibana-plugin-server.authtoolkit.md) | A tool set defining an outcome of Auth interceptor for incoming request. |
 |  [CallAPIOptions](./kibana-plugin-server.callapioptions.md) | The set of options that defines how API call should be made and result be processed. |
 |  [CoreSetup](./kibana-plugin-server.coresetup.md) |  |
 |  [ElasticsearchServiceSetup](./kibana-plugin-server.elasticsearchservicesetup.md) |  |
 |  [Logger](./kibana-plugin-server.logger.md) | Logger exposes all the necessary methods to log any type of information and this is the interface used by the logging consumers including plugins. |
 |  [LoggerFactory](./kibana-plugin-server.loggerfactory.md) | The single purpose of <code>LoggerFactory</code> interface is to define a way to retrieve a context-based logger instance. |
 |  [LogMeta](./kibana-plugin-server.logmeta.md) | Contextual metadata |
+|  [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md) | A tool set defining an outcome of OnRequest interceptor for incoming request. |
 |  [Plugin](./kibana-plugin-server.plugin.md) | The interface that should be returned by a <code>PluginInitializer</code>. |
 |  [PluginInitializerContext](./kibana-plugin-server.plugininitializercontext.md) | Context that's available to plugins during initialization stage. |
 |  [PluginSetupContext](./kibana-plugin-server.pluginsetupcontext.md) | Context passed to the plugins <code>setup</code> method. |
@@ -29,8 +33,11 @@
 |  Type Alias | Description |
 |  --- | --- |
 |  [APICaller](./kibana-plugin-server.apicaller.md) |  |
+|  [AuthenticationHandler](./kibana-plugin-server.authenticationhandler.md) |  |
 |  [ElasticsearchClientConfig](./kibana-plugin-server.elasticsearchclientconfig.md) |  |
 |  [Headers](./kibana-plugin-server.headers.md) |  |
+|  [HttpServiceSetup](./kibana-plugin-server.httpservicesetup.md) |  |
+|  [OnRequestHandler](./kibana-plugin-server.onrequesthandler.md) |  |
 |  [PluginInitializer](./kibana-plugin-server.plugininitializer.md) | The <code>plugin</code> export at the root of a plugin's <code>server</code> directory should conform to this interface. |
 |  [PluginName](./kibana-plugin-server.pluginname.md) | Dedicated type for plugin name/id that is supposed to make Map/Set/Arrays that use it as a key or value more obvious. |
 

docs/development/core/server/kibana-plugin-server.onrequesthandler.md

@@ -0,0 +1,10 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnRequestHandler](./kibana-plugin-server.onrequesthandler.md)
+
+## OnRequestHandler type
+
+
+<b>Signature:</b>
+
+```typescript
+export declare type OnRequestHandler<Params = any, Query = any, Body = any> = (req: KibanaRequest<Params, Query, Body>, t: OnRequestToolkit) => OnRequestResult | Promise<OnRequestResult>;
+```

docs/development/core/server/kibana-plugin-server.onrequesttoolkit.md

@@ -0,0 +1,20 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md)
+
+## OnRequestToolkit interface
+
+A tool set defining an outcome of OnRequest interceptor for incoming request.
+
+<b>Signature:</b>
+
+```typescript
+export interface OnRequestToolkit 
+```
+
+## Properties
+
+|  Property | Type | Description |
+|  --- | --- | --- |
+|  [next](./kibana-plugin-server.onrequesttoolkit.next.md) | <code>() =&gt; OnRequestResult</code> | To pass request to the next handler |
+|  [redirected](./kibana-plugin-server.onrequesttoolkit.redirected.md) | <code>(url: string) =&gt; OnRequestResult</code> | To interrupt request handling and redirect to a configured url |
+|  [rejected](./kibana-plugin-server.onrequesttoolkit.rejected.md) | <code>(error: Error, options?: {`<p/>`        statusCode?: number;`<p/>`    }) =&gt; OnRequestResult</code> | Fail the request with specified error. |
+

docs/development/core/server/kibana-plugin-server.onrequesttoolkit.next.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md) > [next](./kibana-plugin-server.onrequesttoolkit.next.md)
+
+## OnRequestToolkit.next property
+
+To pass request to the next handler
+
+<b>Signature:</b>
+
+```typescript
+next: () => OnRequestResult;
+```

docs/development/core/server/kibana-plugin-server.onrequesttoolkit.redirected.md

@@ -0,0 +1,11 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md) > [redirected](./kibana-plugin-server.onrequesttoolkit.redirected.md)
+
+## OnRequestToolkit.redirected property
+
+To interrupt request handling and redirect to a configured url
+
+<b>Signature:</b>
+
+```typescript
+redirected: (url: string) => OnRequestResult;
+```

docs/development/core/server/kibana-plugin-server.onrequesttoolkit.rejected.md

@@ -0,0 +1,13 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [OnRequestToolkit](./kibana-plugin-server.onrequesttoolkit.md) > [rejected](./kibana-plugin-server.onrequesttoolkit.rejected.md)
+
+## OnRequestToolkit.rejected property
+
+Fail the request with specified error.
+
+<b>Signature:</b>
+
+```typescript
+rejected: (error: Error, options?: {
+        statusCode?: number;
+    }) => OnRequestResult;
+```

docs/development/core/server/kibana-plugin-server.pluginsetupcontext.http.md

@@ -0,0 +1,12 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [PluginSetupContext](./kibana-plugin-server.pluginsetupcontext.md) > [http](./kibana-plugin-server.pluginsetupcontext.http.md)
+
+## PluginSetupContext.http property
+
+<b>Signature:</b>
+
+```typescript
+http: {
+        registerAuth: HttpServiceSetup['registerAuth'];
+        registerOnRequest: HttpServiceSetup['registerOnRequest'];
+    };
+```

docs/development/core/server/kibana-plugin-server.pluginsetupcontext.md

@@ -15,4 +15,5 @@ export interface PluginSetupContext
 |  Property | Type | Description |
 |  --- | --- | --- |
 |  [elasticsearch](./kibana-plugin-server.pluginsetupcontext.elasticsearch.md) | <code>{`<p/>`        adminClient$: Observable&lt;ClusterClient&gt;;`<p/>`        dataClient$: Observable&lt;ClusterClient&gt;;`<p/>`    }</code> |  |
+|  [http](./kibana-plugin-server.pluginsetupcontext.http.md) | <code>{`<p/>`        registerAuth: HttpServiceSetup['registerAuth'];`<p/>`        registerOnRequest: HttpServiceSetup['registerOnRequest'];`<p/>`    }</code> |  |
 

docs/development/core/server/kibana-plugin-server.router.delete.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Router](./kibana-plugin-server.router.md) > [delete](./kibana-plugin-server.router.delete.md)
+
+## Router.delete() method
+
+Register a `DELETE` request with the router
+
+<b>Signature:</b>
+
+```typescript
+delete<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  route | <code>RouteConfig&lt;P, Q, B&gt;</code> |  |
+|  handler | <code>RequestHandler&lt;P, Q, B&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/server/kibana-plugin-server.router.get.md

@@ -0,0 +1,23 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Router](./kibana-plugin-server.router.md) > [get](./kibana-plugin-server.router.get.md)
+
+## Router.get() method
+
+Register a `GET` request with the router
+
+<b>Signature:</b>
+
+```typescript
+get<P extends ObjectType, Q extends ObjectType, B extends ObjectType>(route: RouteConfig<P, Q, B>, handler: RequestHandler<P, Q, B>): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  route | <code>RouteConfig&lt;P, Q, B&gt;</code> |  |
+|  handler | <code>RequestHandler&lt;P, Q, B&gt;</code> |  |
+
+<b>Returns:</b>
+
+`void`
+

docs/development/core/server/kibana-plugin-server.router.getroutes.md

@@ -0,0 +1,17 @@
+[Home](./index) > [kibana-plugin-server](./kibana-plugin-server.md) > [Router](./kibana-plugin-server.router.md) > [getRoutes](./kibana-plugin-server.router.getroutes.md)
+
+## Router.getRoutes() method
+
+Returns all routes registered with the this router.
+
+<b>Signature:</b>
+
+```typescript
+getRoutes(): Readonly<RouterRoute>[];
+```
+<b>Returns:</b>
+
+`Readonly<RouterRoute>[]`
+
+List of registered routes.
+