Consumer
Consumer
A Consumer is an application that calls OBP: a web, mobile or server application. Every call to OBP is made through a Consumer, whether a person is logged in or not. The Consumer records which application made the call.
This item gives an overview. Each part has its own Glossary item with the details.
Identifying the application
- Consumer ID. A UUID that OBP gives the Consumer. It appears in logs, metrics and messages to the backend. Use it whenever you refer to a Consumer.
- Key and secret. The application uses these to get tokens. The key is also called the client id. See here.
- Certificate. A Consumer can be tied to an mTLS certificate. It must then present that certificate on every call. A Consumer has one certificate at a time. When a certificate expires, an administrator replaces it with Update Consumer Certificate, and the Consumer keeps its Scopes, rate limits and other settings.
- Redirect URL. Where people are sent back to after they log in through the Consumer. See here.
How tokens can be obtained
A Consumer's grant types say how tokens can be obtained through it. People may log in through it by OAuth2 or by DirectLogin, the application may get a token for itself, or both. A Consumer with no grant types set can be used in every way. See here.
What the application may do
A Role can be granted to a Consumer as a Scope. Who is acting on a call decides whether the Scope counts:
- When a person calls through the Consumer, their own Entitlements count. The Consumer's Scopes do not give them anything. An installation can also require the Consumer to hold the Scope, as a limit on people.
- When the application acts as itself, with no person logged in, its Consumer's Scopes count. It can do this only if its Consumer is marked as a Platform App.
Which accounts the application may use
A Scope lets an application call an endpoint. A Platform App that acts on an account as itself also needs access to a view of that account. An example is initiating payments from the account. See here.
Who owns a Consumer
A Consumer is owned by the User who created it. It can be moved into an here, and then its members own it together, so it stays with the team when someone leaves. Owners need no Role to read their Consumers, their usage, Scopes and API Product Subscriptions under /my/consumers, or to subscribe them to API Products. See here.
Switching a Consumer off
An administrator can disable a Consumer. Every call through it is then refused, by people and by the application itself. It can be enabled again later.
Endpoints
- Get Consumers:
GET /obp/v7.0.0/management/consumers - Get Consumer:
GET /obp/v7.0.0/management/consumers/CONSUMER_ID - Create a Consumer:
POST /obp/v5.1.0/management/consumers - Enable or Disable Consumers:
PUT /obp/v3.1.0/management/consumers/CONSUMER_ID - Update Consumer Certificate:
PUT /obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/certificate - Update Consumer RedirectURL:
PUT /obp/v7.0.0/management/consumers/CONSUMER_ID/consumer/redirect_url - Get Current Consumer:
GET /obp/v6.0.0/consumers/current, for an application to read its own Consumer. - Get My Consumers:
GET /obp/v7.0.0/my/consumers, for owners to read their Consumers.
The endpoints for grant types, Scopes, Platform Apps and account access are listed in their own items.