OpenAPI showing 'basic' auth as option in securityDefinitions, should indicate use of Authorization header #1501

Closed
opened 2025-12-29 16:32:29 +01:00 by adam · 0 comments
Owner

Originally created by @jeremyschulman on GitHub (Jan 19, 2018).

Issue type

[ ] Feature request
[X] Bug report
[ ] Documentation

Environment

  • Python version: 2.7
  • NetBox version: 2.2.8

Description

* A list of the steps needed for someone else to reproduce the bug
  1. get the openapi spec; for example, running a laptop instance, this URL would be: "http://0.0.0.0:32768/api/docs/?format=openapi". or you could use use curl or wget.

  2. at the very bottom, you will see "securityDefinitions" indicating basic auth. basic auth is not supported in Netbox 2.2.8.

2018-01-19_09-05-41

    * A description of the expected and observed behavior

Here is an example of a system that uses request headers to store a token. In this example, the header key is called "AUTHTOKEN". For Netbox, this would be "Authorization", as documented on the read-the-docs site.

2018-01-19_09-10-24

    * Any relevant error messages (screenshots may also help)
Originally created by @jeremyschulman on GitHub (Jan 19, 2018). ### Issue type [ ] Feature request <!-- An enhancement of existing functionality --> [X] Bug report <!-- Unexpected or erroneous behavior --> [ ] Documentation <!-- A modification to the documentation --> ### Environment * Python version: 2.7 * NetBox version: 2.2.8 ### Description * A list of the steps needed for someone else to reproduce the bug 1. get the openapi spec; for example, running a laptop instance, this URL would be: "http://0.0.0.0:32768/api/docs/?format=openapi". or you could use use curl or wget. 2. at the very bottom, you will see "securityDefinitions" indicating basic auth. basic auth is not supported in Netbox 2.2.8. ![2018-01-19_09-05-41](https://user-images.githubusercontent.com/2607956/35154423-3a9f0308-fcf8-11e7-9721-06e2f586362b.png) * A description of the expected and observed behavior Here is an example of a system that uses request headers to store a token. In this example, the header key is called "AUTHTOKEN". For Netbox, this would be "Authorization", as documented [on the read-the-docs site.](https://netbox.readthedocs.io/en/latest/api/authentication) ![2018-01-19_09-10-24](https://user-images.githubusercontent.com/2607956/35154633-ee16c448-fcf8-11e7-8c75-c06c8c75bd5b.png) * Any relevant error messages (screenshots may also help)
adam added the type: bugstatus: accepted labels 2025-12-29 16:32:29 +01:00
adam closed this issue 2025-12-29 16:32:30 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#1501