@nebulae/keycloak-admin-client
Client for contacting the Keycloak Admin REST API
Last updated 7 months ago by juansmolano .
Apache-2.0 · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install @nebulae/keycloak-admin-client 
SYNC missed versions from official npm registry.

Keycloak Admin Client

Greenkeeper badge

Coverage Status Build Status Known Vulnerabilities dependencies Status

NPM

An Extremely Experimental client for connecting to the Keycloak Admin REST API - http://www.keycloak.org/docs-api/3.2/rest-api/index.html

Project Info
License: Apache-2.0
Build: make
Documentation: http://www.keycloak.org/keycloak-admin-client/index.html
Issue tracker: https://github.com/keycloak/keycloak-admin-client/issues
Engines: Node.js 4.x, 6.x, 8.x

Installation

npm install keycloak-admin-client -S

Usage

'use strict';

let adminClient = require('./');

let settings = {
  baseUrl: 'http://127.0.0.1:8080/auth',
  username: 'admin',
  password: 'admin',
  grant_type: 'password',
  client_id: 'admin-cli'
};

adminClient(settings)
  .then((client) => {
  console.log('client', client);
  client.realms.find()
    .then((realms) => {
    console.log('realms', realms);
    });
  })
  .catch((err) => {
    console.log('Error', err);
  });

Development & Testing

To run the tests, you'll need to have a keycloak server running. No worries! This is all taken care of for you. Just run ./scripts/start-server.sh. If you don't already have a server downloaded, this script will download one for you, start it, initialize the admin user, and then restart.

Then just run the tests.

make test

To stop the server, run ./scripts/stop-server.sh.

Notable Changes from 0.1.0 to 0.2.0

The API has been changed to logically group up(namespace) functionality.

For example, the 0.1.0 way of getting a list of all realms was by calling the client.realms function.

Now in 0.2.0, you would do something like this: client.realms.find

find can also be used to get 1 realm by passing in the realmName: client.realms.find('master')

The other methods have been renamed too, for example, instead of calling client.updateRealm you would now call client.realms.update

Other

The current RFC is located here: https://github.com/bucharest-gold/entente/blob/master/rfcs/keycloak-admin-rest-api-node-client.md

Contributing

Please read the contributing guide

Reporting security vulnerabilities

If you've found a security vulnerability, please look at the instructions on how to properly report it

Current Tags

  • 1.1.0                                ...           latest (7 months ago)

9 Versions

  • 1.1.0                                ...           7 months ago
  • 1.0.1                                ...           a year ago
  • 1.0.0                                ...           a year ago
  • 0.13.5                                ...           2 years ago
  • 0.13.4                                ...           2 years ago
  • 0.13.3                                ...           2 years ago
  • 0.13.2                                ...           2 years ago
  • 0.13.1                                ...           2 years ago
  • 0.13.0                                ...           2 years ago
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 1
Last Month 1
Dependencies (3)
Dev Dependencies (16)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |