> For the complete documentation index, see [llms.txt](https://tech.x2bee.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tech.x2bee.com/api-guide/api-guides-en/back-office/system-bo/user-management.md).

# User Management

A service that provides user management functionality for managing shopping mall operations users. It supports convenient management of user information, user organization (department), permission groups, and individual permissions.

***

## Key Features

* **User Information Management**
  * You can look up the user list, check user detail information, and register/modify users.
  * Users can belong to various departments and permission groups.
* **User Organization (Department) Management**
  * You can look up departments, register new departments, and modify/delete existing departments.
* **Permission Group Management**
  * You can look up permissions for various groups and grant or revoke permissions.
  * Each group is classified into major groups such as Back Office, Customer Center, and Partner.
* **Individual Permission Management**
  * You can grant or revoke individual permissions for each user.
  * Fine-grained permission adjustment is possible per user.

## Process Definition — User Information and Organization Management

You can look up user information and register or modify users.

You can look up the user organization (department) and register, modify, or delete departments.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2FvAtC97rS2dKlztr6GmTL%2F%E1%84%89%E1%85%A1%E1%84%8B%E1%85%AD%E1%86%BC%E1%84%8C%E1%85%A1.png?alt=media&#x26;token=e996c9fc-c280-47a1-b824-3de08263c779" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### User List Lookup

Looks up the user list.
{% endstep %}

{% step %}

### User Detail Information Lookup

After looking up the user list, you can select a user to open the user modification popup, where you can look up the detail information for that user.
{% endstep %}

{% step %}

### User Registration/Modification Popup

You can register/modify users.\
Permission group lookup, department list lookup, and partner list lookup are each performed via their respective popups.\
When registering a user, you must use the user ID count lookup API to check for ID duplication.\
In user modification, you can unlock a user's password lock and reset their password. When the password is reset, it is changed to an encoded random value, and the changed value is sent to the user's mobile phone via AlimTalk.
{% endstep %}

{% step %}

### User Information DB

Registers/modifies users. If the permission group is Partner, the partner number must be entered as required.\
When modifying a user, saves history records for usage status log, personal information handling status log, work group change log, and permission group change log.
{% endstep %}

{% step %}

### Department Hierarchy List Lookup

Looks up the department hierarchy, and looks up, registers, modifies, and deletes each department's sub-departments.
{% endstep %}
{% endstepper %}

***

## Process Definition — Permission Group and Individual Permission Management

Looks up and manages the permission group list. Looks up the menus matching each permission and looks up the button permissions on that menu to manage button permissions.

Looks up the individual permission list for a user. Looks up the menu permissions for an individual user and looks up the button permissions of that menu to manage them.

<figure><img src="https://2999922013-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FXTxKSWMmuxEkop1pvuwe%2Fuploads%2F25qFLBqlO1uLZYRBo75U%2F%E1%84%80%E1%85%AF%E1%86%AB%E1%84%92%E1%85%A1%E1%86%AB.png?alt=media&#x26;token=e7f9314d-e2c0-42e2-a6d6-d84c5c322978" alt=""><figcaption></figcaption></figure>

{% stepper %}
{% step %}

### Permission Group List Lookup

Looks up the permission group list and registers or modifies it.
{% endstep %}

{% step %}

### Menu Tree List Lookup

Looks up the menu permission list matching the group in a tree structure, and modifies the menu permission usage status. Uses the APIs in Menu Information Management.
{% endstep %}

{% step %}

### Permission Group Button List Lookup

Looks up the button permission list matching the corresponding menu. Grants or revokes permissions.
{% endstep %}

{% step %}

### Individual Permission List Lookup

Looks up the individual permission list and registers or modifies it.
{% endstep %}

{% step %}

### Menu Permission List Lookup (Individual User)

Looks up an individual user's menu permissions in a tree structure and modifies the menu permission usage status. Modification of the menu permission usage status uses the APIs in Menu Information Management.
{% endstep %}

{% step %}

### Permission Group Button List Lookup (Individual User)

Looks up the button permission list matching the corresponding menu. Grants or revokes permissions.
{% endstep %}
{% endstepper %}

***

## API Function List — User Information Management

<table><thead><tr><th width="127.888916015625">API</th><th width="253.888916015625">Description</th><th width="92.4444580078125">Server</th><th width="91.5555419921875">Method</th><th>Notes</th></tr></thead><tbody><tr><td>User List Lookup</td><td>Looks up the user list.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserListInUserMenu">🔗View API ></a></td></tr><tr><td>User List Count Lookup</td><td>Looks up the user list count.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserListInUserMenuCount">🔗View API ></a></td></tr><tr><td>User Information Lookup</td><td>Looks up user information.</td><td>BO</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗View API ></a> Not used on screen; provided to other services or APIs.</td></tr><tr><td>User Detail Information Lookup</td><td>Looks up the user's detail information.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserDetail">🔗View API ></a></td></tr><tr><td>User ID Count Lookup</td><td>Looks up the user's ID count.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserCount">🔗View API ></a></td></tr><tr><td>Password Unlock</td><td>Unlocks a user whose password has been locked.</td><td>BO</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗View API ></a></td></tr><tr><td>Password<br>Reset</td><td>Resets a user's password to a random value, and the changed password is sent to the user's mobile phone via AlimTalk. *Single message send: /api/common/v1/common/sendMessage</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=modifyInitializePassword">🔗View API ></a></td></tr><tr><td>User Save</td><td>Saves user information.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=saveUser">🔗View API ></a></td></tr><tr><td>User Permission<br>Group List Lookup</td><td>Looks up the user permission group list.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserRightGroupInfo">🔗View API ></a></td></tr><tr><td><p>User Permission</p><p>Group List Count Lookup</p></td><td>Looks up the user permission group list count.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A0%95%EB%B3%B4%20%EA%B4%80%EB%A6%AC&#x26;path=getUserRightGroupListCount">🔗View API ></a></td></tr></tbody></table>

***

## API Function List — User Organization Management

<table><thead><tr><th width="132.3333740234375">API</th><th width="275.22216796875">Description</th><th width="98">Server</th><th width="91.333251953125">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Department Hierarchy List Lookup</td><td>Looks up the currently saved department list in a hierarchical structure.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A1%B0%EC%A7%81%20%EA%B4%80%EB%A6%AC&#x26;path=getUserDeptListWithHierarchy">🔗View API ></a></td></tr><tr><td>Sub-Department List Lookup</td><td>Looks up the sub-department list.</td><td>BO</td><td>GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A1%B0%EC%A7%81%20%EA%B4%80%EB%A6%AC&#x26;path=getUserDeptList">🔗View API ></a></td></tr><tr><td>Sub-Department List Count Lookup</td><td>Looks up the sub-department list count.</td><td>BO</td><td>GET</td><td><a href="http://api.x2bee.com/content?msa=common&#x26;depth=%EC%95%8C%EB%A6%BC%EB%A9%94%EC%8B%9C%EC%A7%80&#x26;path=sendMessage">🔗View API ></a></td></tr><tr><td>Department List Save</td><td>Registers, modifies, and deletes department list information.</td><td>BO</td><td>POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EC%82%AC%EC%9A%A9%EC%9E%90%20%EC%A1%B0%EC%A7%81%20%EA%B4%80%EB%A6%AC&#x26;path=saveUserDeptList">🔗View API ></a></td></tr></tbody></table>

***

## API Function List — Permission Group Management

<table><thead><tr><th width="111.22216796875">API</th><th width="287.888916015625">Description</th><th width="93.5555419921875" align="center">Server</th><th width="93.5555419921875" align="center">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Permission Group List Lookup</td><td>Looks up the permission group list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=getRightGroupBaseList">🔗View API ></a></td></tr><tr><td>Permission Group List Count Lookup</td><td>Looks up the permission group list count.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=getRightGroupBaseListCount">🔗View API ></a></td></tr><tr><td>Permission Group Save</td><td>Registers, modifies, and deletes permission group information.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=saveRightGroupBaseList">🔗View API ></a></td></tr><tr><td>Permission Group Button<br>Permission Save</td><td>Saves the button permission for a menu permission.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=saveRightTargetBaseMenu">🔗View API ></a></td></tr><tr><td>Permission Group Button List Lookup</td><td>Looks up the button list for a permission group menu.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=getRightGroupButtonList">🔗View API ></a></td></tr><tr><td>Dashboard<br>Permission Group<br>Lookup</td><td>Looks up the dashboard permission group.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B6%8C%ED%95%9C%20%EA%B7%B8%EB%A3%B9%20%EA%B4%80%EB%A6%AC&#x26;path=getRtInfo">🔗View API ></a></td></tr></tbody></table>

***

## API Function List — Individual Permission Management

<table><thead><tr><th width="103.4444580078125">API</th><th width="291">Description</th><th width="94.6666259765625" align="center">Server</th><th width="90.111083984375" align="center">Method</th><th>Notes</th></tr></thead><tbody><tr><td>Individual Permission List Lookup</td><td>Looks up the individual permission list.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B0%9C%EB%B3%84%20%EA%B6%8C%ED%95%9C%20%EA%B4%80%EB%A6%AC&#x26;path=getIndividualRightList">🔗View API ></a></td></tr><tr><td>Individual Permission List Count Lookup</td><td>Looks up the individual permission list count.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B0%9C%EB%B3%84%20%EA%B6%8C%ED%95%9C%20%EA%B4%80%EB%A6%AC&#x26;path=getDisplayTemplateListCount">🔗View API ></a></td></tr><tr><td>Menu Permission List Lookup</td><td>Looks up the menu permission list for a user.</td><td align="center">BO</td><td align="center">GET</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B0%9C%EB%B3%84%20%EA%B6%8C%ED%95%9C%20%EA%B4%80%EB%A6%AC&#x26;path=getIndividualMenuTreeList">🔗View API ></a></td></tr><tr><td>Individual Permission Save</td><td>Registers and modifies individual permissions.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B0%9C%EB%B3%84%20%EA%B6%8C%ED%95%9C%20%EA%B4%80%EB%A6%AC&#x26;path=saveIndividualRightList">🔗View API ></a></td></tr><tr><td>Button Permission Save</td><td>Modifies button permissions.</td><td align="center">BO</td><td align="center">POST</td><td><a href="https://apibo.x2bee.com/content?bo=system&#x26;depth=%EA%B0%9C%EB%B3%84%20%EA%B6%8C%ED%95%9C%20%EA%B4%80%EB%A6%AC&#x26;path=saveIndividualRightButtonGridList">🔗View API ></a></td></tr></tbody></table>

***