User Management Java APIs

This page documents the Kyvos Reporting Java APIs for SecurityManager-based administration across organization, user, and role management. It is intended for Java developers, integration engineers, and administrators who need to automate tasks such as organization CRUD operations, user and role management, privilege assignment, and user mapping.

Before using these APIs, ensure Kyvos Reporting is installed and accessible, the required Java client libraries are added to the classpath, the Report Client is initialized, and requests are executed using an authenticated UserInfo with the required permissions. Validate organization IDs, user IDs, role IDs, entity IDs, and privilege values before submitting requests.

The following sections provide imports, method signatures, usage steps, sample code references, and examples for common administration tasks such as organization management, user lookup and deletion, privilege assignment, role management, user mapping, and system privilege updates. API methods typically throw ISecurityException for security, connectivity, execution, or parsing failures. Lookup methods may return null if the requested object is not found.

For security and operational safety, follow least-privilege access, avoid hardcoding credentials, protect sensitive data in logs, and review privilege changes before applying them in production.

• OrgInfo: Organization details, including ID, description, delete capability, and authentication settings.

• UserInfo: User details used for authentication, lookup, privilege assignment, and role operations.

• RoleInfo: Role metadata used for role creation, retrieval, assignment, and deletion.

• AppInfo: Security principal receiving privileges, such as a user, role, or organization.

• EntityInfo: Secured object such as a category, report, dashboard, cube object, or database connection.

• EntityAccessRight and EntityGroupAccessRight: Access levels, grants, grouped rights, and operation behavior.

• Access levels and opCode: Define how privileges are granted, denied, replaced, or updated.

• Organization authentication modes: Configure Kyvos Reporting, external application, host application, or callback-based authentication.

1. Add the required imports and Kyvos Reporting Java client libraries to the classpath.

2. Initialize the Report Client and create an authenticated requestor UserInfo.

3. Create a SecurityManager instance using SecurityManager.getInstance().

4. Build the required objects such as OrgInfo, UserInfo, RoleInfo, AppInfo, or EntityInfo.

5. Call the required API method, handle ISecurityException, and validate returned results before use.

Use the following imports for User Management APIs:

Retrieves details of an organization using its organization ID.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/GetOrgById.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create a SecurityManager instance.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Retrieve organization details using getOrganizationById.

• orgId: ID of the organization.

• userInfo: Current user details.

• OrgInfo object for the given orgId. Returns null if not found.

Retrieves a list of users belonging to an organization.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/GetUserListForOrg.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create a SecurityManager instance.

4. Call getUserListForOrganization.

• orgId: ID of the organization.

• ArrayList of UserInfo objects.

Retrieves all organizations in the Kyvos Reporting repository.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/GetOrgList.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create a SecurityManager instance.

4. Call getOrgList.

• ArrayList of OrgInfo objects.

Creates a new organization and sets its authentication mode.

Sample code:

• <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/AddOrg.java

• AddCallbackOrg.java (for callback authentication).

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create OrgInfo instance.

   String organisationId = "Test"; OrgInfo addOrg = new OrgInfo(organisationId);

4. Set authentication mode.

• 1 – Intellicus (Kyvos Reporting) (REPORTINGSYS)

• 2 – External Application (EXTERNALAPP)

• 3 – Host Application (HOSTAPP)

• 4 – Callback (CALLBACK)

Updates organization details.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/ModifyOrg.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Retrieve organization by ID.

4. Update attributes.

5. Call modifyOrganization.

Deletes an existing organization.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/Organization Management/DeleteOrg.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Retrieve organization by ID.

4. Call deleteOrganization.

Grants category access privileges to an organization.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignCategoryPrivilegesToOrg.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create a SecurityManager instance.

4. Create AppInfo with the target organization.

5. Create EntityInfo for the category.

6. Create EntityAccessRight and set the access level.

7. Optionally, set entity group access rights (Reports, Dashboards).

8. Call grantEntityPrivileges.

• entity: Entity object with ID and type (supported types in EntityTypeNames).

