Full documentation of account management REST API?

[aksolv]

Is there a full documentation of the account management REST API available somewhere?

[xgp]

I don’t believe it is documented. You can look at the source to get an idea of what methods are available keycloak/AccountRestService.java at main · keycloak/keycloak · GitHub

[christianviana]

You mean this?

https://www.keycloak.org/docs-api/17.0/rest-api/

[dasniko]

This is the admin REST API, not the account management REST API…

Account management REST API docs are not available for the time being.

[xgp]

OpenAPI for Account API

There’s been a few posts here asking about the undocumented Keycloak Account API. While it may change/disappear at any time, I’m aware that some people use it for building a custom account console, or building account information and editing into their applications. I made OpenAPI definitions of the Account API for those with that use case. Note that it is currently missing the /resources methods, but is otherwise fairly complete. Please submit changes if you find any problems.

[interhop]

Thank you @xgp for sharing.
Why isn’t this API documented @dasniko ? Is it dangerous to use it ? Will it be maintained?

[dasniko]

@interhop

Why isn’t this API documented @dasniko ?

Don’t know
Most probably, there wasn’t time and/or motivation to it yet. Just like in your regular projects, nobody likes to to documentation…

[meierw]

I recently started using KC and I was thinking “This feels wrong that I am looking at the network requests behind the Account Management UI in the dev console. Surely I’m missing something and haven’t found the correct docs”.

But now I don’t feel like a crazy person, knowing that the docs simply did not exist.