keycloak / keycloak/keycloak-nodejs-connect

Missing KeycloakConfig Parameter public-client

Open Beginner friendly
#411 0 comments 0 reactions 0 assignees View on GitHub
kind/bug status/triage
Dominant language
JavaScript
Stars
740
Forks
442
PR merge metrics
No merged PRs in 30d

Description

### Describe the bug

The `KeycloakConfig` typedef is defined here:

https://github.com/keycloak/keycloak-nodejs-connect/blob/cc4bb724fd3fd3fc153283d54f5868303b33418c/keycloak.d.ts#L20

However in Keycloak 18, the config JSON is being generated as such:
![image](https://user-images.githubusercontent.com/1319049/184504985-56136d82-3eee-46b2-bf76-c8420718f0b0.png)

Providing the `public-client` parameter to the `KeycloakConfig` object causes an error. Suggest updating the typedef to:
```typescript
interface KeycloakConfig {
'confidential-port': string|number
'auth-server-url': string
'resource': string
'ssl-required': string
'bearer-only'?: boolean
realm: string
'public-client': boolean;
}
```

### Version

18.0.2

### Expected behavior

Expectation is that KeycloakConfig contains all attributes that can be generated by the Keycloak server

### Actual behavior

KeycloakConfig is missing a parameter

### How to Reproduce?

Try to add the `public-client` parameter to a KeycloakConfig results in a compilation error

### Anything else?

_No response_

Contributor guide

Open the contributing guide

Research direction

Open keycloak.d.ts at the linked KeycloakConfig definition and compare it with the Keycloak 18 config described in the issue. Update the typedef so a config containing public-client compiles, then verify that the example configuration is accepted by the type definition.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
authentication
Issue type
Bug
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
62/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.