Skip to content
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

API Key authentication should allow scopes to be defined. #1366

Closed
jakeswenson opened this issue Oct 4, 2017 · 8 comments
Closed

API Key authentication should allow scopes to be defined. #1366

jakeswenson opened this issue Oct 4, 2017 · 8 comments
Labels

Comments

@jakeswenson
Copy link

Today the scopes field on a security definition is only allowed on type=oauth
What is the reason to not allow scopes to be defined at an api key level?

For a good example of APIs that allow auth tokens to have scopes see GitHub's personal access tokens (https://github.com/settings/tokens/new)

Why can't I define an API and describe what scopes each endpoint needs/allows?

@jakeswenson
Copy link
Author

Is there a better place to file an issue so as to get some traction on this?

@darrelmiller
Copy link
Member

I don't see any reason why it couldn't be added to api key also. /cc @OAI/tdc

@MikeRalphson
Copy link
Member

Please see #1393 (comment) (feel free to comment on either issue).

@MikeRalphson
Copy link
Member

Any feedback on potential confusion in reusing the term scopes gratefully accepted...

@nickdnk
Copy link

nickdnk commented Dec 4, 2018

Any news here? I just spent a decent amount of time figuring out that there was no way to do this for anything but OAuth, which I don't use.

@MikeRalphson
Copy link
Member

See PR #1764 linked to above. We hope this will be included in OAS 3.1.0

@avanbrunt-cb
Copy link

@MikeRalphson Just wanted to check in on the status of roles/scopes being added to non-OAuth security schemas. I see in the PR you referenced above the roles/scopes change was omitted #1764 (comment)

However in the big list of possibilities for 3.1, I see that the scopes on non-OAuth security schemes is checked off. Here is the PR for the change #1829

Does this mean that the concept is approved for 3.1 but just needs refinement or is it potentially on the chopping block?

@MikeRalphson
Copy link
Member

This is included in the imminent 3.1 release.

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

No branches or pull requests

5 participants