• entityAccessRight: Object with AppInfo, access level, and grants.

• userInfo: Current user details.

Grants database connection privileges to an organization.

Sample code:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignConnectionPrivilegesToOrg.java

1. Initialize Report Client.

2. Initialize Requestor UserInfo.

3. Create a SecurityManager instance.

4. Create AppInfo with the target organization.

5. Create EntityInfo for the connection.

6. Create EntityAccessRight and set the access level.

7. Call grantEntityPrivileges.

Use this API to get information for a specific user.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/GetUserById.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object to retrieve controller information for administration operations.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Get the user by user ID.

Returns a UserInfo object for the specified userId and orgId. May return null.

• userId – ID of the requested user.

• orgId – Organization ID of the requested user.

• userInfo – Current user details.

• UserInfo – Object containing the given user’s details.

Use this API to create a new user in the Kyvos Reporting Repository.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AddUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Create a new UserInfo instance and set its attributes.

   String username = "Mary"; String password = "123456"; String orgId = "Org1"; UserInfo addUserInfo = new UserInfo(username, password, orgId);

   • To make the user an organization admin:

     addUserInfo.setAdmin(true);

   • To make the user a super admin:

     addUserInfo.setSuperAdmin(true);

5. Add the user to the Kyvos Reporting Repository.

Adds a new user to the Report Engine.

• newUserInfo – New user details.

• userInfo – Current user details.

Use this API to assign category access privileges to a specific user, role, or organization.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignCategoryPrivilegesToOrg.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Create an AppInfo instance with user ID, organization, and app type (USER, ROLE, or "" for Org).

   String userId = "Mary"; String orgId = "TestOrg"; String appType = "USER"; AppInfo appInfo = new AppInfo(userId, orgId, appType);

5. Create an EntityInfo object for the target entity.

   EntityInfo entityInfo = new EntityInfo(catId, "CATEGORY");

6. Create an EntityAccessRight object and set access rights.

   EntityAccessRight ear = new EntityAccessRight(); ear.setAppInfo(appInfo); ear.setAccessLevel(Enums.SecurityTypes.AccessLevel.PARTIALACCESS); ear.setAccessRightGrants("0,1,2");

7. (Optional) Assign access rights to reports under the category.

   EntityGroupAccessRight reportEAR = new EntityGroupAccessRight(); reportEAR.setType("REPORT"); reportEAR.setAccessLevel(1); // 0 = deny, 1 = full, 2 = partial reportEAR.setGrants("10,12,14"); ear.addEntityGroupAccessRight(reportEAR);

8. Set operation code.

   ear.setOpCode("REPLACE");

Assigns access rights to a user, role, organization, or everyone for an entity.

• entity – Target entity (CATEGORY, REPORT, QO, PO, CUBEOBJECT, DASHBOARD2, DASHBOARD_WIDGET, DBCONNECTION).

• entityAccessRight – Access rights object containing AppInfo and privileges.

• userInfo – Current user details.

• ISecurityException – If the request fails due to:

  • Connection failure.

  • Read/write error.

  • Execution error on the engine.

  • Invalid or unparsed server response.

Use this API to assign access privileges for a specific report to a user.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignReportPrivilegesToUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

4. Create an AppInfo instance.

   String appId = "Mary"; String orgId = "TestOrg"; String appType = "USER"; AppInfo appInfo = new AppInfo(appId, orgId, appType);

5. Create an EntityInfo instance for the report.

   String reportId = "D07131A2-87AA-154E-6E17-6079C9AFD176"; EntityInfo entityInfo = new EntityInfo(reportId, "REPORT");

6. Create and configure EntityAccessRight.

   EntityAccessRight ear = new EntityAccessRight(); ear.setAppInfo(appInfo); ear.setAccessLevel(Enums.SecurityTypes.AccessLevel.PARTIALACCESS); ear.setAccessRightGrants("0,2,4,6,7,8,12"); ear.setOpCode("REPLACE");

