> For the complete documentation index, see [llms.txt](https://community-test.logicnets.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/usermanagement.md).

# Usermanagement

## Description

The *usermanagement* part allows you to manage local groups, group roles, group users, packages on portal, and group terms and conditions.

## Use

You can use this part to manage user management functions through LogicNets applications. It is a specialized part with advanced use cases. In using this part in modeled logic, your application administrators do not need to perform basic user management functions when installing an application. The functions below allow you to automate user management actions as part of an application during installation and runtime use.

One typical use case for this part is so you can model user management functions in a logicnet you place in the *postinstalljobs* folder in your project. The system executes all logicnets in the *postinstalljobs* folder when you install the package or when you install or upgrade it. You can use [post-installation jobs](/release-9/platform-documentation/system-administration/package-installation/post-installation-jobs.md) to initialize the system, create default groups, and set group role assignments.

LogicNets implemented the usermanagement part in such way that it will not create duplicate group or user entries.

## Required Licenses

To use this part, you must purchase the *Elevated Privileges* license. Without this license, the system blocks the use of this part during design and runtime.

## Modes and Parameters

### Modes

This part offers different functions to manage to access to the system based on associated modes. It supports the following modes:

| Mode                                | Description                                                                                                                                      |
| ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| **Assign group roles**              | This mode adds roles from the installation package to a specified user group. If this user group does not exist, the system will also create it. |
| **Create group**                    | This mode create a user group.                                                                                                                   |
| **Add user to usergroup**           | This mode adds a user to a user group based on their login email address.                                                                        |
| **Remove user from all usergroups** | This mode removes a user from all user groups based on their login email address.                                                                |
| **Add package to portal**           | This mode adds the current package to the portal launch page for all members of the specified user group.                                        |

### Assign-group-roles Parameters

| Tab       | Field Name | Description/Use                                                                             | Type/Options | Optional/Mandatory |
| --------- | ---------- | ------------------------------------------------------------------------------------------- | ------------ | ------------------ |
| **Basic** | Group name | This is the name of the user group.                                                         | Text         | Mandatory          |
| **Basic** | Role name  | This is the role name, as specified in the project settings of the package to be installed. | Text         | Mandatory          |

### Create-user-groups Parameters

| Tab       | Field Name        | Description/Use                                              | Type/Options | Optional/Mandatory |
| --------- | ----------------- | ------------------------------------------------------------ | ------------ | ------------------ |
| **Basic** | Group name        | This is the name of the user group the system should create. | Text         | Mandatory          |
| **Basic** | Group description | This is the description of the user group.                   | Text         | Optional           |

### Add-user-to-user-groups Parameters

| Tab       | Field Name | Description/Use                                              | Type/Options | Optional/Mandatory |
| --------- | ---------- | ------------------------------------------------------------ | ------------ | ------------------ |
| **Basic** | Group name | This is the name of the user group the system should create. | Text         | Mandatory          |
| **Basic** | User       | This is the user’s email address.                            | Text         | Mandatory          |

### Remove-user-from-all-user-groups Parameters

| Tab       | Field Name | Description/Use                   | Type/Options | Optional/Mandatory |
| --------- | ---------- | --------------------------------- | ------------ | ------------------ |
| **Basic** | User       | This is the user’s email address. | Text         | Mandatory          |

### Add-package-to-portal Parameters

| Tab       | Field Name | Description/Use                                              | Type/Options | Optional/Mandatory |
| --------- | ---------- | ------------------------------------------------------------ | ------------ | ------------------ |
| **Basic** | Group name | This is the name of the user group the system should create. | Text         | Mandatory          |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://community-test.logicnets.com/release-9/platform-documentation/process-node-parts/usermanagement.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
