Get Platform Apps
GET /obp/v7.0.0/management/platform-apps
OBPv7.0.0-getPlatformApps Roles: CanGetPlatformApps ConsumerScope
The Platform Apps of this installation. For each: its Consumer, the Scopes it has declared it needs
and whether its Consumer holds each (held), and a state: ok when every required Scope is held,
missing when some are not (Scopes marked optional do not count), and not_declared when the app
has not yet said what it needs.
A Platform App is a Consumer an installation runs as part of its own deployment, for example the Portal or the API Manager, which calls OBP with its own application token. An administrator marks the Consumer as a Platform App; the app then declares, as itself, the Scopes it needs and what they are needed for, and the administrator can see which of them its Consumer holds.
For more information see here
User Authentication is Required. The User must be logged in. The Application must also be authenticated.
JSON response body fields (15)
- bank_id
- gh.29.uk
- consumer_id
- 7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh
- consumer_name
- consumer_name
- held
- held
- label
- My Account
- marked_at
- marked_at
- marked_by_user_id
- marked_by_user_id
- needed_for
- needed_for
- optional
- optional
- platform_apps
- platform_apps
- required_scopes
- required_scopes
- role_name
- state
- declared_at
- declared_at
- version
Example success response
{
"platform_apps": [
{
"consumer_id": "7uy8a7e4-6d02-40e3-a129-0b2bf89de8uh",
"consumer_name": "obp-portal-client",
"label": "Portal",
"marked_by_user_id": "9ca9a7e4-6d02-40e3-a129-0b2bf89de9b1",
"marked_at": "2026-10-21T01:45:41Z",
"declared_at": "2026-10-21T01:45:41Z",
"version": "1.1.0",
"state": "missing",
"required_scopes": [
{
"role_name": "CanGetDynamicEntityRecord_obp_portal_page",
"bank_id": "SYS",
"needed_for": "Showing the pages published with App Studio at /pages, to every visitor.",
"optional": false,
"held": false
}
]
}
]
}Possible errors (3)
- OBP-20001: User not logged in. Authentication is required!
- OBP-20006: User is missing one or more roles:
- OBP-50000: Unknown Error.