Skip to content

Commit e171472

Browse files
committed
Added auth header support and OpenIdConnect
1 parent b1430f9 commit e171472

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

versions/3.0.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2974,10 +2974,13 @@ Supported schemes are basic authentication, an API key (either as a header or as
29742974
##### Fixed Fields
29752975
Field Name | Type | Validity | Description
29762976
---|:---:|---|---
2977-
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"basic"`, `"apiKey"` or `"oauth2"`.
2977+
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`.
29782978
<a name="securitySchemeDescription"></a>description | `string` | Any | A short description for security scheme.
29792979
<a name="securitySchemeName"></a>name | `string` | `apiKey` | **Required.** The name of the header or query parameter to be used.
29802980
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **Required** The ___location of the API key. Valid values are `"query"` or `"header"`.
2981+
<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **Required.** The name of the HTTP Authorization scheme to be used in the Authorization header as per RFC 7234.
2982+
<a name="securitySchemeBearerFormat"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token should be formatted.
2983+
<a name="securitySchemeOpenIdConnectUrl"></a>openIdConnectUrl | `string` | `openIdConnect` | **Required.** OpenId Connect URL to discover OAuth2 configuration values.
29812984
<a name="securitySchemeFlow"></a>flow | `string` | `oauth2` | **Required.** The flow used by the OAuth2 security scheme. Valid values are `"implicit"`, `"password"`, `"application"` or `"accessCode"`.
29822985
<a name="securitySchemeAuthorizationUrl"></a>authorizationUrl | `string` | `oauth2` (`"implicit"`, `"accessCode"`) | **Required.** The authorization URL to be used for this flow. This SHOULD be in the form of a URL.
29832986
<a name="securitySchemeTokenUrl"></a>tokenUrl | `string` | `oauth2` (`"password"`, `"application"`, `"accessCode"`) | **Required.** The token URL to be used for this flow. This SHOULD be in the form of a URL.
@@ -2995,12 +2998,14 @@ Field Name | Type | Description
29952998

29962999
```json
29973000
{
2998-
"type": "basic"
3001+
"type": "scheme",
3002+
"scheme" : "basic"
29993003
}
30003004
```
30013005

30023006
```yaml
3003-
type: basic
3007+
type: http
3008+
scheme: basic
30043009
```
30053010

30063011
###### API Key Sample
@@ -3019,6 +3024,22 @@ name: api_key
30193024
in: header
30203025
```
30213026

3027+
###### JWT Bearer Sample
3028+
3029+
```json
3030+
{
3031+
"type": "scheme",
3032+
"scheme" : "bearer",
3033+
"bearerFormat" : "JWT",
3034+
}
3035+
```
3036+
3037+
```yaml
3038+
type: http
3039+
scheme: bearer
3040+
bearerFormat: JWT
3041+
```
3042+
30223043
###### Implicit OAuth2 Sample
30233044

30243045
```json

0 commit comments

Comments
 (0)