(Same as Assign Category Privileges)

Use this API to assign privileges for an entity (such as Query Objects) to a user.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignEntityPrivilegesToUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

4. Create an AppInfo instance.

   String userId = "Mary"; String orgId = "TestOrg"; String appType = "USER"; AppInfo appInfo = new AppInfo(userId, orgId, appType);

5. Create an EntityInfo instance.

   String entityId = "SalesQuery"; EntityInfo entityInfo = new EntityInfo(entityId, "QO");

6. Create and configure EntityAccessRight.

   EntityAccessRight ear = new EntityAccessRight(); ear.setAppInfo(appInfo); ear.setAccessLevel(Enums.SecurityTypes.AccessLevel.PARTIALACCESS); ear.setAccessRightGrants("0,2");

(Same as above)

Use this API to assign system-level privileges to a user. Both the target user (UserInfo) and the requesting user must be specified.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignSystemPrivilegesToUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Retrieve the target user by ID.

   String userId = "FinanceUser"; String organization = "MyOrg"; UserInfo userInfo = sMgr.getUserById(userId, organization, requestorUserInfo);

5. Assign system privileges.

Sets system privileges in a comma-separated format.

• CATEGORY_SETUP

• DATA_ADMIN

• IM_SUPPORT

• SYSTEMPRIVILEGESMAP

• SCHEDULER

• REPORT_DESIGNER

• DEPLOYREPORTBUNDLE

• CATEGORY_SETUP_GLOBAL

• SCHEDULER_GLOBAL

• DATA_ADMIN_GLOBAL

• ADHOCREPORTDESIGNER

• WIDGET_DESIGNER

• GENERATE_LINK

• GENERATE_LINK_GLOBAL

Use this API to assign an existing role to an application user. Existing roles remain intact.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignRoleToUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

4. Retrieve the target user.

   String userId = "User1"; String orgId = "MyOrg"; UserInfo userInfo = sMgr.getUserById(userId, orgId, requestorUserInfo);

5. Retrieve the role to be assigned.

   String roleId = "Manager"; RoleInfo roleInfo = sMgr.getRoleById(roleId, orgId, requestorUserInfo);

6. Grant the role.

Grants a role to the specified user without removing existing roles.

• targetUInfo – UserInfo object for the user.

• rInfo – RoleInfo object representing the role.

• userInfo – Requesting user details.

Use this API to assign more than one role to an application user.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/AssignRolesToUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

4. Retrieve the target user.

   String userId = "TestUser"; String orgId = "MyOrg"; UserInfo userInfo = sMgr.getUserById(userId, orgId, requestorUserInfo);

5. Retrieve roles to be assigned.

   String roleId1 = "Manager"; String roleId2 = "Administrator"; RoleInfo roleInfo1 = sMgr.getRoleById(roleId1, orgId, requestorUserInfo); RoleInfo roleInfo2 = sMgr.getRoleById(roleId2, orgId, requestorUserInfo);

6. Add roles to an ArrayList.

   ArrayList<RoleInfo> roleInfoArr = new ArrayList<>(); roleInfoArr.add(roleInfo1); roleInfoArr.add(roleInfo2);

7. Assign roles to the user.

Attaches multiple roles to the target user.

• targetUInfo – User to attach roles to.

• roleInfos – List of roles.

• userInfo – Current user details.

Use this API to revoke or remove a specified role from a user.

Sample code location:
<KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/RevokeRoleFromUser.java

1. Initialize Report Client.

2. Initialize requestor UserInfo.

3. Create a SecurityManager object.

4. Retrieve the target user.

   String userId = "User1"; String orgId = "MyOrg"; UserInfo userInfo = sMgr.getUserById(userId, orgId, requestorUserInfo);

5. Retrieve the role to be revoked.

   String roleId = "Manager"; RoleInfo roleInfo = sMgr.getRoleById(roleId, orgId, requestorUserInfo);

6. Revoke the role.

Removes a role assigned previously to a user.

