Skip to content

Implement key manager config UI #2493

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lasanthaS merged 3 commits into from
Jul 13, 2026
Merged

Implement key manager config UI #2493

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
25b1d93
Implement key manager config UI
Piumal1999 Jul 7, 2026
fb716e1
Update key manager types
Piumal1999 Jul 11, 2026
b235d9d
Improve key manager creation validation
Piumal1999 Jul 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 6 additions & 16 deletions docs/rest-apis/devportal/key-managers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@ Creates a key manager configuration for the organization. If `id` is omitted, th
{
"displayName": "Asgardeo",
"id": "asgardeo-prod",
"type": "ASGARDEO",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token"
}
Expand All @@ -36,7 +35,6 @@ Creates a key manager configuration for the organization. If `id` is omitted, th
```yaml
displayName: Asgardeo
id: asgardeo-prod
type: ASGARDEO
enabled: true
tokenEndpoint: https://api.asgardeo.io/t/myorg/oauth2/token

Expand Down Expand Up @@ -64,7 +62,7 @@ This operation requires <strong>Basic Auth</strong> authentication.
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"orgId": "org-12345",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token",
"createdBy": "alice@example.com",
Expand Down Expand Up @@ -194,7 +192,7 @@ This operation requires <strong>Basic Auth</strong> authentication.
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"orgId": "org-12345",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token",
"createdBy": "alice@example.com",
Expand Down Expand Up @@ -243,7 +241,7 @@ Status Code **200**
|»»» id|string|false|none|The key manager's handle (unique per org). Not the internal database uuid.|
|»»» displayName|string|false|none|none|
|»»» orgId|string|false|none|none|
|»»» type|string|false|none|none|
|»»» type|string|false|read-only|Fixed at `GENERIC_OIDC` for every key manager. Not client-configurable.|
|»»» enabled|boolean|false|none|none|
|»»» tokenEndpoint|string(uri)|false|none|none|
|»»» createdBy|string|false|none|Identity of the user who created this key manager, or `deleted_user` if that user's IDP reference no longer exists. Present on single-resource GET responses and list items.|
Expand All @@ -258,7 +256,7 @@ Status Code **200**
|»» *anonymous*|[KeyManagerPublicResponseSchema](schemas.md#schemakeymanagerpublicresponseschema)|false|none|Minimal developer-facing key manager view.|
|»»» id|string|false|none|The key manager's handle (unique per org). Not the internal database uuid.|
|»»» displayName|string|false|none|none|
|»»» type|string|false|none|none|
|»»» type|string|false|read-only|Fixed at `GENERIC_OIDC` for every key manager.|
|»»» tokenEndpoint|string(uri)|false|none|none|

*continued*
Expand All @@ -274,13 +272,7 @@ Status Code **200**

|Property|Value|
|---|---|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|

## Get a key manager
Expand Down Expand Up @@ -324,7 +316,7 @@ This operation requires <strong>Basic Auth</strong> authentication.
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"orgId": "org-12345",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token",
"createdBy": "alice@example.com",
Expand Down Expand Up @@ -389,7 +381,6 @@ Updates an existing key manager configuration. Accepts either a `application/jso
{
"displayName": "Asgardeo",
"id": "asgardeo-prod",
"type": "ASGARDEO",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token"
}
Expand All @@ -398,7 +389,6 @@ Updates an existing key manager configuration. Accepts either a `application/jso
```yaml
displayName: Asgardeo
id: asgardeo-prod
type: ASGARDEO
enabled: true
tokenEndpoint: https://api.asgardeo.io/t/myorg/oauth2/token

