[Task]: CLI for Devportal

[ShakyaPr]

Please select the area the issue is related to

Area/DeveloperPortal (Developer Portal API, Developer Portal UI)

Please select the aspect the issue is related to

Aspect/Other (Anything else which does not match above categories)

Description

Needs to create CLI tool for Devportal users

[ShakyaPr]

Update 22/04/2026

• Created a Document to get an idea about how the CLI tool structure should be & which commands needs to be used for each operation: https://docs.google.com/document/d/15dIt-SNj6ybifQtnUKjRIqpHBOpKSsSobKf5GBtvDUw/edit?usp=sharing

[ShakyaPr]

Update 23/04/2026

• There is a limitation in implementing CLI support for the Devportal, as the current flow is designed for browser-based interactions. As a result, there is no way in the current implementation to generate access keys or API keys for accessing API resources through the Devportal.
• Several possible options were explored to enable this support:
  • The device code grant type is commonly used for CLI-based logins. However, it does not support pipeline automation scenarios.
  • Token exchange was considered as a way to generate a PAT token through the Devportal UI. Due to its complexity, and uncertainty about whether such an advanced mechanism is necessary, this option has been put on hold for now.
  • Exploration has begun on using API keys as a simpler approach that can be used with CLI tools.

[ShakyaPr]

Update 24/04/2026

• Implemented API key generation and validation flows for the Devportal. However, API key generation is currently supported only through REST APIs and is intended for internal organizational use. This creates a limitation in handling authorization, since the existing APIs rely on JWT tokens obtained through browser-based sessions. Such tokens are not suitable when a user needs to invoke the API key generation endpoint from non-browser context such as curl.
• As a result, a new proposal has been initiated to introduce file-based user management support for API key generation. More details are available here: [Proposal][Devportal] Scoped API Key Support for Devportal CLI with File-Based User Management #1770

[ShakyaPr]

Update 28/04/2026

• Created a proposal for CLI user flow: [Proposal] API Platform CLI: User Flow and API Project Model #1791

[ShakyaPr]

Discussion 29/04/2026:

• Attendees: Nuwan Dias, Krishan Wijesena, Malintha Amarasinghe, Pubudu Gunathilake, Shakya Rathnaweera, Nisan Abeywickrama, Lasantha Samarakoon, Piumal Rathnayake

• Notes:

  • CLI needs to support basic, oauth & API Key login type supports. The basic auth implementation is similar to what we have already implemented in GW.
  • Though Devportal supports basic auth, for the production deployment, Devprotal should be configured with external IDP for increased security as basic auth is not encourage in production environments. So the basic auth support should be implemented as configurable option.
  • In standalone Devportal, when a user login to devportal, user can go to settings page & generate own API key for CLI, automation or REST API usages, this needs to supported through both basic auth & oauth.
  • In cross product usages,
    • For the automations, user have to login to each portal and generate API keys for each component and provide three API keys in the automations script & since this is one time generation, there is no considerable overhead due to this.
    • But for the user interacted CLI usages, needs to come up with Device code grant type login implementation for CLI usages which handles through single confiured IDP for the platform.
  • API Key generation implementation needs to be implemented in both Devportal & Management Portal components.