swagger-api / swagger-api/swagger-ui

Specify OAuth2 access token manually

Open
#5,320 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
29k
Forks
9.3k
Avg merge
2d 23h
Merged PRs (30d)
25

Description

Q&A (please complete the following information)
  • OS: [e.g. macOS] Mac OS
  • Browser: [e.g. chrome, safari] Chrome
  • Version: [e.g. 22] 73.0.3683.103
  • Method of installation: [e.g. npm, dist assets] swagger-ui-dist
  • Swagger-UI version: [e.g. 3.10.0] 3.22.1
  • Swagger/OpenAPI version: [e.g. Swagger 2.0, OpenAPI 3.0] Swagger 2.0
Content & configuration
    "securityDefinitions": {
        "oauth2_implicit": {
            "type": "oauth2",
            "flow": "implicit",
            "authorizationUrl": "https://mysite/auth/",
            "scopes": {
                "full": "full access"
            }
        }
    },
    "security": [
        {
            "oauth2_implicit": [
                "full"
            ]
        }
    ],
Screenshots

N/A

How can we help?

Is there a way to specify an OAuth2 access token directly, instead of calling the OAuth authentication URL? Either through the UI or programmatically would work. I have some cases where I'd like to reproduce issues with a particular access token, so I don't want swagger-ui to request a new one.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

No implementation files or tests are named. Start by tracing Swagger UI's OAuth2 implicit-flow authentication and the programmatic configuration entry points; done means a user can supply a specific access token through the UI or programmatically without Swagger UI requesting a new token from the authorization URL.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
authentication, frontend
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.