Expand Down Expand Up @@ -427,7 +417,7 @@ This operation requires <strong>Basic Auth</strong> authentication.
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"orgId": "org-12345",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token",
"createdBy": "alice@example.com",
Expand Down
36 changes: 4 additions & 32 deletions docs/rest-apis/devportal/schemas.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1394,7 +1394,6 @@ API key response returned by generate/regenerate only. Unlike ApiKeyMetadataResp
{
"displayName": "Asgardeo",
"id": "asgardeo-prod",
"type": "ASGARDEO",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token"
}
Expand All @@ -1407,19 +1406,9 @@ API key response returned by generate/regenerate only. Unlike ApiKeyMetadataResp
|---|---|---|---|---|
|displayName|string|true|none|none|
|id|string|false|none|Desired handle for the key manager (unique per org), stored as-is. Optional — defaults to the key manager's `displayName` when omitted.|
|type|string|true|none|none|
|enabled|boolean|false|none|none|
|tokenEndpoint|string(uri)|true|none|OAuth2 token endpoint. The OAuth application itself must be created directly in this key manager; the portal only proxies `client_appKeyMappings` token requests to this endpoint.|

#### Enumerated Values

|Property|Value|
|---|---|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|

<h2 id="tocS_KeyManagerUpdateRequest">KeyManagerUpdateRequest</h2>

<a id="schemakeymanagerupdaterequest"></a>
Expand All @@ -1431,7 +1420,6 @@ API key response returned by generate/regenerate only. Unlike ApiKeyMetadataResp
{
"displayName": "Asgardeo",
"id": "asgardeo-prod",
"type": "ASGARDEO",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token"
}
Expand All @@ -1446,19 +1434,9 @@ Partial update payload for a key manager. All fields are optional; only supplied
|---|---|---|---|---|
|displayName|string|false|none|none|
|id|string|false|none|Desired handle for the key manager (unique per org), stored as-is.|
|type|string|false|none|none|
|enabled|boolean|false|none|none|
|tokenEndpoint|string(uri)|false|none|none|

#### Enumerated Values

|Property|Value|
|---|---|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|

<h2 id="tocS_KeyManagerResponseSchema">KeyManagerResponseSchema</h2>

<a id="schemakeymanagerresponseschema"></a>
Expand All @@ -1471,7 +1449,7 @@ Partial update payload for a key manager. All fields are optional; only supplied
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"orgId": "org-12345",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"enabled": true,
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token",
"createdBy": "alice@example.com",
Expand All @@ -1491,7 +1469,7 @@ Key manager configuration.
|id|string|false|none|The key manager's handle (unique per org). Not the internal database uuid.|
|displayName|string|false|none|none|
|orgId|string|false|none|none|
|type|string|false|none|none|
|type|string|false|read-only|Fixed at `GENERIC_OIDC` for every key manager. Not client-configurable.|
|enabled|boolean|false|none|none|
|tokenEndpoint|string(uri)|false|none|none|
|createdBy|string|false|none|Identity of the user who created this key manager, or `deleted_user` if that user's IDP reference no longer exists. Present on single-resource GET responses and list items.|
Expand All @@ -1503,9 +1481,6 @@ Key manager configuration.

|Property|Value|
|---|---|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|

<h2 id="tocS_KeyManagerPublicResponseSchema">KeyManagerPublicResponseSchema</h2>
Expand All @@ -1519,7 +1494,7 @@ Key manager configuration.
{
"id": "asgardeo-prod",
"displayName": "Asgardeo",
"type": "ASGARDEO",
"type": "GENERIC_OIDC",
"tokenEndpoint": "https://api.asgardeo.io/t/myorg/oauth2/token"
}

Expand All @@ -1533,16 +1508,13 @@ Minimal developer-facing key manager view.
|---|---|---|---|---|
|id|string|false|none|The key manager's handle (unique per org). Not the internal database uuid.|
|displayName|string|false|none|none|
|type|string|false|none|none|
|type|string|false|read-only|Fixed at `GENERIC_OIDC` for every key manager.|
|tokenEndpoint|string(uri)|false|none|none|

#### Enumerated Values

|Property|Value|
|---|---|
|type|ASGARDEO|
|type|WSO2IS|
|type|KEYCLOAK|
|type|GENERIC_OIDC|

