Breaking Changes
This page collects the changes that can break an existing deployment or integration when upgrading Trivore ID: a removed or changed Management API field or operation, webhook or Kafka payload, OIDC claim or configuration property, a changed default, or a required manual step.
Changes are grouped by the version that introduced them, newest first. If you are upgrading across several versions, review every section between your current version and your target version.
Also review the Important Upgrade Notes for other version-specific upgrade instructions.
6.5.0
ONEP-4496: Login page components changed
Login page components were modified: language buttons and a secondary cancel button were added. These are hidden by default.
Action required: if you do not use the default CSS, consider adding the following to your custom CSS:
.language-buttons .language-button.selected {
background: var(--lumo-primary-color);
color: var(--lumo-primary-contrast-color);
}
.login-extra-panel {
display: none;
visibility: collapse;
}
No action is needed when the default CSS is used.
ONEP-4638: Creating a group with an existing but inaccessible nsCode returns 201 and leaves an orphan
A Management API client with the ORGANISATION_VIEW_ALL permission can now use only the namespaces selected for it. Before, it could create objects (groups, invites, targets, authorisations, custom roles and others) in any namespace, but could not read, modify or delete them afterwards. Such requests now return 403 with the error code namespace-not-accessible. Users, including administrators in the admin UI, are not affected.
Action required: if an integration creates objects in namespaces outside its API client's namespace list, add those namespaces to the client before upgrading.
No action is needed for API clients that only use their own namespaces.
ONEP-4665: Invitation listing silently accepts sortBy and sortOrder but ignores them
The invitation listing (GET /invite/user) now supports sortBy and sortOrder. A sortBy value other than id, email, dateSent, dateAccepted or revoked now returns 400; before, sortBy was ignored.
Action required: if an integration sends sortBy to the invitation listing, use one of the supported fields.
No action is needed for integrations that do not send sortBy.
ONEP-4713: Separate permission for accessing branding system settings
From version 6.5.0 the branding settings (System settings, Branding) have their own permissions, SYSPREF_BRANDING_VIEW and SYSPREF_BRANDING_MANAGE. Before, the section was opened with SYSPREF_ALLOTHER_VIEW and edited with SYSPREF_ALLOTHER_MANAGE, and those no longer grant access to it. The built-in roles are updated automatically: an administrator keeps full access and an auditor keeps read access. Custom roles are not migrated, so a custom role that reached the branding settings through SYSPREF_ALLOTHER_* loses that access on upgrade. This also affects the custom style settings of OpenID clients, which are edited in the same section.
Action required: add SYSPREF_BRANDING_VIEW to every custom role that needs to see the branding settings, and SYSPREF_BRANDING_MANAGE to those that need to edit them. There is no automatic migration.
No action is needed when branding access comes from the built-in administrator or auditor role.
ONEP-4729: IAM password event: deprecated fields removed
From version 6.5.0, the password event on Kafka topic trivore-iam-password-events no longer contains the top-level fields user, prompterId and encryptedPassword. The event now has only:
type:PASSWORD_CHANGEpasswordChangeToken: an RS256-signed JWT
The removed values are available as claims of passwordChangeToken, with the same names and content: user, prompterId (absent when the change has no known actor) and encryptedPassword.
Action required: any consumer of the topic that still reads the top-level fields must be changed to read them from the token before upgrading to 6.5.0. After the upgrade those fields are missing from the event, with no fallback. Consumers should validate the token before using its claims: the signature (Trivore ID's OIDC signing key), the issuer (the primary base URL), the audience (trivore-iam-password-events) and the expiry (set by iam.password.change.token.validity, 60 minutes by default).
No action is needed if the consumer already reads only passwordChangeToken, or if the IAM password events are not in use.