• targetUInfo – UserInfo object representing the user.

• rInfo – RoleInfo object representing the role.

• userInfo – Current user details.

The User Mapping API maps a host application user to an Kyvos Reporting user in the Kyvos Reporting Repository.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/UserMapping.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Get the target user.

   String userId = "Smith"; String password = ""; String orgId = "MyOrg"; UserInfo userInfo = new UserInfo(userId, password, orgId);

5. Map the new user.

   String newUserId = "John"; sMgr.mapAppIdToUser(newUserId, userInfo, requestorUserInfo);

Adds a mapping between an application ID and a user.

The Delete User API removes an existing user from the Kyvos Reporting Repository.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/User Management/DeleteUser.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Get the user to delete.

   String userId = "FinanaceUser"; String orgId = "FinanceOrg"; UserInfo targetUserInfo = sMgr.getUserById(userId, orgId, requestorUserInfo);

5. Delete the user.

   sMgr.deleteUser(targetUserInfo, requestorUserInfo);

Deletes the specified user from the Report Engine.

The Get Role List API retrieves all roles from the Kyvos Reporting Repository.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Role Management/GetRoleList.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

   SecurityManager sMgr = SecurityManager.getInstance();

4. Retrieve the role list.

   ArrayList roleList = sMgr.getRoleList(requestorUserInfo);

Returns a list of all roles in the Kyvos Reporting repository.

The Create Role API adds a new role to an existing organization.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Role Management/AddRole.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

4. Create a new role.

   String roleName = "MANAGER"; String orgId = "Org1"; RoleInfo newRole = new RoleInfo(roleName, orgId);

5. Add the role.

   sMgr.addRole(newRole, requestorUserInfo);

Adds a new role to the Report Engine.

The Assign Category Privileges API grants category access rights to a role.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Role Management/AssignCategoryPrivilegesToRole.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

4. Create EntityInfo and AppInfo.

   String roleId = "Manager"; String orgId = "hostOrg"; String categoryId = "B2996F87-FE41-8D19-6C67-B3C22803DD99"; EntityInfo entityInfo = new EntityInfo(categoryId, "CATEGORY"); AppInfo appInfo = new AppInfo(roleId, orgId, "ROLE");

5. Configure access rights.

   EntityAccessRight ear = new EntityAccessRight(); ear.setAppInfo(appInfo); ear.setAccessLevel(Enums.SecurityTypes.AccessLevel.FULLACCESS);

6. Assign privileges.

   sMgr.grantEntityPrivileges(entityInfo, ear, adminUserInfo);

Assigns access rights to a user, role, organization, or Everyone.

The Assign Report Privileges API grants report access rights to a role.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Role Management/AssignReportPrivilegesToRole.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

4. Create EntityInfo and AppInfo.

   String roleId = "Manager"; String organisationId = "Intellica"; String reportId = "638CB7A6-F504-0ECD-008F-10B25253DCA8"; EntityInfo entityInfo = new EntityInfo(reportId, "REPORT"); AppInfo appInfo = new AppInfo(roleId, organisationId, "ROLE");

5. Configure access rights.

   EntityAccessRight ear = new EntityAccessRight(); ear.setAppInfo(appInfo); ear.setAccessLevel(Enums.SecurityTypes.AccessLevel.FULLACCESS);

6. Assign privileges.

   sMgr.grantEntityPrivileges(entityInfo, ear, adminUserInfo);

The Delete Role API removes a role from an organization in the Kyvos Reporting Repository.

Reference: <KyvosReporting_Install_Path>/SampleCodes/Java APIs/Role Management/DeleteRole.java

1. Initialize the Report Client.

2. Initialize the requestor UserInfo.

3. Create a SecurityManager instance.

4. Create the role to delete.

   String roleId = "Manager"; String orgId = "Test"; RoleInfo roleInfo = new RoleInfo(roleId, orgId);

5. Delete the role.

   sMgr.deleteRole(roleInfo, requestorUserInfo);

Deletes a role from the Report Engine.