SoftLayer_User_Customer


SoftLayer_User_Customer

Description

Every SoftLayer account has one or more portal users which are defined by the SoftLayer_User_Customer service. Every SoftLayer customer account has a master user account whose name corresponds to their account id preceded by the letters “SL”. Users exist in a parent-child relationship. Child users inherit the properties and permissions of their parent user while conversely a user may have more than one child users.

API users have full access to their own portal user account and they could also have access to other users under their SoftLayer customer account, if they have “Manage Users” permission in the customer portal.

There are two relational properties that contain the permissions assigned to a customer user; permissions and actions. These are simply two different representations of the same information. The permissions ORM key creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Customer_CustomerPermission_Permission objects which is populated from the same data source as the actions ORM key which creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Permission_Action objects.

Methods

addApiAuthenticationKey

Create a user’s API authentication key.

addBulkDedicatedHostAccess

Grant access to the user for one or more dedicated hosts devices.

addBulkHardwareAccess

Add multiple hardware to a portal user’s hardware access list.

addBulkPortalPermission

Add multiple permissions to a portal user’s permission set.

addBulkVirtualGuestAccess

Add multiple CloudLayer Computing Instances to a portal user’s access list.

addDedicatedHostAccess

Grant access to the user for a single dedicated host device.

addHardwareAccess

Add hardware to a portal user’s hardware access list.

addNotificationSubscriber

Create a notification subscription record for the user.

addPortalPermission

Add a permission to a portal user’s permission set.

addVirtualGuestAccess

Add a CloudLayer Computing Instance to a portal user’s access list.

assignNewParentId

Assign a different parent to this user.

changePreference

Change preference values for the current user

createNotificationSubscriber

Create a new subscriber for a given resource.

createObject

Create a new user record.

createSubscriberDeliveryMethods

Create delivery methods for the subscriber.

deactivateNotificationSubscriber

Delete a subscriber for a given resource.

editObject

Update a user’s information.

editObjects

Update a collection of users’ information

getAccount

The customer account that a user belongs to.

getActiveExternalAuthenticationVendors

Get a list of active external authentication vendors for a SoftLayer user.

getAdditionalEmails

A portal user’s additional email addresses. These email addresses are contacted when updates are made to support tickets.

getApiAuthenticationKeys

A portal user’s API Authentication keys. There is a max limit of one API key per user.

getAuthenticationToken

Generate a specific type of authentication token

getChildUsers

A portal user’s child users. Some portal users may not have child users.

getClosedTickets

An user’s associated closed tickets.

getDedicatedHosts

The dedicated hosts to which the user has been granted access.

getDefaultAccount

This method should never be invoked as it is not applicable to legacy SoftLayer-authenticated users. See SoftLayer_User_Customer_OpenIdConnect::getDefaultAccount instead.

getExternalBindings

The external authentication bindings that link an external identifier to a SoftLayer user.

getHardware

A portal user’s accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.

getHardwareCount

Retrieve the current number of servers a portal user has access to.

getHardwareNotifications

Hardware notifications associated with this user. A hardware notification links a user to a piece of hardware, and that user will be notified if any monitors on that hardware fail, if the monitors have a status of ‘Notify User’.

getHasAcknowledgedSupportPolicyFlag

Whether or not a user has acknowledged the support policy.

getHasFullDedicatedHostAccessFlag

Permission granting the user access to all Dedicated Host devices on the account.

getHasFullHardwareAccessFlag

Whether or not a portal user has access to all hardware on their account.

getHasFullVirtualGuestAccessFlag

Whether or not a portal user has access to all virtual guests on their account.

getIbmIdLink

Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.

getLayoutProfiles

Contains the definition of the layout profile.

getLocale

A user’s locale. Locale holds user’s language and region information.

getLoginAttempts

A user’s attempts to log into the SoftLayer customer portal.

getLoginToken

Authenticate a user for the SoftLayer customer portal

getMappedAccounts

Retrieve a list of all the accounts that belong to this customer.

getNotificationSubscribers

Notification subscription records for the user.

getObject

Retrieve a SoftLayer_User_Customer record.

getOpenIdConnectMigrationState

Get the OpenId migration state

getOpenTickets

