( Return to API Overview )
- addAssignedSystemGroup
- addAssignedSystemGroups
- addDefaultSystemGroup
- addDefaultSystemGroups
- addRole
- create
- create
- delete
- disable
- enable
- getCreateDefaultSystemGroup
- getDetails
- getLoggedInTime
- listAssignableRoles
- listAssignedSystemGroups
- listDefaultSystemGroups
- listRoles
- listUsers
- removeAssignedSystemGroup
- removeAssignedSystemGroups
- removeDefaultSystemGroup
- removeDefaultSystemGroups
- removeRole
- setCreateDefaultSystemGroup
- setDetails
- setErrataNotifications
- setReadOnly
- usePamAuthentication
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, exception thrown otherwise.
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, exception thrown otherwise.
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.
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, exception thrown otherwise.
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, or
activation_key_admin.
Returns:
-
int - 1 on success, exception thrown otherwise.
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.
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.
Description:
Delete a user.
Parameters:
-
string sessionKey
-
string login - User login name to delete.
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Disable a user.
Parameters:
-
string sessionKey
-
string login - User login name to disable.
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Enable a user.
Parameters:
-
string sessionKey
-
string login - User login name to enable.
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Returns the current value of the CreateDefaultSystemGroup setting.
If True this will cause there to be a system group created (with the same name
as the user) every time a new user is created, with the user automatically given
permission to that system group and the system group being set as the default
group for the user (so every time the user registers a system it will be
placed in that system group by default). This can be useful if different
users will administer different groups of servers in the same organization.
Can only be called by an org_admin.
Parameters:
Returns:
-
int - 1 on success, exception thrown otherwise.
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 "org_name"
- 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
- boolean "read_only" - true if user is readonly
- boolean "errata_notification" - true if errata e-mail notification
is enabled for the user
Description:
Returns the time user last logged in.
Deprecated - Never returned usable value.
Parameters:
-
string sessionKey
-
string login - User's login name.
Returns:
Description:
Returns a list of user roles that this user can assign to others.
Parameters:
Returns:
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:
Description:
Returns a list of users in your organization.
Parameters:
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
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.
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, exception thrown otherwise.
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.
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, exception thrown otherwise.
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, or
activation_key_admin.
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Sets the value of the CreateDefaultSystemGroup setting.
If True this will cause there to be a system group created (with the same name
as the user) every time a new user is created, with the user automatically given
permission to that system group and the system group being set as the default
group for the user (so every time the user registers a system it will be
placed in that system group by default). This can be useful if different
users will administer different groups of servers in the same organization.
Can only be called by an org_admin.
Parameters:
-
string sessionKey
-
boolean createDefaultSystemGruop - True if we should automatically create system groups, false otherwise.
Returns:
-
int - 1 on success, exception thrown otherwise.
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.
Description:
Enables/disables errata mail notifications for a specific user.
Parameters:
-
string sessionKey
-
string login - User's login name.
-
boolean value - True for enabling
errata notifications, False for disabling
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Sets whether the target user should have only read-only API access or
standard full scale access.
Parameters:
-
string sessionKey
-
string login - User's login name.
-
boolean readOnly - Sets whether the target user should
have only read-only API access or standard full scale access.
Returns:
-
int - 1 on success, exception thrown otherwise.
Description:
Toggles whether or not a user uses PAM authentication or
basic Satellite 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.