Table of Contents

Search

  1. Preface
  2. RulePoint Interfaces
  3. RulePoint Services
  4. Custom Service API
  5. Java Adapter for REST API
  6. RulePoint REST API
  7. Sample XML and JSON Requests and Responses
  8. RulePoint Pluggable Authentication Module
  9. HTTP Request and Response Attributes

Developer Guide

Developer Guide

Create Users

Create Users

Use the POST method to create a user in RulePoint.

POST Request in JSON Format

Generate a POST request. For example, the following POST request creates a user in a RulePoint application:
POST http://localhost:8080/rulepoint/api/users Accept: application/json Content-Type: application/json Cookie: JSESSIONID=<VALID SESSION ID>

POST Body in JSON Format

{ "userName": "newuser12", "password": "newuser1234", "firstName": "new", "lastName": "user1111", "roles": [ { "rel": "roles", "href": "/api/roles/ROLE_ADMIN", "title": "Predefined Admin Role", "id": "ROLE_ADMIN" }, { "rel": "roles", "href": "/api/roles/ROLE_USER", "title": "Predefined User Role", "id": "ROLE_USER" } ], "remoteUser": false }

POST Response in JSON Format

Returns the user object and response code. Returns the error object if an error occurs.
{ "id": "98305", "self": { "rel": "self", "href": "/api/users/newuser12", "title": "newuser12", "id": "newuser12" }, "actions": [ { "rel": "update", "href": "/api/users/", "type": "PUT" }, { "rel": "delete", "href": "/api/users/newuser12", "type": "DELETE" } ], "lastModifiedDate": "2013-09-18T18:34:38+05:30", "createDate": "2013-09-18T18:34:38+05:30", "modifiedBy": "Administrator", "createdBy": "Administrator", "userName": "newuser12", "password": "*****", "firstName": "new", "lastName": "user1111", "roles": [ { "rel": "roles", "href": "/api/roles/ROLE_ADMIN", "title": "Predefined Admin Role", "id": "ROLE_ADMIN" }, { "rel": "roles", "href": "/api/roles/ROLE_USER", "title": "Predefined User Role", "id": "ROLE_USER" } ], "enabled": true, "predefined": false, "remoteUser": false }

POST Request in XML Format

POST http://localhost:8080/rulepoint/api/users Accept: application/xml Content-Type: application/xml Cookie: JSESSIONID=<VALID SESSION ID>

POST Body in XML Format

Generate a POST request. For example, the following POST request creates a user in a RulePoint application:
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user> <valid>false</valid> <enabled>true</enabled> <firstName>new</firstName> <lastName>user</lastName> <password>newuser1234</password> <predefined>false</predefined> <remoteUser>false</remoteUser> <roles> <href>/api/roles/ROLE_ADMIN</href> <id>ROLE_ADMIN</id> <rel>roles</rel> <title>Predefined Admin Role</title> </roles> <roles> <href>/api/roles/ROLE_USER</href> <id>ROLE_USER</id> <rel>roles</rel> <title>Predefined User Role</title> </roles> <userName>newuser123</userName> </user>

POST Response in XML Format

Returns the user object and response code 200 OK. Returns the error object if an error occurs.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?> <user> <actions> <action> <href>/api/users/</href> <rel>update</rel> <type>PUT</type> </action> <action> <href>/api/users/newuser123</href> <rel>delete</rel> <type>DELETE</type> </action> </actions> <id>32774</id> <self> <href>/api/users/newuser123</href> <id>newuser123</id> <rel>self</rel> <title>newuser123</title> </self> <createDate/> <createdBy>Administrator</createdBy> <enabled>true</enabled> <firstName>new</firstName> <lastModifiedDate/> <lastName>user</lastName> <modifiedBy>Administrator</modifiedBy> <password>*****</password> <predefined>false</predefined> <remoteUser>false</remoteUser> <roles> <href>/api/roles/ROLE_ADMIN</href> <id>ROLE_ADMIN</id> <rel>roles</rel> <title>Predefined Admin Role</title> </roles> <roles> <href>/api/roles/ROLE_USER</href> <id>ROLE_USER</id> <rel>roles</rel> <title>Predefined User Role</title> </roles> <userName>newuser123</userName> </user>

0 COMMENTS

We’d like to hear from you!