An user’s associated open tickets.

getOverrides

A portal user’s vpn accessible subnets.

getParent

A portal user’s parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn’t have a parent user.

getPermissions

A portal user’s permissions. These permissions control that user’s access to functions within the SoftLayer customer portal and API.

getPortalLoginToken

Authenticate a user for the SoftLayer customer portal

getPreference

Get a preference value for the current user

getPreferenceTypes

Get all available preference types

getPreferences

Data type contains a single user preference to a specific preference type.

getRequirementsForPasswordSet

Retrieve the authentication requirements for a user when attempting

getSecurityAnswers

A portal user’s security question answers. Some portal users may not have security answers or may not be configured to require answering a security question on login.

getSubscribers

A user’s notification subscription records.

getSuccessfulLogins

A user’s successful attempts to log into the SoftLayer customer portal.

getSupportPolicyAcknowledgementRequiredFlag

Whether or not a user is required to acknowledge the support policy for portal access.

getSupportedLocales

Returns all supported locales for the current user

getSurveyRequiredFlag

Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.

getSurveys

The surveys that a user has taken in the SoftLayer customer portal.

getTickets

An user’s associated tickets.

getTimezone

A portal user’s time zone.

getUnsuccessfulLogins

A user’s unsuccessful attempts to log into the SoftLayer customer portal.

getUserIdForPasswordSet

Retrieve a user id using a password request key

getUserLinks

User customer link with IBMid and IAMid.

getUserStatus

A portal user’s status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.

getVirtualGuestCount

Retrieve the current number of CloudLayer Computing Instances a portal user has access to.

getVirtualGuests

A portal user’s accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.

initiatePortalPasswordChange

Request email to allow user to change their password

initiatePortalPasswordChangeByBrandAgent

Allows a Brand Agent to request password reset email to be sent to

inviteUserToLinkOpenIdConnect

Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.

isMasterUser

Determine if a portal user is a master user.

isValidPortalPassword

Determine if a string is a user’s portal password.

performExternalAuthentication

Perform an external authentication using the given authentication container.

processPasswordSetRequest

Set the password for a user who has a valid password request key

removeAllDedicatedHostAccessForThisUser

Revoke access to all dedicated hosts on the account for this user.

removeAllHardwareAccessForThisUser

Remove all hardware from a portal user’s hardware access list.

removeAllVirtualAccessForThisUser

Remove all cloud computing instances from a portal user’s instance access list.

removeApiAuthenticationKey

Remove a user’s API authentication key.

removeBulkDedicatedHostAccess

Revoke access for the user for one or more dedicated hosts devices.

removeBulkHardwareAccess

Remove multiple hardware from a portal user’s hardware access list.

removeBulkPortalPermission

Remove multiple permissions from a portal user’s permission set.

removeBulkVirtualGuestAccess

Remove multiple CloudLayer Computing Instances from a portal user’s access list.

removeDedicatedHostAccess

Revoke access for the user to a single dedicated hosts device.

removeExternalBinding

Remove an external binding from this user.

removeHardwareAccess

Remove hardware from a portal user’s hardware access list.

removePortalPermission

Remove a permission from a portal user’s permission set.

removeVirtualGuestAccess

Remove a CloudLayer Computing Instance from a portal user’s access list.

resetOpenIdConnectLink

Change the link of a user for OpenIdConnect managed accounts, provided the

resetOpenIdConnectLinkUnifiedUserManagementMode

Change the link of a master user for OpenIdConnect managed accounts,

setDefaultAccount

Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity.

silentlyMigrateUserOpenIdConnect

This api is used to migrate a user to IBMid without sending an invitation.

turnOffMasterUserPermissionCheckMode

De-activates the behavior that IMS permission checks for this user will be

turnOnMasterUserPermissionCheckMode

Activates the behavior that IMS permission checks for this user will be done as though

updateNotificationSubscriber

Update the active status for a notification subscription.

updateSecurityAnswers

Update portal login security questions and answers.

updateSubscriberDeliveryMethod

Update a delivery method for the subscriber.

updateVpnPassword

Update a user’s VPN password

updateVpnUser

Creates or updates a user’s VPN access privileges.

validateAuthenticationToken

Validate the user authentication token