feat: add REST APIs for company info #34671 by hassandotcms · Pull Request #34672 · dotCMS/core

hassandotcms · 2026-02-17T14:25:10Z

Proposed Changes

Introduce new /api/v1/company resource with 5 endpoints to replace legacy form-encoded APIs in CMSConfigResource:

GET /api/v1/company — read full company config for admin UI
PUT /api/v1/company/basic-info — save branding, portal URL, email
PUT /api/v1/company/locale-info — save language and timezone
PUT /api/v1/company/auth-type — save authentication type
POST /api/v1/company/_regenerateKey — regenerate security key

Uses semantic field names instead of obfuscated Liferay model fields
(e.g. primaryColor instead of type, secondaryColor instead of street).

Moves _saveCompanyLocaleInfo from ConfigurationResource to the new
CompanyResource for consistent API grouping.

Checklist

Tests
Translations
Security Implications Contemplated (add notes if applicable)

Additional Info

** any additional useful context or info **

Screenshots

Original	Updated
original screenshot	updated screenshot

This PR fixes: #34671

Add POST /api/v1/configuration/_saveCompanyLocaleInfo endpoint to ConfigurationResource as a modern replacement for the legacy POST /api/config/saveCompanyLocaleInfo. Uses JSON input, proper InitBuilder auth, Swagger annotations, and delegates to CompanyManagerUtil.updateUsers for timezone validation, default user locale persistence, and JVM timezone update.

…ure-basic-config-apis

Introduce new /api/v1/company resource with 5 endpoints to replace legacy form-encoded APIs in CMSConfigResource: - GET /api/v1/company — read full company config for admin UI - PUT /api/v1/company/basic-info — save branding, portal URL, email - PUT /api/v1/company/locale-info — save language and timezone - PUT /api/v1/company/auth-type — save authentication type - POST /api/v1/company/_regenerateKey — regenerate security key Uses semantic field names instead of obfuscated Liferay model fields (e.g. primaryColor instead of type, secondaryColor instead of street). Moves _saveCompanyLocaleInfo from ConfigurationResource to the new CompanyResource for consistent API grouping.

…ure-basic-config-apis

…34671 Add 'Company Configuration' tag to DotRestApplication's OpenAPIDefinition to fix RestEndpointAnnotationValidationTest failure. Replace raw RuntimeException with DotRuntimeException in CompanyConfigHelper for proper error handling by the global exception mapper.

Add CompanyResourceIntegrationTest with 19 tests covering all 5 endpoints: GET config, PUT basic-info, PUT auth-type, PUT locale-info, POST regenerateKey. Tests verify persistence, field mapping, input validation, and admin-only access. Also add missing /dA prefix validation for backgroundImage in CompanyBasicInfoForm for consistency with loginScreenLogo and navBarLogo.

…sicInfoForm The read side (toView) already filters non-/dA logos, and the API should remain flexible for REST consumers. OpenAPI docs clearly state the expected format without enforcing it on write. #34671

- Change 5 tests to expect ValidationException (from @NotNull via Validated.checkValid) instead of BadRequestException - Remove 2 logo path validation tests (validation was removed) #34671

…ure-basic-config-apis

fabrizzio-dotCMS · 2026-03-04T22:17:14Z

dotCMS/src/main/java/com/dotcms/rest/api/v1/company/AbstractCompanyConfigView.java

+            requiredMode = Schema.RequiredMode.REQUIRED
+    )
+    String authType();
+


best suited as an enum

fabrizzio-dotCMS · 2026-03-04T22:18:57Z

dotCMS/src/main/java/com/dotcms/rest/api/v1/company/CompanyConfigHelper.java

