mirror of
https://github.com/netbox-community/netbox.git
synced 2024-05-10 07:54:54 +00:00
38 lines
2.4 KiB
Markdown
38 lines
2.4 KiB
Markdown
|
# Authentication
|
||
|
|
|
||
|
|
## Local Authentication
|
||
|
|
|
||
|
|
Local user accounts and groups can be created in NetBox under the "Authentication and Authorization" section of the administrative user interface. This interface is available only to users with the "staff" permission enabled.
|
||
|
|
|
||
|
|
At a minimum, each user account must have a username and password set. User accounts may also denote a first name, last name, and email address. [Permissions](./permissions.md) may also be assigned to users and/or groups within the admin UI.
|
||
|
|
|
||
|
|
## Remote Authentication
|
||
|
|
|
||
|
|
NetBox may be configured to provide user authenticate via a remote backend in addition to local authentication. This is done by setting the `REMOTE_AUTH_BACKEND` configuration parameter to a suitable backend class. NetBox provides several options for remote authentication.
|
||
|
|
|
||
|
|
### LDAP Authentication
|
||
|
|
|
||
|
|
```python
|
||
|
|
REMOTE_AUTH_BACKEND = 'netbox.authentication.LDAPBackend'
|
||
|
|
```
|
||
|
|
|
||
|
|
NetBox includes an authentication backend which supports LDAP. See the [LDAP installation docs](../installation/6-ldap.md) for more detail about this backend.
|
||
|
|
|
||
|
|
### HTTP Header Authentication
|
||
|
|
|
||
|
|
```python
|
||
|
|
REMOTE_AUTH_BACKEND = 'netbox.authentication.RemoteUserBackend'
|
||
|
|
```
|
||
|
|
|
||
|
|
Another option for remote authentication in NetBox is to enable HTTP header-based user assignment. The front end HTTP server (e.g. nginx or Apache) performs client authentication as a process external to NetBox, and passes information about the authenticated user via HTTP headers. By default, the user is assigned via the `REMOTE_USER` header, but this can be customized via the `REMOTE_AUTH_HEADER` configuration parameter.
|
||
|
|
|
||
|
|
### Single Sign-On (SSO)
|
||
|
|
|
||
|
|
```python
|
||
|
|
REMOTE_AUTH_BACKEND = 'social_core.backends.google.GoogleOAuth2'
|
||
|
|
```
|
||
|
|
|
||
|
|
NetBox supports single sign-on authentication via the [python-social-auth](https://github.com/python-social-auth) library. To enable SSO, specify the path to the desired authentication backend within the `social_core` Python package. Please see the complete list of [supported authentication backends](https://github.com/python-social-auth/social-core/tree/master/social_core/backends) for the available options.
|
||
|
|
|
||
|
|
Most remote authentication backends require some additional configuration through settings prefixed with `SOCIAL_AUTH_`. These will be automatically imported from NetBox's `configuration.py` file. Additionally, the [authentication pipeline](https://python-social-auth.readthedocs.io/en/latest/pipeline.html) can be customized via the `SOCIAL_AUTH_PIPELINE` parameter.
|