Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

security scheme apiKey in body form data parameter

See original GitHub issue

It is possible to define a security scheme as

QueryKey:
  type: apiKey
  in: query
  name: myparam

corresponding to

parameters:
  - name: myparam
    in: query
    required: true

while the first approach adds the notion that the required parameter is related to security.

However there seems to be no way to define a security scheme about a required parameter in an application/x-www-form-urlencoded body adding the same security notion.

Issue Analytics

State:
Created 3 years ago
Reactions:3
Comments:8 (3 by maintainers)

Top GitHub Comments

1reaction

johakochcommented, Jan 20, 2021

@dylantack wrote: I would find this feature helpful. Mandrill is one example that expects the API key in a body parameter:

https://mandrillapp.com/api/docs/messages.curl.html#sts=/messages/search.json

My question was about an API key in an application/x-www-form-urlencoded body. But, of course, it can be extended to other content-types, like application/json as in the Mandrill example.

1reaction

dylantackcommented, Jan 20, 2021

I would find this feature helpful. Mandrill is one example that expects the API key in a body parameter:

https://mandrillapp.com/api/docs/messages.curl.html#sts=/messages/search.json

Top Results From Across the Web

apiKey security scheme that requires two keys

The following code will handle two keys. security: - apiKeyCookie: [] authCookie: [] By making them the same entry object, you require them...

Authentication - Swagger

This section contains a list of named security schemes, where each scheme can be of type : http – for Basic, Bearer and...

API Key Best Practices and Examples - Okta Developer

Because API keys grant access to API calls which may change important data or incur significant charges. It is therefore important that the...

OpenAPI Specification v3.1.0 | Introduction, Definitions, & More

In a multipart/form-data request body, each schema property, or each element of a schema array property, takes a section in the payload with...

OpenAPI feature limitations - Cloud Endpoints

Security requirements containing an API key; Security requirements for OAuth2 ... parameters: - name: avatar in: formData description: "The avatar of the ...