How can I represent 'Authorization: Bearer <token>' in a Swagger Spec (swagger.json)

[Elmer Thomas SendGrid]

I am trying to convey that the authentication/security scheme requires setting a header as follows:

Authorization: Bearer <token>

This is what I have based on the swagger documentation:

securityDefinitions:
  APIKey:
    type: apiKey
    name: Authorization
    in: header
security:
  - APIKey: []

Thanks in advance!

[Ron Ratovsky]

Hi there Elmer,

So I assume this is part an OAuth2 flow. Now, the only way to actually fully represent it is by describing the OAuth2 flow you use and then the Bearer would be assumed.

However, if you're only describing a single leg in the process, you can't explicitly say that you need the 'Bearer' part of the string in the value.

What you can do though is use a vendor extension expressing the need for it (for example, by defining a regex pattern).

Hope this helps.

--
You received this message because you are subscribed to the Google Groups "Swagger" group.
To unsubscribe from this group and stop receiving emails from it, send an email to swagger-swaggers...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--

-----------------------------------------

http://swagger.io
https://twitter.com/SwaggerApi
-----------------------------------------

[Elmer Thomas SendGrid]

Thanks for the quick response! 

It is not part of an OAuth2 flow, here is the full API call I'm trying to replicate:

curl --request GET \ --url https://api.sendgrid.com/v3/api_keys \ --header 'authorization: Bearer <my-api-key>'

--
You received this message because you are subscribed to a topic in the Google Groups "Swagger" group.
To unsubscribe from this topic, visit https://groups.google.com/d/topic/swagger-swaggersocket/3ZWiAr30wN0/unsubscribe.
To unsubscribe from this group and all its topics, send an email to swagger-swaggers...@googlegroups.com.

[Ron Ratovsky]

Is there any other common authorization scheme today that requires the 'Bearer' part of the Authorization key or is that a custom solution you created?

[Elmer Thomas SendGrid]

I'm not sure, here is the description in the documentation: https://sendgrid.com/docs/API_Reference/Web_API_v3/index.html

Elmer Thomas

Developer Experience Engineer | Product

[Ron Ratovsky]

I see. For now, you have the options as previously mentioned.