Skip to content
You are viewing the latest documentation for Solo Enterprise for kgateway. To access the documentation for older versions, use the version switcher.

Manage API subscriptions

Page as Markdown
This guide must be completed by a Portal admin.
An API subscription represents a request from a team to access a particular API product in the portal web server. While subscriptions are tightly connected to an app that a team owns, the Portal admin must approve subscriptions by using the Portal frontend app for subscriptions to be actually enforced.
The following restrictions apply to subscriptions:
  • Subscriptions are requested by a team for a particular app.
  • Subscriptions can be approved, rejected, or deleted by an admin user only. To log in to the Portal frontend as an admin, the user must have the group: admin claim in their ID token.
  • After a subscription is approved, the admin user can still reject or delete them.
Before you begin

Portal admins must complete the following tasks:
  1. Set up a portal web server.
  2. Secure the login to the portal frontend.
  3. Optional: Set up a backing database for your portal. This database is used to store the subscriptions that your users create in the Portal frontend app.
Portal users must complete the following tasks:
Create a team, an app, and a subscription to your app.
Work with subscriptions

  1. In your browser, open the portal frontend app, such as http://portal.example.com:8080/ and log in as a Portal admin.
  2. In the frontend app, go to Subscriptions and find the pending subscription.
  3. Click Approve to approve a subscription, Reject to reject a subscription request, and Delete to delete the subscription. Note that you can still reject or delete a subscription after you approved it.
Next

After approving a subscription, your users can view and work with an API product. You can enable more self-service features for Portal users, such as the following:
Set up API credential management
Allow your users to create their own API keys or OAuth clients to access API products.
Set up rate limiting for APIs
Limit the number of requests that an API key or OAuth client can send to a particular API.
Secure loginSet up API credential management
Was this page helpful?