+
+        // NavLogo feature is Enterprise only
+        String navBarLogo = form.getNavBarLogo();
+        if (LicenseUtil.getLevel() == LicenseLevel.COMMUNITY.level


I don't think that licensing matters anymore. But please double check.

yeah, you are right. but code still has these license checks across the codebase.
i will see if i can remove it.

fabrizzio-dotCMS · 2026-03-04T22:19:57Z

dotCMS/src/main/java/com/dotcms/rest/api/v1/company/CompanyConfigHelper.java

+     */
+    private CompanyConfigView toView(final Company company) {
+
+        final String loginLogo = company.getCity();


loginLogo == City?

Yes, the Liferay Company model repurposes address fields.
city = loginScreenLogo,
state = navBarLogo.

Same mapping used in CMSConfigResource:91,141 and ConfigurationHelper:115.
I will add a clarifying comment in code

fabrizzio-dotCMS · 2026-03-04T22:22:16Z

dotCMS/src/main/java/com/dotcms/rest/api/v1/company/CompanyConfigHelper.java

+     */
+    private String extractDomain(final String email) {
+
+        if (UtilMethods.isSet(email) && email.contains("@")) {


This assumes a valid email. Add a try catch or org.apache.commons.validator.routines.EmailValidator;
to validate that the e-mail is valid

fabrizzio-dotCMS · 2026-03-04T22:51:26Z

dotCMS/src/main/java/com/dotcms/rest/api/v1/company/CompanyResource.java

+ */
+@Path("/v1/company")
+@SwaggerCompliant(value = "Company configuration and system settings APIs", batch = 3)
+@Tag(name = "Company Configuration", description = "Company settings and branding management")


We already have a /v1/configuration
Perhaps this should be part of that resource

I mean, our customers don't know anything about a company.
Even though we know there's a table company, etc. I don't think the customer needs to know that the locale is assigned via the company or that the authentication type is bound to the company.
I fear this is not the proper name for this resource

yeah make sense, "company" leaks an internal detail.
I will move these under /v1/configuration/ as sub-paths (/basic-info, /auth-type, /locale-info, /_regenerateKey)

@fmontes any comment on this?

- Create AuthType enum to replace string-based auth type validation - Add try-catch in extractDomain for defensive email handling - Add field mapping comment in toView() explaining Liferay Company address field repurposing for branding Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

…ure-basic-config-apis

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

github-project-automation bot added this to dotCMS - Product Planning Feb 17, 2026

hassandotcms linked an issue Feb 17, 2026 that may be closed by this pull request

[FEATURE] Basic Config APIs #34671

Open

github-actions bot mentioned this pull request Feb 17, 2026

[FEATURE] Basic Config APIs #34671

Open

github-actions bot added Area : Backend PR changes Java/Maven backend code Area : CI/CD PR changes GitHub Actions/workflows labels Feb 17, 2026

spbolton removed the Area : CI/CD PR changes GitHub Actions/workflows label Feb 17, 2026

Merge branch 'main' of https://github.com/dotCMS/core into 34671-feat…

01c6f7e

…ure-basic-config-apis

hassandotcms changed the title ~~feat: add REST API for company locale info~~ feat: add REST APIs for company info #34671 Feb 26, 2026

hassandotcms added 8 commits February 26, 2026 19:15

add openapi docs file. #34671

2401990

Merge branch 'main' of https://github.com/dotCMS/core into 34671-feat…

c35b06d

…ure-basic-config-apis

refactor: remove /dA prefix validation from image fields in CompanyBa…

6201e6d

…sicInfoForm The read side (toView) already filters non-/dA logos, and the API should remain flexible for REST consumers. OpenAPI docs clearly state the expected format without enforcing it on write. #34671

fix: update test expectations after removing /dA validation

a4860bb

- Change 5 tests to expect ValidationException (from @NotNull via Validated.checkValid) instead of BadRequestException - Remove 2 logo path validation tests (validation was removed) #34671

Merge branch 'main' of https://github.com/dotCMS/core into 34671-feat…

6b24c29

…ure-basic-config-apis

hassandotcms marked this pull request as ready for review March 3, 2026 14:54

hassandotcms requested review from fabrizzio-dotCMS, jcastro-dotcms and nollymar March 3, 2026 14:54

fabrizzio-dotCMS requested changes Mar 4, 2026

View reviewed changes

hassandotcms and others added 3 commits March 5, 2026 20:47

Merge branch 'main' of https://github.com/dotCMS/core into 34671-feat…

65510be

…ure-basic-config-apis

chore: update openapi.yaml after merge with main

c10ddf5

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add REST APIs for company info #34671#34672

feat: add REST APIs for company info #34671#34672
hassandotcms wants to merge 13 commits intomainfrom
34671-feature-basic-config-apis

hassandotcms commented Feb 17, 2026 •

edited

Loading

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

hassandotcms Mar 5, 2026

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

hassandotcms Mar 5, 2026

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

hassandotcms Mar 5, 2026

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

fabrizzio-dotCMS Mar 4, 2026

Uh oh!

hassandotcms Mar 5, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

hassandotcms commented Feb 17, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed Changes

Checklist

Additional Info

Screenshots

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

hassandotcms commented Feb 17, 2026 •

edited

Loading