Enable Button For API Tokens

[mr1716]

NetBox version

v4.4.6

Feature type

New functionality

Proposed functionality

Have a button that users would be able to click which would enable and disable API Tokens.

At the time that the users create and edit the individual API Tokens, there would either be an Enable checkbox that checked means enabled this unchecked means disabled or a status drop-down that users can change.

Use case

If an API Token needs to be disabled or re-enabled, the only way to do that would be to change the Expiration Date or restrict the IPs. It’s less than ideal to be changing those values to simply enable or disable the tokens.

Database changes

A new field as either Status of either Enabled or Disabled or enabled: True for the API to do the comparison when authentication and use of an API Token is done. The idea being that if Enabled is set to True or Status is set to enabled, it would allow authentication. And this value would be able to be set by administrators at time of creation as well as part of normal work. Moreover, the value could be set to False or disabled when the Expiration Date passes.

External dependencies

Unsure.

Sorry if this is not useful, just thought it may be something that may help users with administering the tool

[jnovinger]

I think this is potentially useful, but as it stands, the FR doesn't seem to have enough detail to be actionable. If we need to persist a user's choice to enable/disable an API token, then database changes are definitely required. Similarly, this FR glosses over the expected behaviors (both in the Token edit view and in the API auth boundary) and the necessary changes to the related auth mechanism (and potentially other areas).

Per our contributing guide, a feature request must include a thorough description of the proposed functionality, including any database changes, new views or API endpoints, and so on. It must also include a detailed use case justifying its implementation. If you would like to elaborate on your proposal, please modify your post above. If sufficient detail is not added, this issue will be closed.

[mr1716]

@jnovinger just made some changes and will make some additional changes later. May have missed a few things, but will edit later

[jeremystretch]

It sounds like what you want is to add an "enabled" boolean field on the Token model, as a control over whether the token can be used. This would present in the UI as a checkbox under the individual and bulk edit forms, rather than a button elsewhere. Does that capture your use case?

[mr1716]

@jeremystretch, the idea is to have a way to ensure that there’s an easy way to enable and disable API Tokens. And the way Im proposing is the method you’re describing since I think there are other Netbox features that behave the same way in terms of enabling via the UI