# Account Management REST API a supported feature

**URL:** <https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319>\
**Category:** Getting advice\
**Created:** [July 5, 2022, 5:40pm UTC](https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319 "2022-07-05T17:40:19Z")\
**Posts on this page:** 4\
**Page:** 1

<div class="post-metadata">

**Author:** ![weinzierl](https://yyz2.discourse-cdn.com/free1/user_avatar/forum.keycloak.org/weinzierl/32/6075_2.png) [@weinzierl](https://forum.keycloak.org/u/weinzierl)\
**Post date:** [July 5, 2022, 5:40pm UTC](https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319/1 "2022-07-05T17:40:19Z")

</div>

The Account Management REST API is mentioned here [1] as supported (and enabled by default) feature. Yet there seems to be no documentation for is[2]. Is this an official API which is here to stay or will it eventually be removed?

[1] [Enabling and disabling features - Keycloak](https://www.keycloak.org/server/features)  
[2] [Full documentation of account management REST API?](http://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026)

---

<div class="post-metadata">

**Author:** ![dasniko](https://yyz2.discourse-cdn.com/free1/user_avatar/forum.keycloak.org/dasniko/32/2969_2.png) [@dasniko](https://forum.keycloak.org/u/dasniko)\
**Post date:** [July 5, 2022, 6:00pm UTC](https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319/2 "2022-07-05T18:00:43Z")

</div>

AFAIK this is an official API and made to stay, although it‘s not documented.  
It‘s planned to remove the legacy account client with the next major version and the React.js based account app using the account API becomes default (resp. the only one). Perhaps some documentation will be added, perhaps not.

What I do (and many others I know): Use the account console, open the browser dev console, network tab, and record/view the requests you are interested in… This should give you most of the needed information.

---

<div class="post-metadata">

**Author:** ![aksolv](https://avatars.discourse-cdn.com/v4/letter/a/90ced4/32.png) [@aksolv](https://forum.keycloak.org/u/aksolv)\
**Post date:** [July 5, 2022, 6:04pm UTC](https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319/3 "2022-07-05T18:04:46Z")

</div>

I’m not a keycloak developer, but there is very little activity in this forum in terms of replies, so I’ll answer anyway.

That API is not documented. There is no promise that it will stay the same. But it is used from the account management interface for normal, non-privileged users. I’d expect it to stay, though it may be subject to some changes.

The alternative would be to make your own backend microservice that exposes account management functionality using the more stable and better documented Administration REST API. But arguably, this is more work than updating a few API requests if you decide to update keycloak to a breaking version.

---

<div class="post-metadata">

**Author:** ![xgp](https://yyz2.discourse-cdn.com/free1/user_avatar/forum.keycloak.org/xgp/32/2589_2.png) [@xgp](https://forum.keycloak.org/u/xgp)\
**Post date:** [February 10, 2023, 7:47am UTC](https://forum.keycloak.org/t/account-management-rest-api-a-supported-feature/16319/4 "2023-02-10T07:47:54Z")

</div>

It is now the default, and will likely remain for the current account theme (`keycloak.v2`) and the one that is currently being worked on. I made an OpenAPI spec file to ease building clients:

> [@OpenAPI for Account API](http://forum.keycloak.org/t/openapi-for-account-api/20171):
>
> There’s been a few posts here asking about the undocumented [Keycloak Account API](https://github.com/keycloak/keycloak/blob/main/services/src/main/java/org/keycloak/services/resources/account/AccountRestService.java). 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](https://gist.github.com/xgp/2d77cbebc6164160faae6aa77d127a57) 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.
