( Return to API Overview )

Available methods

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:

Returns:


Method: addAssignedSystemGroups

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

Parameters:

Returns:


Method: addDefaultSystemGroup

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

Parameters:

Returns:


Method: addDefaultSystemGroups

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

Parameters:

Returns:


Method: addRole

Description:
Adds a role to a user.

Parameters:

Returns:


Method: create

Description:
Create a new user.

Parameters:

Returns:


Method: create

Description:
Create a new user.

Parameters:

Returns:


Method: delete

Description:
Delete a user.

Parameters:

Returns:


Method: disable

Description:
Disable a user.

Parameters:

Returns:


Method: enable

Description:
Enable a user.

Parameters:

Returns:


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:

Returns:


Method: getDetails

Description:
Returns the details about a given user.

Parameters:

Returns:


Method: getLoggedInTime

Description:
Returns the time user last logged in.

Deprecated - Never returned usable value.

Parameters:

Returns:


Method: listAssignableRoles

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

Parameters:

Returns:


Method: listAssignedSystemGroups

Description:
Returns the system groups that a user can administer.

Parameters:

Returns:


Method: listDefaultSystemGroups

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

Parameters:

Returns:


Method: listRoles

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

Parameters:

Returns:


Method: listUsers

Description:
Returns a list of users in your organization.

Parameters:

Returns:


Method: removeAssignedSystemGroup

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

Parameters:

Returns:


Method: removeAssignedSystemGroups

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

Parameters:

Returns:


Method: removeDefaultSystemGroup

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

Parameters:

Returns:


Method: removeDefaultSystemGroups

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

Parameters:

Returns:


Method: removeRole

Description:
Remove a role from a user.

Parameters:

Returns:


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:

Returns:


Method: setDetails

Description:
Updates the details of a user.

Parameters:

Returns:


Method: setErrataNotifications

Description:
Enables/disables errata mail notifications for a specific user.

Parameters:

Returns:


Method: setReadOnly

Description:
Sets whether the target user should have only read-only API access or standard full scale access.

Parameters:

Returns:


Method: usePamAuthentication

Description:
Toggles whether or not a user uses PAM authentication or basic Satellite authentication.

Parameters:

Returns:


Generated on 3/4/2020