REST API Path Question

#1

I’m working with the REST API.

According to the docs (https://www.keycloak.org/docs-api/9.0/rest-api/index.html):

  • Base URL = /auth

I’m attempting to retrieve the list of clients for a tenant (https://www.keycloak.org/docs-api/9.0/rest-api/index.html#_clients_resource)

The docs say GET /{realm}/clients, so I assumed it was /auth/realms/{realm}/clients

This doesn’t work, neither does /auth/{realm}/clients

What DOES work is /auth/admin/realms/{realm}/clients (picked this up from the browser inspector).

Is this the proper path to use (with ‘admin’) - or do I have a different issue?

Thanks!
jc

#2

You are correct, base path should be /auth/admin/realms
Seems like there are a couple of tickets open for improving these docs https://issues.redhat.com/browse/KEYCLOAK-8574