Skip to content


deleteUsers(userIds) Removes all the users with the given user ids. Will continue
upon removing users if an invalid id is specified.
@type userIds: List of Strings
@param userIds: (optional) list of ids to remove.
getUsers(**sort, **name, **keys, **start, **limit, **page, **dir) Retrieves a list of users. This method supports pagination.
@type start: integer
@param start: (optional) Offset to return the results from; used in
pagination (default: 0)
@type name: string
@param name: (optional) filter to be applied to users returned (default: None)
@type limit: integer
@param limit: (optional) Number of items to return; used in pagination
(default: 50)
@type sort: string
@param sort: (optional) Key on which to sort the return results (default:
@type dir: string
@param dir: (optional) Sort order; can be either 'ASC' or 'DESC'
(default: 'ASC')
@rtype: DirectResponse
@return: B{Properties}:
- data: (list) Dictionaries of user properties
- totalCount: (integer) Number of devices returned
addUser(name, password, email, **roles) Adds a new user to the system.
@type name: string
@param name: The unique identifier of the user, same as their login
@type password: string
@param password: the password of the new user
@type groups: list of strings
@param groups: (optional) groups to be applied to the new user
@type roles: list of strings
@param roles: (optional) roles to be applied to the new user
@rtype: DirectResponse
@return: B{Properties}:
- data: properties of the new users