README

This package aims to wrap the Keycloak API and provide an easy and consistent layer for managing your keycloak realms.

Documentation

Quick start

First create a KeycloakClient with your credentials.

$kcClient = new Keycloak\KeycloakClient(
    'my-client-id',
    'my-client-secret',
    'my-realm',
    'https://my-keycloak-base-url.com'
);

Or use a admin user credentials.

$kcClient = new Keycloak\KeycloakPasswordClient(
    'my-realm',
    'https://my-keycloak-base-url.com',
    'username',
    'password'
);

Then you can pass the client to any of the APIs.

$userApi = new Keycloak\User\Api($kcClient);
$allUsers = $userApi->findAll();

Tested platforms

These are the platforms which are officially supported by this package. Any other versions will probably work but is not guaranteed.

Contributing

Please read our contribution guidelines before contributing.