Consumers

Consumers represent users, systems, or applications that are allowed to call services through the gateway. They are usually used with authentication plugins such as key authentication, basic authentication, OAuth, or JWT.

When to use Consumers

Use Consumers when you need to:

• view existing consumers;
• create a consumer for a client application;
• update consumer details;
• manage credentials linked to a consumer;
• remove a consumer that should no longer access gateway services.

Consumers list

The Consumers list shows each configured consumer. Use the search field to find a consumer by name, username, or other visible details.

Create a consumer

1. Open Gateway Configuration.
2. Select Consumers.
3. Select Create or Add.
4. Enter the required consumer details.
5. Save the consumer.

After the consumer is created, add the required credentials or plugin configuration so the consumer can authenticate.

Field guide

Field	Required	What to enter	Notes
Username or Name	Yes	A clear identifier for the consumer.	This is often used to recognise the calling application or client.
Custom ID	If shown	An external system identifier.	Use this only if your team has a known ID to store.
Tags	No	Optional labels.	Useful for grouping consumers by team, client, or environment.
Credentials	If shown	Authentication details such as keys or secrets.	Only add credentials that match the plugin used by the service.
Status or Active	If shown	Whether the consumer can be used.	Disable only when the consumer should no longer access services.

Edit a consumer

Open the consumer from the list, update the required details, and save. If a consumer is linked to credentials, take care when changing identifiers because client applications may rely on them.

Credentials and access

Credentials are usually managed through plugins. For example, if a service uses key authentication, the consumer needs a valid key. If a service uses JWT, the consumer may need JWT-related settings.

Note

Creating a consumer does not automatically give access to every service. Access depends on the plugins and route/service configuration in the gateway.