Description

The new Admin API v2 will be split into several individual APIs. This issue covers the Client API which will be the first part of Admin API v2 to be implemented.

The new API will be adopted by any first party clients: Operator CR, Java client, CLI, Javascript client, Admin Console, ...

As part of the efforts, a blueprint will be created that will serve as a guideline for creating any following Admin APIs to ensure consistency across the APIs. The blueprint will be updated as the Client API (and its clients) gets implemented.

Value Proposition

A new interface that will allow managing Clients in a consistent, user friendly and well-documented way, and supports declarative configuration.

Additional value will be a blueprint created alongside the Client API and will be used when designing any future Admin APIs.

Goals

• New REST API for managing Clients.
• First party clients that consume this API. This includes Java and Javascript clients, Operator Client CR, Terraform Provider.
• Blueprint capturing the generics of the design.

Non-Goals

• The new REST API to implement all functionality the original one had.

Discussion

https://github.com/keycloak/keycloak/discussions/categories/api-guidelines

Notes

No response