[CONF] Apache Sling Website > Managing users and groups (jackrabbit.usermanager)

[confluence]

Managing users and groups (jackrabbit.usermanager) Page edited by Felix Meschberger Managing users and groups The jackrabbit-usermanager bundle delivers a REST interface to create, update and delete users and groups in the JCR. After installing the jackrabbit-usermanager bundle all REST services are exposed under the path /system/userManager. List users Get user Create user Update user Change password Delete user List groups Get group Create group Update group Delete group Automated Tests List users To list existing users a GET request to the /system/userManager/user resource can be posted. Depending on the configuration of the Default GET Servlet and/or the availability of a Servlet or Script handling the sling/users resource type, a result may be delivered. Example with curl and the default JSON rendering: $ curl http://localhost:8080/system/userManager/user.tidy.1.json { "admin": {}, "anonymous": {} } Get user The properties of a single user can be retrieved by sending a GET request to the user's resource at /system/userManager/user/username where username would be replaced with the name of the user. Depending on the configuration of the Default GET Servlet and/or the availability of a Servlet or Script handling the sling/user resource type, a result may be delivered. Example with curl and the default JSON rendering: $ curl http://localhost:8080/system/userManager/user/admin.tidy.1.json {} If a non-existing user is requested a 404/NOT FOUND status is sent back. Create user To create a new user POST a request to /system/userManager/user.create.html. The following parameters are available: parameter name required description :name yes The name of the new user pwd yes The password of the new user pwdConfirm yes The password of the new user (confirming the value of pwd) <anyproperty> optional Additional parameters will be stored as node properties in the JCR Responses: 200 Success, a redirect is sent to the users resource locator with HTML describing status. 500 Failure, including user already exists. HTML explains failure. Example with curl: curl -F:name=myuser -Fpwd=password -FpwdConfirm=password -Fanyproperty1=value1 \ http://localhost:8080/system/userManager/user.create.html Update user To update an existing user POST a request to /system/userManager/user/username.update.html. You can NOT update the username or the password (see Change Password below) only the additional properties are updateable through this URL. The following parameters are available: parameter name required description <anyproperty> optional Additional parameters will be stored/updated as node properties in the JCR <anyprope...@delete> optional Properties with @Delete at the end of the name will be deleted in the JCR Responses: 200 Success, a redirect is sent to the users resource locator with HTML describing status. 404 User was not found 500 Failure Example curl -fanyproper...@delete -Fproperty2=value2 \ http://localhost:8080/system/userManager/user/myuser.update.html Change password To change a password of an existing user POST a request to /system/userManager/user/username.changePassword.html. The following parameters are available: parameter name required description oldPwd required Old password newPwd required New password newPwdConfrm required New password (confirming the password of newPwd Responses: 200 Success, sent with no body. 404 User was not found 500 Failure. HTML explains failure. Example curl -FoldPwd=oldpassword -FnewPwd=newpassword =FnewPwdConfirm=newpassword \ http://localhost:8080/system/userManager/user/myuser.changePassword.html Delete user To delete an existing user POST a request to /system/userManager/user/username.delete.html. The following parameters are available: parameter name required description :applyTo optional An array of relative resource references to users to be deleted. If this parameter is present, the username from the URL is ignored and all listed users are removed. Responses: 200 Success, sent with no body. 404 User(s) was/were not found 500 Failure. HTML explains failure. Example curl -Fgo=1 http://localhost:8080/system/userManager/user/myuser.delete.html List groups To list existing groups a GET request to the /system/userManager/group resource can be sent. Depending on the configuration of the Default GET Servlet and/or the availability of a Servlet or Script handling the sling/groups resource type, a result may be delivered. Example with curl and the default JSON rendering: $ curl http://localhost:8080/system/userManager/group.tidy.1.json { "UserAdmin": {}, "GroupAdmin": {}, "administrators": {} } Get group The properties of a single group can be retrieved by sending a GET request to the group's resource at /system/userManager/group/groupname where groupname would be replaced with the name of the group. Depending on the configuration of the Default GET Servlet and/or the availability of a Servlet or Script handling the sling/group resource type, a result may be delivered. Example with curl and the default JSON rendering: $ curl http://localhost:8080/system/userManager/group/administrators.tidy.1.json {} If a non-existing group is requested a 404/NOT FOUND status is sent back. Create group To create a new group POST a request to /system/userManager/group.create.html. The following parameters are available: parameter name required description :name yes The name of the new group <anyproperty> optional Additional parameters will be stored as node properties in the JCR Responses: 200 Success, a redirect is sent to the group resource locator with HTML describing status. 500 Failure, including group already exists. HTML explains failure. Example with curl: curl -F:name=mygroup -Fanyproperty1=value1 \ http://localhost:8080/system/userManager/group.create.html Update group To update an existing group POST a request to /system/userManager/group/groupname.update.html. You can NOT update the name of the group only the additional properties are updateable. The following parameters are available: parameter name required description :member optional user(s) (name or URI) to add to the group as a member. Can also be an array of users. :mem...@delete optional user(s) (name or URI) to remove from the group. Can also be an array of users. <anyproperty> optional Additional parameters will be stored/updated as node properties in the JCR <anyprope...@delete> optional Properties with @Delete at the end of the name will be deleted in the JCR Responses: 200 Success, a redirect is sent to the groups resource locator with HTML describing status. 404 Group was not found 500 Failure Example curl \-fanyproper...@delete \-Fproperty2=value2 -F ":member=/system/userManager/user/myuser" \ http://localhost:8080/system/userManager/group/mygroup.update.html Delete group To delete an existing group POST a request to /system/userManager/group/groupname.delete.html. The following parameters are available: parameter name required description :applyTo optional An array of relative resource references to groups to be deleted. If this parameter is present, the name of the group from the URL is ignored and all listed groups are removed. Responses: 200 Success, sent with no body. 404 Group(s) was/were not found 500 Failure. HTML explains failure. Example curl -Fgo=1 http://localhost:8080/system/userManager/group/mygroup.delete.html Automated Tests The launchpad/testing module contains test classes for various operations of the jackrabbit-usermanager. Such tests run as part of our continuous integration process, to demonstrate and verify the behavior of the various operations, in a way that's guaranteed to be in sync with the actual Sling core code. If you have an idea for additional tests, make sure to let us know! Change Notification Preferences View Online | View Change | Add Comment