Consumer

Create Consumer

When an API requires authentication, a consumer role needs to be created for the caller and assigned the corresponding credentials for authentication. The consumer can be associated with a user, an application, a host, or other entities.

• A consumer needs to enable at least one authentication plugin.
• The same consumer object can access multiple APIs.
• If the same plugin (non-authentication plugin) is configured in both the consumer and the route/API, the plugin configuration in the consumer takes precedence.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on Consumer .
8. Click on Create button.
9. Fill in the form and choose an authentication plugin (basic-auth/hmac-auth/jwt-auth/key-auth/wolf-rbac), click on Enable button of the specific plugin.
10. In the Plugin Editor , turn on Enable switch.
11. In the Raw Data Editor , edit the plugin parameters. (optional, some plugins can work without parameters)
12. Click on Submit button.
13. Enable multiple plugins if necessary.
14. Click on Submit button.

Configure Consumer

You can edit consumer's properties and plugins using this feature.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on Consumer .
8. Click on Configure button of the specific consumer.
9. Choose the plugins you need to enable and click on the corresponding Enable button.
10. In the Plugin Configure form, turn on the Enable switch.
11. In the Configure Raw data section, edit the parameters of the plugin (optional, some plugins do not need to be configured).
12. Click on Submit button.
13. To enable multiple plugins as needed, repeat steps 9 to 12.
14. To disable a plugin that has already been enabled, Click on Update button for the corresponding plugin, then Click on Delete button in the Plugin Configure form. Alternatively, you can directly Click on Disable button for the corresponding plugin.
15. After configuring all plugins, Click on Submit button.

Delete Consumer

When a consumer should no longer be able to call any API with authentication and its records should no longer be kept.

• Deletion is permanent and cannot be undone. Please proceed with caution.

1. Log in to the API7 Enterprise dashboard.
2. In the top navigation menu, click on Cluster Management .
3. In the left menu bar, click on Cluster List .
4. Click on View button of the specific cluster.
5. In the left menu bar, click on Workspaces .
6. Click on View button of the specific workspace.
7. In the left menu bar, click on Consumer .
8. Click on Delete button of the specific consumer.
9. Confirm and Click on OK button.