RetroSearch Browse

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Showing content from http://spacewalkproject.github.io/documentation/api/2.10/handlers/UserHandler.html below:

( Return to API Overview ) Available methods

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

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, or activation_key_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: getCreateDefaultSystemGroup 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:

string sessionKey

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 "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

Method: getLoggedInTime Description:
Returns the time user last logged in. Deprecated - Never returned usable value. 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, or activation_key_admin.

Returns:


 
  int - 1 on success, exception thrown otherwise.

Method: setCreateDefaultSystemGroup 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.

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: setErrataNotifications 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.

Method: setReadOnly 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.

Method: usePamAuthentication 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.

Generated on 3/4/2020

RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4