TrueNAS SCALE Documentation Archive
This content follows the TrueNAS SCALE 22.12 (Bluefin) releases. Archival documentation is provided for reference only and not actively maintained.
Use the Product and Version selectors above to view content specific to different TrueNAS software or major versions.
Auth
4 minute read.
Last Modified 2024-03-19 08:47 EDTThe SCALE CLI guide is a work in progress! New namespace and command documentation is continually added and maintained, so check back here often to see what is new!
The auth namespace has five commands and four child namespaces and is based on functions found in the SCALE API and web UI. It provides access to authentication methods for the logged-in user and a method to generate an access token for web UI session through the five auth commands. The four child namespaces have their own commands.
You can enter commands from the main CLI prompt or from an auth namespace prompt.
The check_user
and check_password
commands verify the logged-in credentials.
The check_password
and check_user
commands verify the logged-in user credentials.
The generate_token
command generates an authentication token to use for access. The setting determines when the current session expires.
The me
command returns password, user and group information about the currently logged-in user.
The two_factor_auth
command returns the state of two-factor authentication for the logged-in user.
The following articles provide information on auth child authentication namespaces:
- API_Key: Provides information about the auth api_key namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Privilege: Provides information about the auth privilege namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Sessions: Provides information about the auth sessions namespace in the TrueNAS CLI. Includes command syntax and common commands.
- Two_Factor: Provides information about the auth two_factor namespace in the TrueNAS CLI. Includes command syntax and common commands.