Skip to content

CLA for entities - #2968

Merged
simonredfern merged 11 commits into
OpenBankProject:developfrom
simonredfern:develop
Nov 15, 2026
Merged

simonredfern merged 11 commits into
OpenBankProject:developfrom
simonredfern:develop

Conversation

@simonredfern

Copy link
Copy Markdown
Member

No description provided.

Get User by PROVIDER and USERNAME, Get User by USER_ID and Get Users are
now UserXORApplication: an application acting as itself with the Scope
CanGetAnyUser can look users up (e.g. an identity provider), as well as
a person with the Entitlement. A person calling through the Consumer
does not get its Scope.
Their handlers no longer insist on a logged-in User; the access check
decides. Anonymous calls now get 401 OBP-20200, as on other
UserXORApplication endpoints.

Tests: UserLookupApplicationAccessTest; anonymous expectations updated
in GetUsersTest, GetUserByUserIdTest and v5.1.0 UserTest.
its values UserOnly, ApplicationOnly, UserXORApplication and
UserAndApplication. Who is acting on a request now decides where a Role
comes from, the same way on every endpoint. A person needs the Role as
an Entitlement. An application acting as itself needs it as a Scope on
its Consumer.
An application acts as itself only if its Consumer is a Platform App,
and it calls with no user or as its own client-credentials user.
Keycloak service-account tokens now get such a user too, with provider
keycloak#client, named after the client id. Without the Platform App
mark, a Consumer's Scopes only work as a limit on people. Operators must
mark the applications that act as themselves, such as the Portal, API
Manager, Cohort, Sentinel and Bank-Node.
handleAccessControlRegardingEntitlementsAndScopes is now the only access
check. The middleware, inline Role checks in handlers, Dynamic Entities,
Files and the gRPC streams all use it. Consumer Account Access now works
on every endpoint of the granted view.
Who may call an endpoint is read from its error list only. "User not
logged in" or a Role means a user is required. "The application cannot
be identified" without it means an identified application is enough, and
a user is optional. The 22 Berlin Group and UK Open Banking consent and
payment endpoints now say this. An anonymous call to an endpoint with a
Role gets OBP-20001 again, not OBP-20200.
Dynamic Entities: auth_mode is removed from the v6.0.0 and v7.0.0
definitions and is no longer stored. A client that still sends it is not
refused, because the field is ignored. The old column stays in existing
databases, unused. An entity's data endpoints work like static endpoints
with a Role.
v7.0.0 Get My Role returns allowed, true or false, in place of
allowed_for_auth_modes.
Consumer grant types now only control how tokens can be obtained through
a Consumer. They no longer decide whether a call is the application
acting as itself. The glossary item Consumer Grant Types is rewritten in
plain English, and says what it means to log in through a Consumer.
Glossary: API.Entitlements and Scopes replaces API.Endpoint Auth Modes.
A new item, OAuth Standards and OBP, lists the OAuth standards OBP works
with. The introductory documentation, sample.props.template and the
release notes are updated to match.
The note todo/todo_remove_endpoint_auth_mode.md records the decisions
behind this change.
Tests: EndpointAccessRuleTest replaces EndpointAuthModeTest. The new
UserOptionalHandlerTest fails if a handler whose doc needs only an
identified application insists on a user. DynamicEntityAuthModeTest
checks that auth_mode is ignored. Tests of anonymous calls expect
OBP-20001. The test applications are marked as Platform Apps. The
failure sweep now covers the former UserXORApplication endpoints, and
accepts the 503 of Send Email to Customer when no From address is set.
The join that v_account_access_with_views did now lives in
DoobieAccountAccessViewQueries. (so migrations don't need to drop the
SQL view)
+ Fix Only return balances (and label and routings) if account access
  view has those permissions. Indeed only go to connector for accounts
  that make sense + Tests for that
document held exactly one $ref, because the code assumed json4s always
returns an object of matches. Collect the references by walking the
fields instead, and add a test for a single function.
the URL to the query. Anyone who knew a user's or a consumer's id could
see which endpoints they called. Now only from_date and to_date are
used, and the limit is always 50. Get Metrics and Get Top APIs, which
need a Role, still accept the other filters.

Add PopularApisTest and a parity allowlist entry for the new
description.
fx.convert rounded every result to 2 decimal places, so converting into
OMR, KWD or BHD lost the third decimal. It now takes the currency being
converted into and rounds to its decimal places: 3 for OMR, 2 for EUR, 0
for JPY. Every caller passes that currency.
+
Add Tenant, Data Retention and IP Penalties to the Glossary

Explain the system space SYS, link to the v7.0.0 Create Dynamic Entity
Definition, and name the log cache Roles one per level.
GlossaryLinksTest now uses the test server, because building the
Glossary reads WebUiProps from the database.

Update the introductory system documentation to version 0.7.0: fix the
section numbers, and add OBP-Sentinel, OBP Bank Node, utility payments,
payment promises and amount precision.
with access to SYSTEM_READ_BALANCES_BERLIN_GROUP_VIEW_ID
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Failed Quality Gate failed

Failed conditions
C Reliability Rating on New Code (required ≥ A)

See analysis details on SonarQube Cloud

Catch issues before they fail your Quality Gate with our IDE extension SonarQube for IDE

@simonredfern
simonredfern merged commit 2325cc5 into OpenBankProject:develop Nov 15, 2026
12 of 13 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant