Skip to content

Added bearer/JWT support and OpenIdConnect #807

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 7, 2016
Merged

Conversation

darrelmiller
Copy link
Member

No description provided.

@darrelmiller
Copy link
Member Author

@OAI/tdc Thoughts?

@@ -2974,10 +2974,13 @@ Supported schemes are basic authentication, an API key (either as a header or as
##### Fixed Fields
Field Name | Type | Validity | Description
---|:---:|---|---
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"basic"`, `"apiKey"` or `"oauth2"`.
<a name="securitySchemeType"></a>type | `string` | Any | **Required.** The type of the security scheme. Valid values are `"apiKey"`, `"http"`, `"oauth2"`, `"openIdConnect"`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm going to assume openIdConnect you mean http://openid.net/connect/ ? Is that a generic protocol? Is it ok to use the name in the spec?

I'm wondering if there is a more generic term to describe it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The license to use/reference OpenID related works seems pretty unrestricted http://openid.net/specs/openid-connect-discovery-1_0.html#Notices
To be more generic we could have a IdentityProviderURL. OpenID provides both a WebFinger protocol and a .well-known URL for getting at the OpenID configuration. If other Identity Providers come along they would probably have their own "discovery" mechanism.


```json
{
"type": "scheme",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

type should be http

{
"type": "scheme",
"scheme" : "bearer",
"bearerFormat" : "JWT",
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The bearerFormat may not be necessary, except to indicate that the token will be prefixed by the term Bearer when being passed to the client. More for documentation than anything.

@fehguy
Copy link
Contributor

fehguy commented Oct 7, 2016

"Shall we merge? Cha... Cha... Cha..."

@curtisgibby
Copy link

Now that this has been merged into the OpenApi.next branch, when will that be released as the stable "production" branch? (OpenAPI version 3?) I'm relying on a downstream project that I'm sure won't update until this is released on your side. (Eagerly awaiting JWT support in https://github.com/swagger-api/swagger-ui and https://github.com/zircote/swagger-php .)

@webron
Copy link
Member

webron commented Jan 27, 2017

https://www.openapis.org/blog/2017/01/24/a-new-year-a-new-specification

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants