( Return to API Overview )
Description
User namespace contains methods to access common user functions available from the web user interface.
Namespace:
user
Description:
Add system group to user's list of assigned system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- string serverGroupName
- boolean setDefault - Should system group also be added to user's list of default system groups.
Returns:
int - 1 on success.
Description:
Add system groups to user's list of assigned system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- array
- boolean setDefault - Should system groups also be added to user's list of default system groups.
Returns:
int - 1 on success.
Description:
Add system group to user's list of default system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- string serverGroupName
Returns:
int - 1 on success.
Description:
Add system groups to user's list of default system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- array
Returns:
int - 1 on success.
Description:
Adds a role to a user.
Parameters:
- string sessionKey
- string login - User login name to update.
- string role - Role label to add. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns:
int - 1 on success.
Description:
Create a new user.
Parameters:
- string sessionKey
- string desiredLogin - Desired login name, will fail if already in use.
- string desiredPassword
- string firstName
- string lastName
- string email - User's e-mail address.
Returns:
int - 1 on success.
Description:
Create a new user.
Parameters:
- string sessionKey
- string desiredLogin - Desired login name, will fail if already in use.
- string desiredPassword
- string firstName
- string lastName
- string email - User's e-mail address.
- int usePamAuth - 1 if you wish to use PAM authentication for this user, 0 otherwise.
Returns:
int - 1 on success.
Description:
Delete a user.
Parameters:
- string sessionKey
- string login - User login name to delete.
Returns:
int - 1 on success.
Description:
Disable a user.
Parameters:
- string sessionKey
- string login - User login name to disable.
Returns:
int - 1 on success.
Description:
Enable a user.
Parameters:
- string sessionKey
- string login - User login name to enable.
Returns:
int - 1 on success.
Description:
Returns the details about a given user.
Parameters:
- string sessionKey
- string login - User's login name.
Returns:
struct (user details) - string "first_names"
- string "last_name"
- string "email"
- string "prefix"
- string "last_login_date"
- string "created_date"
Description:
Returns the time user last logged in.
Parameters:
- string sessionKey
- string login - User's login name.
Returns:
dateTime.iso8601
Description:
Returns a list of user roles that this user can assign to others.
Parameters:
Returns:
array
Description:
Returns the system groups that a user can administer.
Parameters:
- string sessionKey
- string login - User's login name.
Returns:
array - struct (system group)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id" - Organization ID for this system group.
Description:
Returns a user's list of default system groups.
Parameters:
- string sessionKey
- string login - User's login name.
Returns:
array - struct (system group)
- int "id"
- string "name"
- string "description"
- int "system_count"
- int "org_id" - Organization ID for this system group.
Description:
Returns a list of the user's roles.
Parameters:
- string sessionKey
- string login - User's login name.
Returns:
array
Description:
Returns a list of users in your organization.
Parameters:
Returns:
array - struct (user)
- int "id"
- string "login" - User's login name.
- string "login_uc" - User's login name in uppercase.
Description:
Remove system group from the user's list of assigned system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- string serverGroupName
- boolean setDefault - Should system group also be removed from the user's list of default system groups.
Returns:
int - 1 on success.
Description:
Remove system groups from a user's list of assigned system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- array
- boolean setDefault - Should system groups also be removed from the user's list of default system groups.
Returns:
int - 1 on success.
Description:
Remove a system group from user's list of default system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- string serverGroupName
Returns:
int - 1 on success.
Description:
Remove system groups from a user's list of default system groups.
Parameters:
- string sessionKey
- string login - User's login name.
- array
Returns:
int - 1 on success.
Description:
Remove a role from a user.
Parameters:
- string sessionKey
- string login - User login name to update.
- string role - Role label to remove. Can be any of: satellite_admin, org_admin, channel_admin, config_admin, system_group_admin, activation_key_admin, or monitoring_admin.
Returns:
int 1 - on success.
Description:
Updates the details of a user.
Parameters:
- string sessionKey
- string login - User's login name to update.
- struct (user details)
- string "first_names"
- string "last_name"
- string "email"
- string "prefix"
- string "password"
Returns:
int - 1 on success.
Description:
Toggles whether or not a user uses PAM authentication or basic RHN authentication.
Parameters:
- string sessionKey
- string login - User's login name.
- int pam_value - 1 to enable PAM authentication, 0 to disable.
Returns:
int - 1 on success.