# Full documentation of account management REST API?

**URL:** <https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026>\
**Category:** Miscellanaeous\
**Created:** [April 19, 2022, 8:32am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026 "2022-04-19T08:32:04Z")\
**Posts on this page:** 8\
**Page:** 1

<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:** [April 19, 2022, 8:32am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/1 "2022-04-19T08:32:04Z")

</div>

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

---

<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:** [April 19, 2022, 8:45am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/2 "2022-04-19T08:45:51Z")

</div>

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](https://github.com/keycloak/keycloak/blob/main/services/src/main/java/org/keycloak/services/resources/account/AccountRestService.java)

---

<div class="post-metadata">

**Author:** ![christianviana](https://yyz2.discourse-cdn.com/free1/user_avatar/forum.keycloak.org/christianviana/32/4958_2.png) [@christianviana](https://forum.keycloak.org/u/christianviana)\
**Post date:** [April 20, 2022, 10:07am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/3 "2022-04-20T10:07:34Z")

</div>

You mean this?

[https://www.keycloak.org/docs-api/17.0/rest-api/](https://www.keycloak.org/docs-api/17.0/rest-api/)

---

<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:** [April 20, 2022, 10:20am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/4 "2022-04-20T10:20:58Z")

</div>

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

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

---

<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:46am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/5 "2023-02-10T07:46:23Z")

</div>

> [@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.

---

<div class="post-metadata">

**Author:** ![interhop](https://avatars.discourse-cdn.com/v4/letter/i/b9e5f3/32.png) [@interhop](https://forum.keycloak.org/u/interhop)\
**Post date:** [March 24, 2024, 9:27am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/6 "2024-03-24T09:27:32Z")

</div>

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

---

<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:** [March 24, 2024, 9:28am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/7 "2024-03-24T09:28:49Z")

</div>

> [@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…

---

<div class="post-metadata">

**Author:** ![meierw](https://yyz2.discourse-cdn.com/free1/user_avatar/forum.keycloak.org/meierw/32/10140_2.png) [@meierw](https://forum.keycloak.org/u/meierw)\
**Post date:** [April 3, 2024, 9:21am UTC](https://forum.keycloak.org/t/full-documentation-of-account-management-rest-api/15026/8 "2024-04-03T09:21:50Z")

</div>

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. 😅
