( Return to API Overview )

Description

User namespace contains methods to access common user functions available from the web user interface.

Namespace: user

Method: addAssignedSystemGroup

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, exception thrown otherwise.

Method: addAssignedSystemGroups

Description:
Add system groups to user's list of assigned system groups.

Parameters:

string sessionKey
string login - User's login name.
array:
- string - serverGroupName
boolean setDefault - Should system groups also be added to user's list of default system groups.

Returns:

int - 1 on success, exception thrown otherwise.

Method: addDefaultSystemGroup

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, exception thrown otherwise.

Method: addDefaultSystemGroups

Description:
Add system groups to user's list of default system groups.

Parameters:

string sessionKey
string login - User's login name.
array:
- string - serverGroupName

Returns:

int - 1 on success, exception thrown otherwise.

Method: addRole

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, exception thrown otherwise.

Method: create

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, exception thrown otherwise.

Method: create

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, exception thrown otherwise.

Method: delete

Description:
Delete a user.

Parameters:

string sessionKey
string login - User login name to delete.

Returns:

int - 1 on success, exception thrown otherwise.

Method: disable

Description:
Disable a user.

Parameters:

string sessionKey
string login - User login name to disable.

Returns:

int - 1 on success, exception thrown otherwise.

Method: enable

Description:
Enable a user.

Parameters:

string sessionKey
string login - User login name to enable.

Returns:

int - 1 on success, exception thrown otherwise.

Method: getDetails

Description:
Returns the details about a given user.

Parameters:

string sessionKey
string login - User's login name.

Returns:

struct - user details string "first_names" - deprecated, use first_name string "first_name" string "last_name" string "email" int "org_id" string "prefix" string "last_login_date" string "created_date" boolean "enabled" - true if user is enabled, false if the user is disabled boolean "use_pam" - true if user is configured to use PAM authentication

Method: getLoggedInTime

Description:
Returns the time user last logged in.

Parameters:

string sessionKey
string login - User's login name.

Returns:

dateTime.iso8601

Method: listAssignableRoles

Description:
Returns a list of user roles that this user can assign to others.

Parameters:

string sessionKey

Returns:

array: string - (role label)

Method: listAssignedSystemGroups

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.

Method: listDefaultSystemGroups

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.

Method: listRoles

Description:
Returns a list of the user's roles.

Parameters:

string sessionKey
string login - User's login name.

Returns:

array: string - (role label)

Method: listUsers

Description:
Returns a list of users in your organization.

Parameters:

string sessionKey

Returns:

array: struct - user int "id" string "login" string "login_uc" - upper case version of the login boolean "enabled" - true if user is enabled, false if the user is disabled

Method: removeAssignedSystemGroup

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, exception thrown otherwise.

Method: removeAssignedSystemGroups

Description:
Remove system groups from a user's list of assigned system groups.

Parameters:

string sessionKey
string login - User's login name.
array:
- string - serverGroupName
boolean setDefault - Should system groups also be removed from the user's list of default system groups.

Returns:

int - 1 on success, exception thrown otherwise.

Method: removeDefaultSystemGroup

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, exception thrown otherwise.

Method: removeDefaultSystemGroups

Description:
Remove system groups from a user's list of default system groups.

Parameters:

string sessionKey
string login - User's login name.
array:
- string - serverGroupName

Returns:

int - 1 on success, exception thrown otherwise.

Method: removeRole

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, exception thrown otherwise.

Method: setDetails

Description:
Updates the details of a user.

Parameters:

string sessionKey
string login - User's login name.
struct - user details
- string "first_names" - deprecated, use first_name
- string "first_name"
- string "last_name"
- string "email"
- string "prefix"
- string "password"

Returns:

int - 1 on success, exception thrown otherwise.

Method: usePamAuthentication

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, exception thrown otherwise.

Generated on 3/4/2013