<h2 id="tocS_WebhookSubscriberRequest">WebhookSubscriberRequest</h2>
Expand Down
10 changes: 6 additions & 4 deletions portals/developer-portal/docs/administer/key-manager-integration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@ apiVersion: devportal.api-platform.wso2.com/v1alpha1
kind: KeyManager

metadata:
name: Asgardeo
name: asgardeo-prod

spec:
type: ASGARDEO
displayName: Asgardeo
enabled: true
tokenEndpoint: https://api.asgardeo.io/t/myorg/oauth2/token
```
Expand All @@ -38,11 +38,13 @@ curl -k -X POST https://localhost:3000/api/v0.9/key-managers \

| Field | Required | Description |
|---|---|---|
| `metadata.name` | Yes | Unique display name shown to developers |
| `spec.type` | Yes | Key manager type: `ASGARDEO`, `WSO2IS`, `KEYCLOAK`, or `GENERIC_OIDC` |
| `metadata.name` | Yes | Unique handle for the key manager (used internally, e.g. in route segments) |
| `spec.displayName` | Yes | Display name shown to developers |
| `spec.tokenEndpoint` | Yes | OAuth2 token endpoint. The portal proxies `client_credentials` token requests here using the client ID/secret the developer supplies |
| `spec.enabled` | No | Whether the key manager is active. Defaults to `true` |

Every key manager is treated as a generic OAuth2 `client_credentials` provider — there is no `type` to configure.

## List Key Managers

```bash
Expand Down
34 changes: 7 additions & 27 deletions portals/developer-portal/docs/devportal-openapi-spec-v0.9.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2986,7 +2986,6 @@ components:
example:
displayName: Asgardeo
id: asgardeo-prod
type: ASGARDEO
enabled: true
tokenEndpoint: https://api.asgardeo.io/t/myorg/oauth2/token
multipart/form-data:
Expand Down Expand Up @@ -3874,7 +3873,7 @@ components:
- id: asgardeo-prod
displayName: Asgardeo
orgId: org-12345
type: ASGARDEO
type: GENERIC_OIDC
enabled: true
tokenEndpoint: https://api.asgardeo.io/t/myorg/oauth2/token
createdBy: alice@example.com
Expand Down Expand Up @@ -5031,7 +5030,6 @@ components:
type: object
required:
- displayName
- type
- tokenEndpoint
properties:
displayName:
Expand All @@ -5043,14 +5041,6 @@ components:
Desired handle for the key manager (unique per org), stored as-is. Optional — defaults to the key
manager's `displayName` when omitted.
example: asgardeo-prod
type:
type: string
enum:
- ASGARDEO
- WSO2IS
- KEYCLOAK
- GENERIC_OIDC
example: ASGARDEO
enabled:
type: boolean
default: true
Expand All @@ -5076,14 +5066,6 @@ components:
type: string
description: Desired handle for the key manager (unique per org), stored as-is.
example: asgardeo-prod
type:
type: string
enum:
- ASGARDEO
- WSO2IS
- KEYCLOAK
- GENERIC_OIDC
example: ASGARDEO
enabled:
type: boolean
default: true
Expand All @@ -5109,12 +5091,11 @@ components:
example: org-12345
type:
type: string
description: Fixed at `GENERIC_OIDC` for every key manager. Not client-configurable.
enum:
- ASGARDEO
- WSO2IS
- KEYCLOAK
- GENERIC_OIDC
example: ASGARDEO
readOnly: true
example: GENERIC_OIDC
enabled:
type: boolean
example: true
Expand Down Expand Up @@ -5154,12 +5135,11 @@ components:
example: Asgardeo
type:
type: string
description: Fixed at `GENERIC_OIDC` for every key manager.
enum:
- ASGARDEO
- WSO2IS
- KEYCLOAK
- GENERIC_OIDC
example: ASGARDEO
readOnly: true
example: GENERIC_OIDC
tokenEndpoint:
type: string
format: uri
Expand Down
Loading
Loading