Add the ability to run raw queries or add custom endpoints

[max-petrovich]

My use case:
I added custom APIs to Keycloak, and through your library I can’t access them (without forking)

[fschmtt]

Hey, I haven't been around for a few days, so sorry for not replying earlier.

If you already have a fork and implemented endpoint(s) yourself, you can open a PR to my repo and I'll happily review it.

Shouldn't be a big deal to get it merged - this way everybody profits!

[fschmtt]

I created a draft PR: #71

Happy to hear your feedback on it - does it look utilizable for your use case? 😄

[max-petrovich]

I can also suggest an option:

1. The end user creates his own package, adding your client as a dependency
2. Adds its methods to its package

The application already connects its own package and uses custom methods, as if they were originally in the client

[fschmtt]

Not sure if I get you right - you want to have explicit APIs to register custom endpoints, e.g.

$keycloak = new Keycloak(...);
$keycloak->registerCustomEndpoint(
    path: '/custom/api/endpoint/{param1}',
    returnType: MyCustomRepresentation::class
);

Did I get this right?

[fschmtt]

Hey @max-petrovich did you have a change to check out the changes in the mentioned PR?

Happy to get your feedback! 😄

[max-petrovich]

Your option is not bad, but I rather meant something else - I create a separate repository with my custom methods, I included your SDK in my package. Then I use my “modified” library and have code completion, etc.

[fschmtt]

I think what you are describing is exactly what I would be doing by simply forking this library and modifying it to your needs by adding new resources.

I started prototyping something that lets you add custom resources but this will end up in offering general methods that then (might) kill the auto-completion (at least without additional annotating and proper IDE support), e.g.:

$keycloak = new Keycloak(...);

$myCustomResource = $keycloak->getResource(MyCustomResource::class);

I'd actually want try to avoid having too much generality because I built this library with easy use and proper code completion in mind. But maybe I'm finding a solution that I'm satisfied with 😄

[fschmtt]

I opened a new draft PR: #80

[fschmtt]

@max-petrovich would be glad to hear your feedback on #80 😄

[fschmtt]

I merged #80 and think it covers your use case.

Feel free to re-open this issue if it doesn't 🙂