Skip to content

Commit

Permalink
add oauth2MetadataUrl (OAI#3694)
Browse files Browse the repository at this point in the history
* add oauth2MetadataUrl

Signed-off-by: Axel Nennker <axel.nennker@telekom.de>

* update anchor

Signed-off-by: Axel Nennker <axel.nennker@telekom.de>

---------

Signed-off-by: Axel Nennker <axel.nennker@telekom.de>
  • Loading branch information
AxelNennker authored and handrews committed Oct 24, 2024
1 parent a1c755e commit 789ca75
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions src/oas.md
Original file line number Diff line number Diff line change
Expand Up @@ -3817,6 +3817,7 @@ Please note that as of 2020, the implicit flow is about to be deprecated by [OAu
| <a name="security-scheme-bearer-format"></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. |
| <a name="security-scheme-flows"></a>flows | [OAuth Flows Object](#oauth-flows-object) | `oauth2` | **REQUIRED**. An object containing configuration information for the flow types supported. |
| <a name="security-scheme-open-id-connect-url"></a>openIdConnectUrl | `string` | `openIdConnect` | **REQUIRED**. [Well-known URL](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderConfig) to discover the [[OpenID-Connect-Discovery]] [provider metadata](https://openid.net/specs/openid-connect-discovery-1_0.html#ProviderMetadata). |
| <a name="security-scheme-oauth2-metadata-url"></a>oauth2MetadataUrl | `string` | `oauth2` | URL to the oauth2 authorization server metadata [RFC8414](https://datatracker.ietf.org/doc/html/rfc8414). TLS is required. |
| <a name="security-scheme-deprecated"></a>deprecated | `boolean` | Declares this security scheme to be deprecated. Consumers SHOULD refrain from usage of the declared scheme. Default value is `false`. |

This object MAY be extended with [Specification Extensions](#specification-extensions).
Expand Down

0 comments on commit 789ca75

Please sign in to comment.