diff --git a/docs/development/core/server/kibana-plugin-server.authnothandled.md b/docs/development/core/server/kibana-plugin-server.authnothandled.md index 5d4a39a88ea647..01e465c266319b 100644 --- a/docs/development/core/server/kibana-plugin-server.authnothandled.md +++ b/docs/development/core/server/kibana-plugin-server.authnothandled.md @@ -8,7 +8,7 @@ Signature: ```typescript -export interface AuthNotHandled extends AuthNotHandledResultParams +export interface AuthNotHandled ``` ## Properties diff --git a/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.md b/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.md deleted file mode 100644 index 90e9f5a771e552..00000000000000 --- a/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.md +++ /dev/null @@ -1,20 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthNotHandledResultParams](./kibana-plugin-server.authnothandledresultparams.md) - -## AuthNotHandledResultParams interface - -Result of unhandled authentication. - -Signature: - -```typescript -export interface AuthNotHandledResultParams -``` - -## Properties - -| Property | Type | Description | -| --- | --- | --- | -| [responseHeaders](./kibana-plugin-server.authnothandledresultparams.responseheaders.md) | AuthHeaders | Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. | - diff --git a/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.responseheaders.md b/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.responseheaders.md deleted file mode 100644 index 9e1e733246d16a..00000000000000 --- a/docs/development/core/server/kibana-plugin-server.authnothandledresultparams.responseheaders.md +++ /dev/null @@ -1,13 +0,0 @@ - - -[Home](./index.md) > [kibana-plugin-server](./kibana-plugin-server.md) > [AuthNotHandledResultParams](./kibana-plugin-server.authnothandledresultparams.md) > [responseHeaders](./kibana-plugin-server.authnothandledresultparams.responseheaders.md) - -## AuthNotHandledResultParams.responseHeaders property - -Auth specific headers to attach to a response object. Used to send back authentication mechanism related headers to a client when needed. - -Signature: - -```typescript -responseHeaders?: AuthHeaders; -``` diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.md index cee59409b79998..820f2692186616 100644 --- a/docs/development/core/server/kibana-plugin-server.authtoolkit.md +++ b/docs/development/core/server/kibana-plugin-server.authtoolkit.md @@ -17,5 +17,5 @@ export interface AuthToolkit | Property | Type | Description | | --- | --- | --- | | [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | (data?: AuthResultParams) => AuthResult | Authentication is successful with given credentials, allow request to pass through | -| [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | (data?: AuthNotHandledResultParams) => AuthResult | User has no credentials | +| [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | () => AuthResult | User has no credentials | diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.nothandled.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.nothandled.md index 41c5cb16567d47..7a74a4e2800869 100644 --- a/docs/development/core/server/kibana-plugin-server.authtoolkit.nothandled.md +++ b/docs/development/core/server/kibana-plugin-server.authtoolkit.nothandled.md @@ -9,5 +9,5 @@ User has no credentials Signature: ```typescript -notHandled: (data?: AuthNotHandledResultParams) => AuthResult; +notHandled: () => AuthResult; ``` diff --git a/docs/development/core/server/kibana-plugin-server.md b/docs/development/core/server/kibana-plugin-server.md index 08e47a1559e18c..2a6b5df77d4f3c 100644 --- a/docs/development/core/server/kibana-plugin-server.md +++ b/docs/development/core/server/kibana-plugin-server.md @@ -46,7 +46,6 @@ The plugin integrates with the core system via lifecycle events: `setup` | [AssistantAPIClientParams](./kibana-plugin-server.assistantapiclientparams.md) | | | [Authenticated](./kibana-plugin-server.authenticated.md) | | | [AuthNotHandled](./kibana-plugin-server.authnothandled.md) | | -| [AuthNotHandledResultParams](./kibana-plugin-server.authnothandledresultparams.md) | Result of unhandled authentication. | | [AuthResultParams](./kibana-plugin-server.authresultparams.md) | Result of successful authentication. | | [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. | diff --git a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md index 15e60905dbc308..cb0beb20f1c504 100644 --- a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md +++ b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.core.md @@ -9,7 +9,7 @@ ```typescript core: { auth: { - isAuthenticated: IsAuthenticated; + isAuthenticated: boolean; }; rendering: IScopedRenderingClient; savedObjects: { diff --git a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md index 8bd2fc61f9f4e8..ddcf6f3e5f973f 100644 --- a/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md +++ b/docs/development/core/server/kibana-plugin-server.requesthandlercontext.md @@ -18,5 +18,5 @@ export interface RequestHandlerContext | Property | Type | Description | | --- | --- | --- | -| [core](./kibana-plugin-server.requesthandlercontext.core.md) | {
auth: {
isAuthenticated: IsAuthenticated;
};
rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
uiSettings: {
client: IUiSettingsClient;
};
} | | +| [core](./kibana-plugin-server.requesthandlercontext.core.md) | {
auth: {
isAuthenticated: boolean;
};
rendering: IScopedRenderingClient;
savedObjects: {
client: SavedObjectsClientContract;
};
elasticsearch: {
dataClient: IScopedClusterClient;
adminClient: IScopedClusterClient;
};
uiSettings: {
client: IUiSettingsClient;
};
} | | diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md index 51e1fc5f4f79c7..d8f58bdb62ed50 100644 --- a/src/core/server/server.api.md +++ b/src/core/server/server.api.md @@ -419,16 +419,11 @@ export type AuthenticationHandler = (request: KibanaRequest, response: Lifecycle export type AuthHeaders = Record; // @public (undocumented) -export interface AuthNotHandled extends AuthNotHandledResultParams { +export interface AuthNotHandled { // (undocumented) type: AuthResultType.notHandled; } -// @public -export interface AuthNotHandledResultParams { - responseHeaders?: AuthHeaders; -} - // @public (undocumented) export type AuthResult = Authenticated | AuthNotHandled; @@ -457,7 +452,7 @@ export enum AuthStatus { // @public export interface AuthToolkit { authenticated: (data?: AuthResultParams) => AuthResult; - notHandled: (data?: AuthNotHandledResultParams) => AuthResult; + notHandled: () => AuthResult; } // @public @@ -1429,7 +1424,7 @@ export interface RequestHandlerContext { // (undocumented) core: { auth: { - isAuthenticated: IsAuthenticated; + isAuthenticated: boolean; }; rendering: IScopedRenderingClient; savedObjects: {