---
title: People Management API
slug: release-notes-en/people-management-api
docTags:
createdAt: 2024-10-10T13:36:28.871Z
---
:::ExpandableHeading
## Release 1.3.3
| Release Information | Considerations |
| ---------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.3.3 |
| Publication Date | 12/20/2024 |
| Related Cards (Specify card title) | |
| Version Images | - **Run2biz - Production**: registry.cloud4biz.com/deployscdi/gestao-pessoas-api:1.3.3-RELEASE
- **CentralIT - Nexus**: nexus.centralit.io:9091/gestao-pessoas-api:1.3.3-RELEASE |
### Improvements/New Features
- Removed `/auth` from initial Keycloak route URLs for compatibility with version 25, only adding `/auth` in environment variables when needed
- Added internal route for 'get users by ids' - Requires environment variable `FEATURE_INTERNAL_ROUTES=true`
- Added 'max' parameter to `/groupMembers` route to define maximum users to return
- Added 'max' parameter to `/page/users/list` route to define maximum users to return
- Added 'isMarketplace' parameter to `/roles` route - when true, system roles and roles from unacquired applications are not returned
- Added 'mdGroups' parameter to getGroups route - when true, only groups with mdShow=true attribute are returned
- Added attributes for group creation/update
### Fixes
### Deployment Instructions
- [package\_gestao\_pessoas\_automation.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas/package_gestao_pessoas_automation.zip)
- [package\_gestao\_admin\_v1.0.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas_admin/package_gestao_admin_v1.0.zip): This package is only for the Main Tenant as it's an API component required for proper functionality
These instructions assume the version change is from the previous section to the current one. If this is not your scenario, follow the instructions from previous releases starting from your current environment version up to this one.
:::
:::ExpandableHeading
## Release 1.2.11
| Release Information | Considerations |
| ---------------------------------- | ---------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.2.11 |
| Publication Date | 11/13/2024 |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | - **CentralIT - Nexus**: nexus.centralit.io:9091/gestao-pessoas-api:1.2.11-RELEASE |
### Improvements/New Features
- Endpoint POST "/createOrUpdateGroup" now returns the ID of the updated/created group
- New GET endpoint "/groupMembers"
**/groupMembers - GET**
Returns group members (up to 10 users)
### Parameters
- groupID: string - ID of desired group
- first: number - (default = 0) returns users starting from this number (pagination)
### Fixes
- Fixed bug in desynchronized users mechanism when user cache is enabled, which caused apparent loss of user data when created/edited as cache wasn't synchronized with Keycloak
- Fixed bug in user creation by not finding the ID of newly created users
### Deployment Instructions
- [package\_gestao\_pessoas\_automation.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas/package_gestao_pessoas_automation.zip)
- [package\_gestao\_admin\_v1.0.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas_admin/package_gestao_admin_v1.0.zip): This package is only for the Main Tenant as it's an API component required for proper functionality
:::
:::ExpandableHeading
## Release 1.1.3
| Release Information | Considerations |
| ---------------------------------- | ------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.1.3 |
| Publication Date | 09/26/2024 |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | **CentralIT - Nexus**: nexus.centralit.io:9091/gestao-pessoas-api:1.1.3-RELEASE |
### Fixes
- Fixed bug in desynchronized users mechanism when user cache is enabled, which caused apparent loss of user data when created/edited as cache wasn't synchronized with Keycloak
- Fixed bug in user creation by not finding the ID of newly created users
### Deployment Instructions
- [package\_gestao\_pessoas\_automation.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas/package_gestao_pessoas_automation.zip)
- [package\_gestao\_admin\_v1.0.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas_admin/package_gestao_admin_v1.0.zip): This package is only for the Main Tenant as it's an API component required for proper functionality
:::
:::ExpandableHeading
## Release 1.1.2
| Release Information | Considerations |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.1.2 |
| Publication Date | 09/25/2024 |
| Related Cards (Specify card title) | - [6425 - \[Ticket - 17474- People Management\] Error when saving user edit screen](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6425)
- [6427 - \[People Management\] Fix errors in people management module with loading performance issues](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6427)
- [6586 - Ticket-17510: Fix errors in people management module with loading performance issues](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6586) |
| Version Images (Central IT) | **CentralIT - Nexus**: nexus.centralit.io:9091/gestao-pessoas-api:1.1.1-RELEASE |
### Improvements/New Features
- Added user search capability using fields like username, first name, last name and email
- Fixed search bug in error handling and value conversion
- Added optional Redis cache mechanism for user searches when Keycloak response is slow (e.g., LDAP integration in realm, Keycloak external to cluster network)
- Removed export buttons from Users/Dashboard interface
- Users without defined session are interpreted as "Unlimited"
- Added user search capability using fields like username, first name, last name and email
### Deployment Instructions
- These instructions assume the version change is from 1.1.2 to 1.1.1. If this is not your scenario, follow the instructions from previous releases starting from your current environment version up to this one.
- [package\_gestao\_pessoas\_automation.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas/package_gestao_pessoas_automation.zip)
- [package\_gestao\_admin\_v1.0.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas_admin/package_gestao_admin_v1.0.zip): This package is only for the Main Tenant as it's an API component required for proper functionality
| Key | Example Value | Optional | Description |
| ------------------------------------------- | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| MAX\_USERS\_BEFORE\_PAGINATION | 1000 (Default) | ✅ | Defines user retrieval strategy between pagination and batch based on number of users in target realm. Integer value. |
| USERS\_PER\_PAGE\_LIMIT | 500 (Default) | ✅ | Defines number of users per page in pagination strategy based on number of users in target realm. Integer value. |
| FEATURE\_USERS\_CACHE\_ENABLED | false | ✅ | Defines whether user cache should be enabled. Boolean value. |
| REDIS\_URL | redis\://localhost:6379 | ❌ | Defines Redis URL (must point to Redis master server). Format: redis\[s]://\[\[username]\[:password]@]\[host]\[:port]\[/db-number]. |
| FORCE\_FIRST\_RUN\_REFETCH | false | ✅ | Defines whether user cache should be updated on application startup ignoring local cache. Boolean value. |
| USERS\_BATCH\_UPDATE\_CRON | \*/30 \* \* \* \* | ✅ | Defines cron schedule for user cache updates. Cron value. |
| KEYCLOAK\_MAX\_REQUESTS\_PER\_SECOND | 20 | ✅ | Defines request limit per second for Keycloak. Integer value. |
| KEYCLOAK\_CACHE\_MAX\_REQUESTS\_PER\_SECOND | 10 | ✅ | Defines request limit per second for Keycloak cache. Integer value. |
:::
:::ExpandableHeading
## Release 1.1.1
| Release Information | Considerations |
| ---------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.1.1 |
| Publication Date | 09/25/2024 |
| Related Cards (Specify card title) | - [6425 - \[Ticket - 17474- People Management\] Error when saving user edit screen](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6425)
- [6427 - \[People Management\] Fix errors in people management module with loading performance issues](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6427)
- [6586 - Ticket-17510: Fix errors in people management module with loading performance issues](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6586) |
| Version Images (Central IT) | **CentralIT - Nexus**: nexus.centralit.io:9091/gestao-pessoas-api:1.1.1-RELEASE |
### Improvements/New Features
- Added user search capability using fields like username, first name, last name and email
- Added optional Redis cache mechanism for user searches when Keycloak response is slow (e.g., LDAP integration in realm, Keycloak external to cluster network)
- Removed export buttons from Users/Dashboard interface
- Users without defined session are interpreted as "Unlimited"
- Added user search capability using fields like username, first name, last name and email
### Deployment Instructions
- [package\_gestao\_pessoas\_automation.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas/package_gestao_pessoas_automation.zip)
- [package\_gestao\_admin\_v1.0.zip](https://gitlab.cloud4biz.com/lowcode/lowcode-packages/-/blob/main/GestaoPessoas_admin/package_gestao_admin_v1.0.zip): This package is only for the Main Tenant as it's an API component required for proper functionality
| Key | Example Value | Optional | Description |
| ------------------------------------------- | ----------------------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------- |
| MAX\_USERS\_BEFORE\_PAGINATION | 1000 (Default) | ✅ | Defines user retrieval strategy between pagination and batch based on number of users in target realm. Integer value. |
| USERS\_PER\_PAGE\_LIMIT | 500 (Default) | ✅ | Defines number of users per page in pagination strategy based on number of users in target realm. Integer value. |
| FEATURE\_USERS\_CACHE\_ENABLED | false | ✅ | Defines whether user cache should be enabled. Boolean value. |
| REDIS\_URL | redis\://localhost:6379 | ❌ | Defines Redis URL (must point to Redis master server). Format: redis\[s]://\[\[username]\[:password]@]\[host]\[:port]\[/db-number]. |
| FORCE\_FIRST\_RUN\_REFETCH | false | ✅ | Defines whether user cache should be updated on application startup ignoring local cache. Boolean value. |
| USERS\_BATCH\_UPDATE\_CRON | \*/30 \* \* \* \* | ✅ | Defines cron schedule for user cache updates. Cron value. |
| KEYCLOAK\_MAX\_REQUESTS\_PER\_SECOND | 20 | ✅ | Defines request limit per second for Keycloak. Integer value. |
| KEYCLOAK\_CACHE\_MAX\_REQUESTS\_PER\_SECOND | 10 | ✅ | Defines request limit per second for Keycloak cache. Integer value. |
:::
:::ExpandableHeading
## Release 1.0.11
| Release Information | Considerations |
| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Application | People Management API |
| Version Name | 1.0.11 |
| Publication Date | 09/02/2024 |
| Related Cards (Specify card title) | - [6425 - \[Ticket - 17474- People Management\] Error when saving user edit screen](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6425)
- [6427 - \[People Management\] Fix errors in people management module with loading performance issues](https://admin.4biz.one/kanban/workspaces/1196/boards/1633/tasks/6427) |
| Version Images (Central IT) | CentralIT - Nexus: nexus.centralit.io:9091/gestao-pessoas-api:1.0.11 |
### Improvements/New Features
- (FIX) Improved error handling in license checking.
### Fixes
- (FIX) Fixed bug in individual and batch user creation due to changes in license checking.
:::
:::ExpandableHeading
## Release 1.0.10
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.10 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Refactored log processing mechanism.
### Fixes
- (FIX) Changed service token to user token in license checking.
:::
:::ExpandableHeading
## Release 1.0.9
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.9 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Merged "Feature/auth cookie" branch
### Fixes
- Fixed error in user password change
:::
:::ExpandableHeading
## Release 1.0.5
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.5 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Changed pagination to server-side
- Changed user search to server-side
- Better performance
- Removed sorting due to Keycloak limitations
:::
:::ExpandableHeading
## Release 1.0.3
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.3 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Added role creation and deletion for users with "gp-admin" role
### Fixes
- Changed default password to meet PROD requirements
:::
:::ExpandableHeading
## Release 1.0.2
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.2 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Implemented bulk User Import/Export functionality
:::
:::ExpandableHeading{isOpen="true"}
## Release 1.0.0
| Release Information | Considerations |
| ---------------------------------- | --------------------- |
| Application | People Management API |
| Version Name | 1.0.0 |
| Publication Date | |
| Related Cards (Specify card title) | |
| Version Images (Central IT) | |
### Improvements/New Features
- Initial release of People Management API
- User CRUD operations
- Group CRUD operations
- Effective Users X Roles report (includes both directly assigned roles and indirect roles, e.g., roles inherited through group membership)
- Integrated with License Management API for user validation and session type management
### Fixes
### Deployment Instructions
:::