Metadata-Version: 2.4
Name: netbox-user-credentials-plugin
Version: 0.2.0
Summary: NetBox plugin for User Credentials
Author-email: Dmitry Konyushenko <konyushenko.dmitriy@gmail.com>
License-Expression: WTFPL
Project-URL: Homepage, https://github.com/ilyjorsey/netbox-user-credentials-plugin/
Project-URL: Documentation, https://ilyjorsey.github.io/netbox-user-credentials-plugin
Project-URL: Source, https://github.com/ilyjorsey/netbox-user-credentials-plugin
Project-URL: Tracker, https://github.com/ilyjorsey/netbox-user-credentials-plugin/issues
Keywords: netbox,netbox-plugin
Classifier: Development Status :: 3 - Alpha
Classifier: Framework :: Django
Classifier: Framework :: Django :: 5.1
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: Intended Audience :: Telecommunications Industry
Classifier: Natural Language :: English
Classifier: Natural Language :: Russian
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: System :: Networking
Requires-Python: >=3.12.0
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# NetBox User Credentials Plugin

NetBox plugin for managing User Credentials.

The standard NetBox VM model only allows contacts to be assigned. However, if you need to keep an inventory of users associated with virtual machines, including multiple users linked to the same contact, NetBox does not provide sufficient functionality out of the box. The User Credentials plugin helps solve this problem.

- Free software: WTFPL
- Documentation: https://ilyjorsey.github.io/netbox-user-credentials-plugin/

## Compatibility

| NetBox Version | Plugin Version |
|----------------|----------------|
|     4.3+       |      0.2.0     |

- This plugin requires **NetBox 4.3** or later and **Python 3.12** or later.
- Always test the plugin with the target NetBox version before upgrading in production.
- Check the [NetBox release notes](https://docs.netbox.dev/en/stable/release-notes/) for breaking changes.

## REST API

This plugin provides a REST API endpoint for managing User Credentials resources:

- `/api/plugins/netbox_user_credentials_plugin/user-credentials/` - List and create plugin objects

## Installing

Install the plugin using pip:

```bash
pip install netbox-user-credentials-plugin
```

For adding to a NetBox Docker setup see
[the general instructions for using netbox-docker with plugins](https://github.com/netbox-community/netbox-docker/wiki/Using-Netbox-Plugins).

Enable the plugin in `/opt/netbox/netbox/netbox/configuration.py`,
 or if you use netbox-docker, your `/configuration/plugins.py` file :

```python
PLUGINS = [
    'netbox_user_credentials_plugin'
]

PLUGINS_CONFIG = {
    "netbox_user_credentials_plugin": {},
}
```

## Feature Requests & Reporting Bugs

Feature Requests & Reporting Bugs can be submitted as [GitHub Issues](https://github.com/ilyjorsey/netbox-user-credentials-plugin/issues).
