Using CLI/TUI
Local User Management#
In this document we will cover managing people in the Jans Server's LDAP Directory, Jans CLI and Jans TUI.
Manage data in Jans LDAP#
All the data generated by the Jans Server is stored in the local LDAP server included in every deployment. This includes OpenID Connect client data, session data, tokens, user data, and more.
Use an LDAP browser like JXplorer or Apache Directory Studio and can find the configuration in /etc/jans/conf/jans-ldap.properties, e.g.:
For Jans OpenDJ, it will look like this:
bindDN: cn=directory manager
bindPassword: rmQQI/sax0U=
servers: localhost:1636
Establish a tunnel from your computer to the target Jans Server's LDAP. Tunneling is required because Jans Server's LDAP port, 1636, is not exposed to the internet.
In the below example we are showing how to connect and use Jans Server's internal LDAP server with any LDAP browser.
- Sign in with
sudo su - - Create tunnel:
ssh -fNL 5902:localhost:1636 [username]@[ip_of_Jans_server]- Open LDAP browser
- Create new connection
- Perform authentication. 'Password' is the the password of 'admin' user.
- Browse ldap and go to
ou=people.
Manage data in Jans TUI#
We can easily add a user using Jans TUI. To do that, run the TUI using /opt/jans/jans-cli/config-cli-tui.py for example, and click on the Users tab.
Let's see at a glance user attributes.
| Attributes | Description |
|---|---|
| Username | ... |
| Password | ... |
| First Name | ... |
| Middle Name | ... |
| Last Name | ... |
| Display Name | ... |
| ... | |
| Active | ... |
| Nickname | ... |
| CIBA Device Registration Token | ... |
| CIBA User code | ... |
| Locale | ... |
| Website URL | ... |
| IMAP Data | ... |
| jansAdminUIRole | ... |
| Enrollment code | ... |
| User Permission | ... |
| Preferred Language | ... |
| Profile URL | ... |
| Secret Question | ... |
| Email Verified | ... |
| Birthdate | ... |
| Time zone info | ... |
| Phone Number verified | ... |
| Preferred Username | ... |
| TransientId | ... |
| PersistentId | ... |
| Country | ... |
| Secret Answer | ... |
| OpenID Connect JSON formatted address | ... |
| User certificate | ... |
| Organization | ... |
| Picture URL | ... |
Let's add an user by selecting Add Users tab. Initially we can provide bellow attributes value,
We can add extra claims simple by slecting Add Claim
Finally save and exit. We will get an unique inum
This content is in progress#
The Janssen Project documentation is currently in development. Topic pages are being created in order of broadest relevance, and this page is coming in the near future.
Have questions in the meantime?#
While this documentation is in progress, you can ask questions through GitHub Discussions or the community chat on Gitter. Any questions you have will help determine what information our documentation should cover.
Want to contribute?#
If you have content you'd like to contribute to this page in the meantime, you can get started with our Contribution guide.
Created: 2022-07-26
