Skip to main content

View Consumer details

The Consumers screen lists the Consumers of the API Gateway selected in the top-right corner.

Step 1Open the Consumer screen and select the API Gateway in the top-right corner. The ⋮ menu on each row has Update and Delete
1 / 4
Step 1: Open the Consumer screen and select the API Gateway in the top-right corner. The ⋮ menu on each row has Update and Delete

Click the image to zoom in.

View the Consumer list​

  1. In the left menu, select API Gateway → Consumer, then select the API Gateway in the top-right corner.

Consumers screen with the Consumer list

The list has the following columns:

ColumnDescription
NameConsumer name. Click the name to open the detail screen.
IDConsumer identifier.
DescriptionConsumer description.
LabelsLabels in key:value format.
Updated AtWhen the Consumer was last updated.
Created ByWho created the Consumer.
Created AtWhen the Consumer was created.
⋮Actions on each row, see the action table below.

The toolbar has the Search box to find Consumers by keyword, the Create Consumer button to create a Consumer, and the Column button to choose, hide, and order the columns. The Refresh button in the top-right corner reloads the list.

At the bottom of the table, Rows per page sets the number of rows per page, default 10. When the API Gateway has no Consumers yet, the screen shows an illustration with the Create Consumer button.

The ⋮ menu at the end of each row has 2 actions:

ActionDescription
UpdateOpens the Consumer update form. See Edit a Consumer.
DeleteDeletes the Consumer. See Delete a Consumer.

Consumer action menu with the Update and Delete actions

View the details of a Consumer​

  1. Click the Name of the Consumer you want to view. The detail screen has 2 tabs: Consumer Detail (default) and Credentials.

Consumer Detail tab​

Consumer information, read-only, in 2 sections:

SectionContent
GeneralSystem information: Created At, Updated At, Created By, Updated By.
Basic InformationUsername (the Consumer name), Description, and Labels entered at creation.

Consumer Detail tab, General section

Credentials tab​

Where you manage the Credentials of the Consumer. This tab currently supports the JWT type, and the number on the JWT label is the number of credentials. Click Add JWT Credential to add one, see Manage JWT credentials.

Credentials tab with no credentials yet

Next steps​

Last updated on