Keycloak Plugin for Steampipe [WIP]
THIS IS NOT ACTIVE NOR WORKING YET - DO NOT USE
Use SQL to query information including Users, Groups, Clients, Roles and more from Keycloak.
- Get started →
- Documentation: Table definitions & examples
- Community: Slack Channel
- Get involved: Issues
Quick start
Install the plugin with Steampipe:
steampipe plugin install theapsgroup/keycloak
Setup the configuration:
vi ~/.steampipe/config/keycloak.spc
or set the following Environment Variables
KEYCLOAK_ADDR
: The Endpoint at which to contact your Keycloak instance (example: https://auth.example.com/ )KEYCLOAK_USER
: The Username for a user with Admin privilegesKEYCLOAK_PASSWORD
: The password for a user with Admin privilegesKEYCLOAK_REALM
: The realm in the Keycloak instance you wish to query.
Run a query:
select * from keycloak_user
Developing
Prerequisites:
Clone:
git clone https://github.com/theapsgroup/steampipe-plugin-keycloak.git
cd steampipe-plugin-keycloak
Build, which automatically installs the new version to your ~/.steampipe/plugins
directory:
make install
Configure the plugin:
cp config/* ~/.steampipe/config
vi ~/.steampipe/config/keycloak.spc
Try it!
steampipe query
> .inspect keycloak
Further reading:
Credits
Keycloak API Wrapper Nerzal/gocloak licensed separately using this Apache License.