# \#documentation **URL:** https://forum.keycloak.org/tag/documentation/68.md [Latest](https://forum.keycloak.org/latest.md) · [Categories](https://forum.keycloak.org/categories.md) · [Tags](https://forum.keycloak.org/tags.md) --- ## [How to document custom APIs in a Keycloak extension using Swagger/OpenAPI?](https://forum.keycloak.org/t/how-to-document-custom-apis-in-a-keycloak-extension-using-swagger-openapi/29031)
**Author:** [@amir\_ka](https://forum.keycloak.org/u/amir_ka)\ **Replies:** 0\ **Last updated:** [December 2, 2024, 4:18pm UTC](https://forum.keycloak.org/t/how-to-document-custom-apis-in-a-keycloak-extension-using-swagger-openapi/29031 "2024-12-02T16:18:10Z")
Hi, I’m developing a custom Keycloak extension and want to expose custom APIs as part of Keycloak’s endpoints (e.g., /admin/realms/\/custom). Additionally, I want to document these APIs using Swagger/OpenAPI and s… --- ## [Improvements to Documentation and Error Handling in Keycloak](https://forum.keycloak.org/t/improvements-to-documentation-and-error-handling-in-keycloak/28161)
**Author:** [@MeowDev](https://forum.keycloak.org/u/MeowDev)\ **Replies:** 1\ **Last updated:** [October 2, 2024, 1:03pm UTC](https://forum.keycloak.org/t/improvements-to-documentation-and-error-handling-in-keycloak/28161 "2024-10-02T13:03:16Z")
Hello everyone, I encountered some issues while working with the Keycloak API, and I believe improving the documentation and error handling could benefit others as well. 1. Documentation Update for POST /admin/realms/{… --- ## [Memory Leak Problem in Keycloak](https://forum.keycloak.org/t/memory-leak-problem-in-keycloak/13697)
**Author:** [@alprncinar](https://forum.keycloak.org/u/alprncinar)\ **Replies:** 3\ **Last updated:** [August 27, 2024, 7:12am UTC](https://forum.keycloak.org/t/memory-leak-problem-in-keycloak/13697 "2024-08-27T07:12:39Z")
Hello Everyone, We have a SPI java project that is using Keycloak. We have three different method. First two methods are creating a new user session in Keycloak. The last method is killing all of the opened sessions. Af… --- ## [Error responses for Protected Resources in Keycloak Admin REST API](https://forum.keycloak.org/t/error-responses-for-protected-resources-in-keycloak-admin-rest-api/25104)
**Author:** [@Saul](https://forum.keycloak.org/u/Saul)\ **Replies:** 0\ **Last updated:** [March 18, 2024, 9:46am UTC](https://forum.keycloak.org/t/error-responses-for-protected-resources-in-keycloak-admin-rest-api/25104 "2024-03-18T09:46:48Z")
I have a confidential client which uses client credentials flow and then calls various Protected Resources in Keycloak Admin REST API. Which HTTP response codes and what error response content can I expect from Admin AP… --- ## [Old documentation missing](https://forum.keycloak.org/t/old-documentation-missing/22095)
**Author:** [@mustafaaloko](https://forum.keycloak.org/u/mustafaaloko)\ **Replies:** 6\ **Last updated:** [March 5, 2024, 12:27pm UTC](https://forum.keycloak.org/t/old-documentation-missing/22095 "2024-03-05T12:27:43Z")
Hello everyone, I am using Keycloak version 15 for one of my projects, but I can no longer access the docs for it. It’s not even listed in the archive page, last we have is 18. This link worked few days ago: https://ww… --- ## [Export realm and user from Keycloak 11.0.3](https://forum.keycloak.org/t/export-realm-and-user-from-keycloak-11-0-3/23933)
**Author:** [@Dorel](https://forum.keycloak.org/u/Dorel)\ **Replies:** 0\ **Last updated:** [January 4, 2024, 3:11pm UTC](https://forum.keycloak.org/t/export-realm-and-user-from-keycloak-11-0-3/23933 "2024-01-04T15:11:08Z")
Hi, I must migrate a current Keycloak 11.0.3 instance in standalone mode on a newer version of KC. For doing that I need to save a particular realm with the users. Admin UI let me perform a partial save of roles and u… --- ## [8.0.1 documentation](https://forum.keycloak.org/t/8-0-1-documentation/17519)
**Author:** [@lampok](https://forum.keycloak.org/u/lampok)\ **Replies:** 3\ **Last updated:** [December 27, 2023, 6:42pm UTC](https://forum.keycloak.org/t/8-0-1-documentation/17519 "2023-12-27T18:42:04Z")
I am working to integrate an external OIDC provider into Keycloak. The software vendor we are using deployed version 8.0.1, I know old. Does anyone have offline documentation for this version of Keycloak? We are finding… --- ## [Documentation on how to write a custom Identity provider](https://forum.keycloak.org/t/documentation-on-how-to-write-a-custom-identity-provider/22329)
**Author:** [@cwdev](https://forum.keycloak.org/u/cwdev)\ **Replies:** 0\ **Last updated:** [May 25, 2023, 4:11pm UTC](https://forum.keycloak.org/t/documentation-on-how-to-write-a-custom-identity-provider/22329 "2023-05-25T16:11:10Z")
Good afternoon. I’m trying to write a custom identity provider (for Keycloak 21.1.1) to integrate with another system that uses a custom protocol. I sifted through the documentation but couldn’t find any tips / best pra… --- ## [I can't find documentation for the keycloak API](https://forum.keycloak.org/t/i-cant-find-documentation-for-the-keycloak-api/20604)
**Author:** [@aldofiore28](https://forum.keycloak.org/u/aldofiore28)\ **Replies:** 3\ **Last updated:** [March 2, 2023, 10:05pm UTC](https://forum.keycloak.org/t/i-cant-find-documentation-for-the-keycloak-api/20604 "2023-03-02T22:05:38Z")
I am working on something at work that already uses keycloak and I need to modify it, but I don’t seem to be able to find any documentation of the API. I am using the REST API, but something else. The existing request i… --- ## [Outdated documentation - read\_only\_user\_attributes](https://forum.keycloak.org/t/outdated-documentation-read-only-user-attributes/12369)
**Author:** [@tpdene](https://forum.keycloak.org/u/tpdene)\ **Replies:** 1\ **Last updated:** [February 24, 2023, 4:11pm UTC](https://forum.keycloak.org/t/outdated-documentation-read-only-user-attributes/12369 "2023-02-24T16:11:51Z")
Hi guys, Could someone update the documentation here please? https://www.keycloak.org/docs/latest/server\_admin/#\_read\_only\_user\_attributes There’s a code snippet below “The same can be configured with the usage of the… --- ## [OutOfMemory in SessionRegistryImpl (Spring Security Adapter Config)](https://forum.keycloak.org/t/outofmemory-in-sessionregistryimpl-spring-security-adapter-config/6814)
**Author:** [@Oli411](https://forum.keycloak.org/u/Oli411)\ **Replies:** 2\ **Last updated:** [January 12, 2023, 7:10pm UTC](https://forum.keycloak.org/t/outofmemory-in-sessionregistryimpl-spring-security-adapter-config/6814 "2023-01-12T19:10:33Z")
Hi, I configured the SessionAuthenticationStrategy (Spring Security Adapter) as stated in the official documentation: https://www.keycloak.org/docs/latest/securing\_apps/index.html#\_spring\_security\_adapter After creatin… --- ## [Where are the protocol mapper config options documented?](https://forum.keycloak.org/t/where-are-the-protocol-mapper-config-options-documented/8164)
**Author:** [@atb-brown](https://forum.keycloak.org/u/atb-brown)\ **Replies:** 4\ **Last updated:** [September 7, 2022, 11:39am UTC](https://forum.keycloak.org/t/where-are-the-protocol-mapper-config-options-documented/8164 "2022-09-07T11:39:00Z")
I’m using Keycloak’s Java keycloak-admin-client and I’m wanting to set up some protocol mappers for my realm’s client. The Java API exposes this class to create a protocol mapper and then the following method to set the… --- ## [Keycloak 17.0.1 behind NginX reverse proxy](https://forum.keycloak.org/t/keycloak-17-0-1-behind-nginx-reverse-proxy/15014)
**Author:** [@hoozr](https://forum.keycloak.org/u/hoozr)\ **Replies:** 17\ **Last updated:** [April 25, 2022, 7:06am UTC](https://forum.keycloak.org/t/keycloak-17-0-1-behind-nginx-reverse-proxy/15014 "2022-04-25T07:06:56Z")
Hello there! I am configuring keycloak in compose like that: keycloak: image: quay.io/keycloak/keycloak:17.0.1 depends\_on: - keycloakdb networks: - net environment: KC\_DB: postgres … --- ## [org.keycloak.services.resources.admin.UserResource#updateUserFromRep unused parameter](https://forum.keycloak.org/t/org-keycloak-services-resources-admin-userresource-updateuserfromrep-unused-parameter/14603)
**Author:** [@npasic](https://forum.keycloak.org/u/npasic)\ **Replies:** 0\ **Last updated:** [March 28, 2022, 6:57am UTC](https://forum.keycloak.org/t/org-keycloak-services-resources-admin-userresource-updateuserfromrep-unused-parameter/14603 "2022-03-28T06:57:57Z")
In org.keycloak.services.resources.admin.UserResource#updateUserFromRep there is unused parameter UserProfile profile in version 17.1. Is it safe to pass null or there is something behind the scene that evaluates this a… --- ## [Keycloak 17.0 javadoc link broken](https://forum.keycloak.org/t/keycloak-17-0-javadoc-link-broken/13909)
**Author:** [@Laurenzo](https://forum.keycloak.org/u/Laurenzo)\ **Replies:** 1\ **Last updated:** [February 28, 2022, 9:34am UTC](https://forum.keycloak.org/t/keycloak-17-0-javadoc-link-broken/13909 "2022-02-28T09:34:14Z")
I already do apologize a bit for putting such a question to this forum, but I do think it’s quite relevant. The javadoc link for Keycloak version 17 is broken, ref: https://www.keycloak.org/docs-api/17.0/ Any idea is t… --- ## [Default JBOSS install giving "NS\_BINDING\_ABORTED" on admin login](https://forum.keycloak.org/t/default-jboss-install-giving-ns-binding-aborted-on-admin-login/12231)
**Author:** [@systemsincode](https://forum.keycloak.org/u/systemsincode)\ **Replies:** 5\ **Last updated:** [November 28, 2021, 9:42pm UTC](https://forum.keycloak.org/t/default-jboss-install-giving-ns-binding-aborted-on-admin-login/12231 "2021-11-28T21:42:28Z")
I am trying to get to know Keycloak and I’m trying to run the default jdk build using steps mentioned on Keycloak - Guide - Keycloak on OpenJDK on Windows 10? It ran as a described and runs in JBOSS instance with my azu… --- ## [Keycloak on Podman guide doesn't work for 9.0.3](https://forum.keycloak.org/t/keycloak-on-podman-guide-doesnt-work-for-9-0-3/2165)
**Author:** [@maztaim](https://forum.keycloak.org/u/maztaim)\ **Replies:** 2\ **Last updated:** [November 19, 2021, 5:00pm UTC](https://forum.keycloak.org/t/keycloak-on-podman-guide-doesnt-work-for-9-0-3/2165 "2021-11-19T17:00:37Z")
I followed the first line and get $ podman run -p 8080:8080 -e KEYCLOAK\_USER=admin -e KEYCLOAK\_PASSWORD=admin quay.io/keycloak/keycloak:9.0.3 Added 'admin' to '/opt/jboss/keycloak/standalone/configuration/keycloak-add-u… --- ## [Docs Error in REST API Overview?](https://forum.keycloak.org/t/docs-error-in-rest-api-overview/9798)
**Author:** [@Carl](https://forum.keycloak.org/u/Carl)\ **Replies:** 0\ **Last updated:** [June 26, 2021, 12:57pm UTC](https://forum.keycloak.org/t/docs-error-in-rest-api-overview/9798 "2021-06-26T12:57:37Z")
Hi, Is this an error in the documentation? I’m getting started with the REST API and was wondering if URI scheme Host: localhost:8080 BasePath: /auth Schemes: HTTP Should BasePath instead be “/auth/admin/realms”? I’… --- ## [Resource Server API Documentation](https://forum.keycloak.org/t/resource-server-api-documentation/2434)
**Author:** [@Michael](https://forum.keycloak.org/u/Michael)\ **Replies:** 1\ **Last updated:** [May 18, 2020, 12:08am UTC](https://forum.keycloak.org/t/resource-server-api-documentation/2434 "2020-05-18T00:08:30Z")
Hello, I’m look for documentation on creating resources, permissions, policies via API but I’m not seeing any. I’m seeing calls like /auth/admin/realms/{realm}/clients/{client}/authz/resource-server/resource in the a…