Promise-based client library to communicate with an Atlassian Crowd server from Node, written in ES6. This uses the Crowd REST APIs.
npm install --save atlassian-crowd-client
var CrowdClient = ;var User = ;// Initialize the Crowd client:var crowd =baseUrl: ''application:name: 'demo'password: 'example';// Create a new user:crowduser;// Authenticate to Crowd:crowdsession;// Find all active groups (using Crowd Query Language):crowdsearch;
Refer to the example settings file for all configurable options.
The package provides two main classes: CrowdApi and CrowdClient.
The CrowdApi class implements a generic interface to make HTTP requests to the Crowd REST API. It ensures that the appropriate headers are used and errors are handled. It also wraps the callbacks in promises.
Domain model objects
In order to provide a consistent API, most CrowdClient methods map Crowd API responses to domain objects. Many parameters are also expected to be a domain object. Here's an overview of the domain models and their properties:
token(string): Session token as generated by Crowd.
createdAt(Date): Creation date/time of the session token.
expiresAt(Date): Expiration date/time of the session token.
groupname(string): Name of the group.
description(string): Description for the group.
active(boolean): Whether the group is active or not.
firstname(string): First name.
lastname(string): Last name.
displayname(string): Display name (i.e. full name).
username(string): Username (i.e. login name).
password(string): Password, only used when creating a new user, never returned by Crowd.
active(boolean): Whether the user is active or not.
attributes(object): User/Group attributes as key-value pairs.
validationFactors(object): Validation factors as key-value pairs.
The library is completely written in ES6, using
babel-node to run tests. Source code is compiled to ES5 before
publication to NPM, so the library can also be used in ES5 projects.
Included are integration tests to verify proper functioning of all endpoints. For this you will need to provide settings
for a Crowd test server, since the integration tests will make actual HTTP requests. An example settings file is
test/helpers/settings-example.js. Copy or rename it to
settings.js and provide your own configuration.
git clone https://github.com/wehkamp/atlassian-crowd-client.gitcd atlassian-crowd-clientcp test/helpers/settings-example.js test/helpers/settings.jsnpm installnpm test