Skip to content

Commit

Permalink
docs(user-mgt): updated user management
Browse files Browse the repository at this point in the history
Signed-off-by: Mobarak Hosen Shakil <[email protected]>
  • Loading branch information
imShakil committed Sep 20, 2024
1 parent 3c87c80 commit 992a5f7
Showing 1 changed file with 52 additions and 4 deletions.
56 changes: 52 additions & 4 deletions docs/admin/usermgmt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,61 @@ tags:
- user management
---

## This content is in progress
# Local User Management

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.
In this document we will cover managing people in the Jans Server's LDAP Directory, Jans CLI / TUI and using SCIM.

## Have questions in the meantime?
=== "Manage Data using DB Browser"

You can manage your Janssen Server data using external tool provided by specific DB. For example, to manage LDAP data, Jump into [Manage data in Jans LDAP](#manage-data-in-jans-ldap) section for guidelines.

=== "User Management using SCIM"

SCIM allows many ways to manage users data. Jump into the [SCIM User Management](../config-guide/scim-config/user-config.md) for guidelines of SCIM operations. To know how SCIM works in Janssen Server, read more from [here](../../admin/scim/README.md).

=== "Manage External Data Sources Using Link"

Janssen Server allows connecting external data sources using Jans Link. Syncing people and attributes from a backend server speeds up authentication transactions. It is possible to perform attribute transformations, changing the name of attributes, or even using an interception script to change the values. Transformations are stored locally in Janssen Server. Read out [Link Guide](../../admin/link/README.md) to know more details on it.


## 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](http://jxplorer.org/) or [Apache Directory Studio](https://directory.apache.org/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

![ldap-connection](https://github.com/JanssenProject/jans/assets/43112579/901483e4-d903-4b5f-af45-0a0c9957c29b)


* Perform authentication. 'Password' is the the password of 'admin' user.


![ldap-creds](https://github.com/JanssenProject/jans/assets/43112579/c9751ddf-8a0f-4fad-9b49-12ebd425018d)


* Browse ldap and go to `ou=people`.


![ldap_people](https://github.com/JanssenProject/jans/assets/43112579/8da57305-0227-4bdb-82f8-0044f8b05afe)

While this documentation is in progress, you can ask questions through [GitHub Discussions](https://github.com/JanssenProject/jans/discussions) or the [community chat on Gitter](https://gitter.im/JanssenProject/Lobby). Any questions you have will help determine what information our documentation should cover.

## Want to contribute?

Expand Down

0 comments on commit 992a5f7

Please sign in to comment.