Keycloak Admin REST API

keycloak · Developer Tools

Developer Tools No Auth Free & Open developer_tools

This is a REST API reference for the Keycloak Admin

Authentication

No authentication requiredFree to use with no key needed.

Sample Requests

GET Get themes, social providers, auth providers, and event listeners available on this server

Get themes, social providers, auth providers, and event listeners available on this server

https://api.apis.guru/v2/specs/keycloak.local/1

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/keycloak.local/1/"

import requests
response = requests.get(
    "https://api.apis.guru/v2/specs/keycloak.local/1/",
)
print(response.json())

const url = 'https://api.apis.guru/v2/specs/keycloak.local/1/';

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
)

func main() {
	targetURL := "https://api.apis.guru/v2/specs/keycloak.local/1/"
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/keycloak.local/1/")

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/keycloak.local/1/";
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get admin events Returns all admin events, or filters events based on URL query parameters listed here

Get admin events Returns all admin events, or filters events based on URL query parameters listed here

https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events?max=1&first=1&dateTo=example&authUser=example&dateFrom=example&authRealm=example&authClient=example&resourcePath=example&authIpAddress=example&resourceTypes=example&operationTypes=example

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events?max=1&first=1&dateTo=example&authUser=example&dateFrom=example&authRealm=example&authClient=example&resourcePath=example&authIpAddress=example&resourceTypes=example&operationTypes=example"

import requests
params = {
    "max": "1",
    "first": "1",
    "dateTo": "example",
    "authUser": "example",
    "dateFrom": "example",
    "authRealm": "example",
    "authClient": "example",
    "resourcePath": "example",
    "authIpAddress": "example",
    "resourceTypes": "example",
    "operationTypes": "example"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events');
url.searchParams.set('max', '1');
url.searchParams.set('first', '1');
url.searchParams.set('dateTo', 'example');
url.searchParams.set('authUser', 'example');
url.searchParams.set('dateFrom', 'example');
url.searchParams.set('authRealm', 'example');
url.searchParams.set('authClient', 'example');
url.searchParams.set('resourcePath', 'example');
url.searchParams.set('authIpAddress', 'example');
url.searchParams.set('resourceTypes', 'example');
url.searchParams.set('operationTypes', 'example');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events")
	q := baseURL.Query()
	q.Set("max", "1")
	q.Set("first", "1")
	q.Set("dateTo", "example")
	q.Set("authUser", "example")
	q.Set("dateFrom", "example")
	q.Set("authRealm", "example")
	q.Set("authClient", "example")
	q.Set("resourcePath", "example")
	q.Set("authIpAddress", "example")
	q.Set("resourceTypes", "example")
	q.Set("operationTypes", "example")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events")
uri.query = URI.encode_www_form({
  "max" => "1",
  "first" => "1",
  "dateTo" => "example",
  "authUser" => "example",
  "dateFrom" => "example",
  "authRealm" => "example",
  "authClient" => "example",
  "resourcePath" => "example",
  "authIpAddress" => "example",
  "resourceTypes" => "example",
  "operationTypes" => "example"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/admin-events?" . http_build_query([
    "max" => "1",
    "first" => "1",
    "dateTo" => "example",
    "authUser" => "example",
    "dateFrom" => "example",
    "authRealm" => "example",
    "authClient" => "example",
    "resourcePath" => "example",
    "authIpAddress" => "example",
    "resourceTypes" => "example",
    "operationTypes" => "example"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

GET Get clients belonging to the realm Returns a list of clients belonging to the realm

Get clients belonging to the realm Returns a list of clients belonging to the realm

https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients?max=1&first=1&search=hello&clientId=example&viewableOnly=true

Hover any highlighted part to learn what it does

curl -X GET "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients?max=1&first=1&search=hello&clientId=example&viewableOnly=true"

import requests
params = {
    "max": "1",
    "first": "1",
    "search": "hello",
    "clientId": "example",
    "viewableOnly": "true"
}
response = requests.get(
    "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients",
    params=params,
)
print(response.json())

const url = new URL('https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients');
url.searchParams.set('max', '1');
url.searchParams.set('first', '1');
url.searchParams.set('search', 'hello');
url.searchParams.set('clientId', 'example');
url.searchParams.set('viewableOnly', 'true');

const response = await fetch(url); 
const data = await response.json();
console.log(data);

package main

import (
	"fmt"
	"io"
	"net/http"
	"net/url"
)

func main() {
	baseURL, _ := url.Parse("https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients")
	q := baseURL.Query()
	q.Set("max", "1")
	q.Set("first", "1")
	q.Set("search", "hello")
	q.Set("clientId", "example")
	q.Set("viewableOnly", "true")
	baseURL.RawQuery = q.Encode()
	targetURL := baseURL.String()
	req, _ := http.NewRequest("GET", targetURL, nil)

	client := &http.Client{}
	resp, _ := client.Do(req)
	defer resp.Body.Close()
	body, _ := io.ReadAll(resp.Body)
	fmt.Println(string(body))
}

require "net/http"
require "json"

uri = URI("https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients")
uri.query = URI.encode_www_form({
  "max" => "1",
  "first" => "1",
  "search" => "hello",
  "clientId" => "example",
  "viewableOnly" => "true"
})

http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = uri.scheme == "https"

req = Net::HTTP::Get.new(uri)

res = http.request(req)
puts JSON.parse(res.body)

<?php
$url = "https://api.apis.guru/v2/specs/keycloak.local/1/{realm}/clients?" . http_build_query([
    "max" => "1",
    "first" => "1",
    "search" => "hello",
    "clientId" => "example",
    "viewableOnly" => "true"
]);
$opts = ["http" => [
    "method" => "GET",
]];
$ctx = stream_context_create($opts);
$res = file_get_contents($url, false, $ctx);
print_r(json_decode($res, true));

Postman Setup Guide

Get Postman ↗

See official documentation for authentication and setup.

What can you build with Keycloak Admin REST API?

Keycloak Admin REST API is a Developer Tools API. Developers commonly use developer tools APIs for:

automating code review and quality checks
integrating CI/CD pipelines and build systems
managing feature flags and A/B tests
monitoring errors and application performance
generating and validating test data

No authentication required. This API is open — no signup or key needed. Ideal for quick prototypes and public-facing features. Keycloak Admin REST API is free to use, making it a low-risk choice to experiment with.

New to APIs? Read our beginner's guide

Open documentation ↗