powered by Jive Software

New userservice plugin

We internally updated the userservice plugin with a few changes (mainly maven addition) and the result it returns (XML) when adding/saving/updating users.

Just sharing back in case anyone can benefit:

Parameters

Name

Optional/Required

Description

type

Required

The admin service required. Possible values are add, delete, update

secret

Required

The secret key that allows access to the User Service.

username

Required

The username of the user to add, update or delete.

password

Required for add operation

The password of the new user or the user being updated.

name

Optional

The display name of the new user or the user being updated.

email

Optional

The email address of the new user or the user being updated.

groups

Optional

List of groups where the user is a member. Values are comma delimited.

Adding a user

http://gtms.gltd.net:9090/plugins/userService/userservice?type=add&secret=mysecr et&username=brian&password=mypassword&name=brian&email=brian.broker@example.com&username=brian&password=mypassword&name=brian&email=brian.broker@example.com

Deleting auser

http://gtms.gltd.net:9090/plugins/userService/userservice?type=delete&secret=mys ecret&username=brian

Updating auser

http://gtms.gltd.net:9090/plugins/userService/userservice?type=update&secret=mys ecret&username=brian&password=mypassword&name=brian&email=brian.broker@example.c om&username=brian&password=mypassword&name=brian&email=brian.broker@example.com

Response

Error

Description

IllegalArgumentException

One of the parameters passed to the User Service was bad.

UserNotFoundException

No user of the name specified, for a delete or update operation, exists on this server.

UserAlreadyExistsException

A user with the same name as the user about to be added, already exists.

RequestNotAuthorised

The supplied secret does not match the secret specified in the admin console.

UserServiceDisabled

The User Service is currently set to disabled in the admin console or the requester is not a valid IP address.