require location header in the interface

elastic · Mar 5, 2020 · fcb4994 · fcb4994
1 parent c5cb1fd
commit fcb4994
Show file tree

Hide file tree

Showing 7 changed files with 18 additions and 10 deletions.
diff --git a/docs/development/core/server/kibana-plugin-server.authredirectedparams.headers.md b/docs/development/core/server/kibana-plugin-server.authredirectedparams.headers.md
@@ -9,5 +9,7 @@ Headers to attach for auth redirect. Must include "location" header
 <b>Signature:</b>
 
 ```typescript
-headers: ResponseHeaders;
+headers: {
+        location: string;
+    } & ResponseHeaders;
 ```
diff --git a/docs/development/core/server/kibana-plugin-server.authredirectedparams.md b/docs/development/core/server/kibana-plugin-server.authredirectedparams.md
@@ -16,5 +16,5 @@ export interface AuthRedirectedParams
 
 |  Property | Type | Description |
 |  --- | --- | --- |
-|  [headers](./kibana-plugin-server.authredirectedparams.headers.md) | <code>ResponseHeaders</code> | Headers to attach for auth redirect. Must include "location" header |
+|  [headers](./kibana-plugin-server.authredirectedparams.headers.md) | <code>{</code><br/><code>        location: string;</code><br/><code>    } &amp; ResponseHeaders</code> | Headers to attach for auth redirect. Must include "location" header |
 
diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.md
@@ -18,5 +18,5 @@ export interface AuthToolkit
 |  --- | --- | --- |
 |  [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(data?: AuthResultParams) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
 |  [notHandled](./kibana-plugin-server.authtoolkit.nothandled.md) | <code>() =&gt; AuthResult</code> | User has no credentials. Allows user to access a resource when authRequired: 'optional' Rejects a request when authRequired: true |
-|  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(headers: ResponseHeaders) =&gt; AuthResult</code> | Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |
+|  [redirected](./kibana-plugin-server.authtoolkit.redirected.md) | <code>(headers: {</code><br/><code>        location: string;</code><br/><code>    } &amp; ResponseHeaders) =&gt; AuthResult</code> | Redirect user to IdP when authRequired: true Allows user to access a resource without redirection when authRequired: 'optional' |
 
diff --git a/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md b/docs/development/core/server/kibana-plugin-server.authtoolkit.redirected.md
@@ -9,5 +9,7 @@ Redirect user to IdP when authRequired: true Allows user to access a resource wi
 <b>Signature:</b>
 
 ```typescript
-redirected: (headers: ResponseHeaders) => AuthResult;
+redirected: (headers: {
+        location: string;
+    } & ResponseHeaders) => AuthResult;
 ```
diff --git a/src/core/server/http/integration_tests/lifecycle.test.ts b/src/core/server/http/integration_tests/lifecycle.test.ts
@@ -527,7 +527,7 @@ describe('Auth', () => {
     const router = createRouter('/');
 
     router.get({ path: '/', validate: false }, (context, req, res) => res.ok());
-    registerAuth((req, res, t) => t.redirected({}));
+    registerAuth((req, res, t) => t.redirected({} as any));
     await server.start();
 
     await supertest(innerServer.listener)

diff --git a/src/core/server/http/lifecycle/auth.ts b/src/core/server/http/lifecycle/auth.ts
@@ -67,7 +67,7 @@ const authResult = {
       type: AuthResultType.notHandled,
     };
   },
-  redirected(headers: ResponseHeaders): AuthResult {
+  redirected(headers: { location: string } & ResponseHeaders): AuthResult {
     return {
       type: AuthResultType.redirected,
       headers,
@@ -121,7 +121,7 @@ export interface AuthRedirectedParams {
    * Headers to attach for auth redirect.
    * Must include "location" header
    */
-  headers: ResponseHeaders;
+  headers: { location: string } & ResponseHeaders;
 }
 
 /**
@@ -141,7 +141,7 @@ export interface AuthToolkit {
    * Redirect user to IdP when authRequired: true
    * Allows user to access a resource without redirection when authRequired: 'optional'
    * */
-  redirected: (headers: ResponseHeaders) => AuthResult;
+  redirected: (headers: { location: string } & ResponseHeaders) => AuthResult;
 }
 
 const toolkit: AuthToolkit = {

diff --git a/src/core/server/server.api.md b/src/core/server/server.api.md
@@ -432,7 +432,9 @@ export interface AuthRedirected extends AuthRedirectedParams {
 
 // @public
 export interface AuthRedirectedParams {
-    headers: ResponseHeaders;
+    headers: {
+        location: string;
+    } & ResponseHeaders;
 }
 
 // @public (undocumented)
@@ -466,7 +468,9 @@ export enum AuthStatus {
 export interface AuthToolkit {
     authenticated: (data?: AuthResultParams) => AuthResult;
     notHandled: () => AuthResult;
-    redirected: (headers: ResponseHeaders) => AuthResult;
+    redirected: (headers: {
+        location: string;
+    } & ResponseHeaders) => AuthResult;
 }
 
 // @public