Skip to content

Commit 134cf47

Browse files
chore: add security scheme audience for jwt aud claim auth
1 parent 33f8888 commit 134cf47

File tree

1 file changed

+1
-0
lines changed

1 file changed

+1
-0
lines changed

versions/3.2.0.md

+1
Original file line numberDiff line numberDiff line change
@@ -3199,6 +3199,7 @@ Field Name | Type | Applies To | Description
31993199
<a name="securitySchemeIn"></a>in | `string` | `apiKey` | **REQUIRED**. The location of the API key. Valid values are `"query"`, `"header"` or `"cookie"`.
32003200
<a name="securitySchemeScheme"></a>scheme | `string` | `http` | **REQUIRED**. The name of the HTTP Authorization scheme to be used in the [Authorization header as defined in RFC7235](https://tools.ietf.org/html/rfc7235#section-5.1). The values used SHOULD be registered in the [IANA Authentication Scheme registry](https://www.iana.org/assignments/http-authschemes/http-authschemes.xhtml).
32013201
<a name="securitySchemeBearerFormat"></a>bearerFormat | `string` | `http` (`"bearer"`) | A hint to the client to identify how the bearer token is formatted. Bearer tokens are usually generated by an authorization server, so this information is primarily for documentation purposes.
3202+
<a name="securitySchemeAudience"></a>audience | `string` | `http` (`"bearer"`) | The audience that should exist in the [JWT `aud` claim](https://datatracker.ietf.org/doc/html/rfc7519#section-4.1.3).
32023203
<a name="securitySchemeFlows"></a>flows | [OAuth Flows Object](#oauthFlowsObject) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported.
32033204
<a name="securitySchemeOpenIdConnectUrl"></a>openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. OpenId Connect URL to discover OAuth2 configuration values. This MUST be in the form of a URL. The OpenID Connect standard requires the use of TLS.
32043205
<a name="securitySchemeDeprecated"></a>deprecated | `boolean` | Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Default value is `false`.

0 commit comments

Comments
 (0)