Rate this page:
Crowd 2.1 and later.
The REST APIs are for developers who want to integrate Crowd into their application and for administrators who want to script interactions with the Crowd server.
Crowd offers a set of REST APIs for use by applications connecting to Crowd.
Please note the main difference between Crowd APIs and the APIs of other applications like JIRA and Confluence: In Crowd, an application is the client of Crowd, whereas in JIRA/Confluence a user is the client. For example, when authenticating a request to a Crowd REST resource via basic authentication, the application name and password is used (and not a username and password). Keep this in mind when using the REST APIs.
Crowd's REST APIs provide access to resources (data entities) via URI paths. To use a REST API, your application will make an HTTP request and parse the response. By default, the response format is XML. If you wish, you can request JSON instead of XML. Your methods will be the standard HTTP methods like GET, PUT, POST and DELETE.
Because the REST API is based on open standards, you can use any web development language to access the API.
The REST APIs offer the following features:
Example: To search for a particular user, perform a GET request at:
If you would like to know more about REST in general, start with the Dare Obasanjo's blog post, Explaining REST to Damien Katz.
Then jump right in and try our REST resources:
Below are some links to in-depth information on developing REST APIs and plugins:
Rate this page: