Namespace users
provides access to users
Defined in: rhqapi.js.
| Constructor Attributes | Constructor Name and Description |
|---|---|
| Method Attributes | Method Name and Description |
|---|---|
| <static> |
users.addUser(params, password)
Creates a new user acorrding to given parameters.
|
| <static> |
users.deleteUsers(userNames)
Deletes given user.
|
| <static> |
users.find(params)
Finds all users according to given parameters.
|
| <static> |
users.findUsers(params)
Finds all users according to given parameters.
|
| <static> |
users.getAllUsers()
Gets all available users.
|
| <static> |
users.getUser(userName)
Gets a given user.
|
| <static> |
users.printValidParams()
Prints all valid accepted parameters
|
Method Detail
<static>
{User}
users.addUser(params, password)
Creates a new user acorrding to given parameters.
users.addUser({firstName:"John",lastName:"Rambo",name:"jrambo",password:"passw",roles:["boss","admin"]);
- Parameters:
- {Object} params
- - see users.validParams for available params.
- {string} password
- Returns:
- {User} a newly created user
<static>
users.deleteUsers(userNames)
Deletes given user.
users.deleteUsers(["jrambo"]);
- Parameters:
- {String[]} userNames
- - array with names of users to delete
<static>
{Users[]}
users.find(params)
Finds all users according to given parameters.
- Parameters:
- {Object} params
- - see SubjectCriteria.addFilter[param] methods for available params
- Returns:
- Array of found users.
<static>
{Users[]}
users.findUsers(params)
Finds all users according to given parameters. (deprecated)
- Parameters:
- {Object} params
- - see SubjectCriteria.addFilter[param] methods for available params
- Returns:
- Array of found users.
<static>
{User[]}
users.getAllUsers()
Gets all available users.
- Returns:
- Array of found users.
<static>
{User}
users.getUser(userName)
Gets a given user. Returns found user or null.
- Parameters:
- {string} userName
- - name of the user
- Returns:
- {User} a found user or null
<static>
users.printValidParams()
Prints all valid accepted parameters