Skip to content

Commit 65da3bf

Browse files
elasticmachineelasticmachine
authored
Merge branch '7.x' into backport/7.x/pr-59032
2 parents c1d0a4d + 0c57aa8 commit 65da3bf

528 files changed

Lines changed: 5570 additions & 3500 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthNotHandled](./kibana-plugin-server.authnothandled.md)
4+
5+
## AuthNotHandled interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface AuthNotHandled
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [type](./kibana-plugin-server.authnothandled.type.md) | <code>AuthResultType.notHandled</code> | |
19+

‎docs/development/core/server/kibana-plugin-server.authnothandled.type.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthNotHandled](./kibana-plugin-server.authnothandled.md) &gt; [type](./kibana-plugin-server.authnothandled.type.md)
4+
5+
## AuthNotHandled.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type: AuthResultType.notHandled;
11+
```

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

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirected](./kibana-plugin-server.authredirected.md)
4+
5+
## AuthRedirected interface
6+
7+
8+
<b>Signature:</b>
9+
10+
```typescript
11+
export interface AuthRedirected extends AuthRedirectedParams
12+
```
13+
14+
## Properties
15+
16+
| Property | Type | Description |
17+
| --- | --- | --- |
18+
| [type](./kibana-plugin-server.authredirected.type.md) | <code>AuthResultType.redirected</code> | |
19+

‎docs/development/core/server/kibana-plugin-server.authredirected.type.md‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirected](./kibana-plugin-server.authredirected.md) &gt; [type](./kibana-plugin-server.authredirected.type.md)
4+
5+
## AuthRedirected.type property
6+
7+
<b>Signature:</b>
8+
9+
```typescript
10+
type: AuthResultType.redirected;
11+
```

‎docs/development/core/server/kibana-plugin-server.authredirectedparams.headers.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirectedParams](./kibana-plugin-server.authredirectedparams.md) &gt; [headers](./kibana-plugin-server.authredirectedparams.headers.md)
4+
5+
## AuthRedirectedParams.headers property
6+
7+
Headers to attach for auth redirect. Must include "location" header
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
headers: {
13+
location: string;
14+
} & ResponseHeaders;
15+
```

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

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [kibana-plugin-server](./kibana-plugin-server.md) &gt; [AuthRedirectedParams](./kibana-plugin-server.authredirectedparams.md)
4+
5+
## AuthRedirectedParams interface
6+
7+
Result of auth redirection.
8+
9+
<b>Signature:</b>
10+
11+
```typescript
12+
export interface AuthRedirectedParams
13+
```
14+
15+
## Properties
16+
17+
| Property | Type | Description |
18+
| --- | --- | --- |
19+
| [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 |
20+

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,5 @@
88
<b>Signature:</b>
99

1010
```typescript
11-
export declare type AuthResult = Authenticated;
11+
export declare type AuthResult = Authenticated | AuthNotHandled | AuthRedirected;
1212
```

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
## AuthResultParams interface
66

7-
Result of an incoming request authentication.
7+
Result of successful authentication.
88

99
<b>Signature:</b>
1010

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,6 @@ export declare enum AuthResultType
1616
| Member | Value | Description |
1717
| --- | --- | --- |
1818
| authenticated | <code>&quot;authenticated&quot;</code> | |
19+
| notHandled | <code>&quot;notHandled&quot;</code> | |
20+
| redirected | <code>&quot;redirected&quot;</code> | |
1921

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,4 +17,6 @@ export interface AuthToolkit
1717
| Property | Type | Description |
1818
| --- | --- | --- |
1919
| [authenticated](./kibana-plugin-server.authtoolkit.authenticated.md) | <code>(data?: AuthResultParams) =&gt; AuthResult</code> | Authentication is successful with given credentials, allow request to pass through |
20+
| [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 |
21+
| [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' |
2022

0 commit comments

Comments
 (0)