Forum Discussion

Herry's avatar
Herry
New Member
5 years ago

Swagger 2.0 apiKey authentication and scopes

Hi community,   I use this security definition in our project:   securityDefinitions:   JwtBearerAuth:     type: apiKey     name: Authorization     in: header     x-apikeyInfoFunc: "service...
HKosova's avatar
HKosova
SmartBear Alumni (Retired)
5 years ago

Hi Herry,

 

The next version of the spec, OpenAPI 3.1 (which is in the RC stage now), will support defining roles for operations secured with API keys:

paths:
  /secret:
    get:
      security:
        - JwtBearerAuth: [admin]   # <-----

 

In OpenAPI 2.0 and 3.0, you can mention these roles in the operation descriptions.