[keycloak-user] Keycloak REST API

[Marko Strukelj]

We are aware of the issue. See
http://lists.jboss.org/pipermail/keycloak-user/2017-November/012181.html
for some suggestions.

REST API Docs are autogenerated from code and javadoc and we prefer it this
way to minimise inconsistencies that would otherwise arise over time.

The choice of documentation generation pipeline is a factor. We're not
using Swagger ATM, and OpenAPI seems to be the best option to move to in
the future. I don't think there's a JIRA for it yet. Feel free to open it.

Any contributions welcome :)


On Wed, Nov 8, 2017 at 9:35 AM, Stephane Epardaud <stef at epardaud.fr> wrote:

> Hi,
>
> I'm trying to use the REST API of keycloak to seed an initial config for
> tests that depend on keycloak, but I only found this doc:
> http://www.keycloak.org/docs-api/3.3/rest-api/index.html
>
> Are there better docs somewhere else?
>
> If not: they barely explain what the entities are, and don't tell me
> which parts are settable, required, or server-generated. They also
> contain some links to types that are not documented (like Map), and
> don't explain how to get a token to play along (found that somewhere
> completely different). A set of examples with each endpoint and entity
> type would be _greatly_ appreciated too. Otherwise there's a lot of
> guesswork involved :(
>
> Otherwise, pretty impressed with the rest of KeyCloak, so don't take
> that issue harshly :)
>
> Cheers.
>
>
> _______________________________________________
> keycloak-user mailing list
> keycloak-user at lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/keycloak-user
>