Traefik Hub Glossary
This glossary provides definitions of key terms used in Traefik Hub API Management (APIM), helping you understand the roles, concepts, and entities involved in managing APIs and applications within Traefik Hub.
Human user-related terms
| Term | Definition |
|---|---|
| API Publisher | DevOps or Platform personnel with full administrative access to the Hub UI, the GitOps repository, and the cluster hosting the API Gateway & APIM components. |
| API Manager | A business person without technical or engineering knowledge; the "owner" of APIs. |
| API Consumer (Portal User) | A partner or developer who can log in to the Portal UI. |
| Application Owner | The portal user who created and currently owns the Hub Application. |
| Hub UI Roles | - Admin: Has full Hub UI access without restrictions; can manage every setting. Usually, API Publishers are admins. - Editor: Can read and edit the Hub UI but cannot manage workspace settings. Usually, API Managers are editors. - Viewer: Has read-only access to the Hub UI. |
Machine user-related terms
| Term | Definition |
|---|---|
| Application | A virtual entity holding credentials to the API Gateway. |
| IdP Application | An application created in the Identity Provider (IdP). It is assigned to one or more groups and has Client ID and Client Secret attributes necessary to mint JWT tokens signed by the IdP. The token can grant access to APIs on the Gateway depending on the authorization rules set up in Hub. |
| Hub Application | An application created in Hub as a counterpart to the IdP Application, tied together with the Client ID. The same Client ID from the same IdP can only be added once to a Hub application in a workspace. |
| Client ID | The ID of the Application in the IdP. All Client IDs are App IDs. |
| App ID | An ID of an application, usually the Client ID. |
| API | An API functions as a software intermediary facilitating communication between two distinct applications. |
| Managed Subscription | A pre-negotiated API consumption contract that ties selected applications to APIs with an API plan. It controls which application (machine user) can consume which API by how much on the API Gateway. |