Package com.softlayer.api.service.user
Interface Customer.Service
- All Superinterfaces:
Maskable
,ResultLimitable
,Service
- All Known Subinterfaces:
OpenIdConnect.Service
- Enclosing class:
- Customer
@ApiService("SoftLayer_User_Customer") public static interface Customer.Service extends Service
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.
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.
- See Also:
- SoftLayer_User_Customer
-
Method Summary
Modifier and Type Method Description Void
acknowledgeSupportPolicy()
String
addApiAuthenticationKey()
Create a user's API authentication key, allowing that user access to query the SoftLayer API.Boolean
addBulkDedicatedHostAccess(List<Long> dedicatedHostIds)
Grants the user access to one or more dedicated host devices.Boolean
addBulkHardwareAccess(List<Long> hardwareIds)
Add multiple hardware to a portal user's hardware access list.Boolean
addBulkPortalPermission(List<Permission> permissions)
Add multiple permissions to a portal user's permission set.Void
addBulkRoles(List<Role> roles)
Boolean
addBulkVirtualGuestAccess(List<Long> virtualGuestIds)
Add multiple CloudLayer Computing Instances to a portal user's access list.Boolean
addDedicatedHostAccess(Long dedicatedHostId)
Grants the user access to a single dedicated host device.Binding
addExternalBinding(Binding externalBinding)
Boolean
addHardwareAccess(Long hardwareId)
Add hardware to a portal user's hardware access list.Boolean
addNotificationSubscriber(String notificationKeyName)
Create a notification subscription record for the user.Boolean
addPortalPermission(Permission permission)
Add a permission to a portal user's permission set.Void
addRole(Role role)
Boolean
addVirtualGuestAccess(Long virtualGuestId)
Add a CloudLayer Computing Instance to a portal user's access list.Customer.ServiceAsync
asAsync()
Get an async version of this serviceCustomer
assignNewParentId(Long parentId, Boolean cascadePermissionsFlag)
This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.List<Preference>
changePreference(String preferenceTypeKeyName, String value)
Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.Token
checkExternalAuthenticationStatus(Binding authenticationContainer)
This service checks the result of a previously requested external authentication.Boolean
checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)
Add a description here
Boolean
createNotificationSubscriber(String keyName, Long resourceTableId)
Create a new subscriber for a given resource.Customer
createObject(Customer templateObject, String password, String vpnPassword)
Create a new user in the SoftLayer customer portal.Boolean
createSubscriberDeliveryMethods(String notificationKeyName, List<String> deliveryMethodKeyNames)
Create delivery methods for a notification that the user is subscribed to.Boolean
deactivateNotificationSubscriber(String keyName, Long resourceTableId)
Create a new subscriber for a given resource.Boolean
editObject(Customer templateObject)
Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information.Boolean
editObjects(List<Customer> templateObjects)
Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information.List<Profile>
findUserPreference(String profileName, String containerKeyname, String preferenceKeyname)
Account
getAccount()
The customer account that a user belongs to.List<Action>
getActions()
List<Vendor>
getActiveExternalAuthenticationVendors()
The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against.List<AdditionalEmail>
getAdditionalEmails()
A portal user's additional email addresses.String
getAgentImpersonationToken()
List<Long>
getAllowedDedicatedHostIds()
List<Long>
getAllowedHardwareIds()
List<Long>
getAllowedVirtualGuestIds()
List<ApiAuthentication>
getApiAuthenticationKeys()
A portal user's API Authentication keys.Token
getAuthenticationToken(Token token)
List<Customer>
getChildUsers()
A portal user's child users.List<Ticket>
getClosedTickets()
An user's associated closed tickets.List<DedicatedHost>
getDedicatedHosts()
The dedicated hosts to which the user has been granted access.Account
getDefaultAccount(String providerType)
This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users.List<Binding>
getExternalBindings()
The external authentication bindings that link an external identifier to a SoftLayer user.List<Hardware>
getHardware()
A portal user's accessible hardware.Long
getHardwareCount()
Retrieve the number of servers that a portal user has access to.List<Hardware>
getHardwareNotifications()
Hardware notifications associated with this user.Boolean
getHasAcknowledgedSupportPolicyFlag()
Whether or not a user has acknowledged the support policy.Boolean
getHasFullDedicatedHostAccessFlag()
Permission granting the user access to all Dedicated Host devices on the account.Boolean
getHasFullHardwareAccessFlag()
Whether or not a portal user has access to all hardware on their account.Boolean
getHasFullVirtualGuestAccessFlag()
Whether or not a portal user has access to all hardware on their account.Link
getIbmIdLink()
String
getImpersonationToken()
List<Profile>
getLayoutProfiles()
Locale
getLocale()
A user's locale.List<Authentication>
getLoginAttempts()
A user's attempts to log into the SoftLayer customer portal.Common
getLoginToken(Contract request)
Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container.List<Account>
getMappedAccounts(String providerType)
An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account.List<MobileDevice>
getMobileDevices()
A portal user's associated mobile device profiles.List<Subscriber>
getNotificationSubscribers()
Notification subscription records for the user.Customer
getObject()
getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service.MigrationState
getOpenIdConnectMigrationState()
This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in.List<Ticket>
getOpenTickets()
An user's associated open tickets.List<Overrides>
getOverrides()
A portal user's vpn accessible subnets.Customer
getParent()
A portal user's parent user.PasswordSet
getPasswordRequirements(Boolean isVpn)
List<Permission>
getPermissions()
A portal user's permissions.Token
getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer)
Attempt to authenticate a username and password to the SoftLayer customer portal.Preference
getPreference(String preferenceTypeKeyName)
Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.List<Preference>
getPreferences()
List<Type>
getPreferenceTypes()
Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively.PasswordSet
getRequirementsForPasswordSet(PasswordSet passwordSet)
Retrieve the authentication requirements for an outstanding password set/reset request.List<Role>
getRoles()
Link
getSalesforceUserLink()
[DEPRECATED]List<Answer>
getSecurityAnswers()
A portal user's security question answers.List<Subscriber>
getSubscribers()
A user's notification subscription records.List<Authentication>
getSuccessfulLogins()
A user's successful attempts to log into the SoftLayer customer portal.List<Locale>
getSupportedLocales()
Long
getSupportPolicyAcknowledgementRequiredFlag()
Whether or not a user is required to acknowledge the support policy for portal access.byte[]
getSupportPolicyDocument()
String
getSupportPolicyName()
Boolean
getSurveyRequiredFlag()
Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.List<Survey>
getSurveys()
The surveys that a user has taken in the SoftLayer customer portal.List<Ticket>
getTickets()
An user's associated tickets.Timezone
getTimezone()
A portal user's time zone.List<Authentication>
getUnsuccessfulLogins()
A user's unsuccessful attempts to log into the SoftLayer customer portal.Long
getUserIdForPasswordSet(String key)
Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request.List<Link>
getUserLinks()
List<Profile>
getUserPreferences(String profileName, String containerKeyname)
Status
getUserStatus()
A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.Long
getVirtualGuestCount()
Retrieve the number of CloudLayer Computing Instances that a portal user has access to.List<Guest>
getVirtualGuests()
A portal user's accessible CloudLayer Computing Instances.String
initiateExternalAuthentication(Binding authenticationContainer)
The service initiates an external authentication with the given external authentication vendor.Boolean
initiatePortalPasswordChange(String username)
Sends password change email to the user containing url that allows the user the change their password.Boolean
initiatePortalPasswordChangeByBrandAgent(String username)
A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request.Boolean
inTerminalStatus()
Void
inviteUserToLinkOpenIdConnect(String providerType)
Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.Boolean
isMasterUser()
Portal users are considered master users if they don't have an associated parent user.Boolean
isValidPortalPassword(String password)
Determine if a string is the given user's login password to the SoftLayer customer portal.Token
performExternalAuthentication(Binding authenticationContainer)
The perform external authentication method will authenticate the given external authentication container with an external vendor.Boolean
processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)
Set the password for a user who has an outstanding password request.Boolean
removeAllDedicatedHostAccessForThisUser()
Revoke access to all dedicated hosts on the account for this user.Boolean
removeAllHardwareAccessForThisUser()
Remove all hardware from a portal user's hardware access list.Boolean
removeAllVirtualAccessForThisUser()
Remove all cloud computing instances from a portal user's instance access list.Boolean
removeApiAuthenticationKey(Long keyId)
Remove a user's API authentication key, removing that user's access to query the SoftLayer API.Boolean
removeBulkDedicatedHostAccess(List<Long> dedicatedHostIds)
Revokes access for the user to one or more dedicated host devices.Boolean
removeBulkHardwareAccess(List<Long> hardwareIds)
Remove multiple hardware from a portal user's hardware access list.Boolean
removeBulkPortalPermission(List<Permission> permissions, Boolean cascadePermissionsFlag)
Remove (revoke) multiple permissions from a portal user's permission set.Void
removeBulkRoles(List<Role> roles)
Boolean
removeBulkVirtualGuestAccess(List<Long> virtualGuestIds)
Remove multiple CloudLayer Computing Instances from a portal user's access list.Boolean
removeDedicatedHostAccess(Long dedicatedHostId)
Revokes access for the user to a single dedicated host device.Boolean
removeExternalBinding(Binding externalBinding)
Boolean
removeHardwareAccess(Long hardwareId)
Remove hardware from a portal user's hardware access list.Boolean
removePortalPermission(Permission permission, Boolean cascadePermissionsFlag)
Remove (revoke) a permission from a portal user's permission set.Void
removeRole(Role role)
Boolean
removeSecurityAnswers()
Boolean
removeVirtualGuestAccess(Long virtualGuestId)
Remove a CloudLayer Computing Instance from a portal user's access list.Token
samlAuthenticate(String accountId, String samlResponse)
String
samlBeginAuthentication(Long accountId)
String
samlBeginLogout()
Void
samlLogout(String samlResponse)
Void
selfPasswordChange(String currentPassword, String newPassword)
Account
setDefaultAccount(String providerType, Long accountId)
An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account.void
setMask(Customer.Mask mask)
Boolean
silentlyMigrateUserOpenIdConnect(String providerType)
As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid.Boolean
updateNotificationSubscriber(String notificationKeyName, Long active)
Update the active status for a notification that the user is subscribed to.Boolean
updateSecurityAnswers(List<Question> questions, List<String> answers)
Update a user's login security questions and answers on the SoftLayer customer portal.Boolean
updateSubscriberDeliveryMethod(String notificationKeyName, List<String> deliveryMethodKeyNames, Long active)
Update a delivery method for a notification that the user is subscribed to.Boolean
updateVpnPassword(String password)
Update a user's VPN password on the SoftLayer customer portal.Boolean
updateVpnUser()
Always call this function to enable changes when manually configuring VPN subnet access.Token
validateAuthenticationToken(Token authenticationToken)
Customer.Mask
withMask()
Use the existing mask on this service or create it if not presentCustomer.Mask
withNewMask()
Overwrite the existing mask on this service with a new one and return itMethods inherited from interface com.softlayer.api.ResultLimitable
getLastResponseTotalItemCount, getResultLimit, setResultLimit
-
Method Details
-
asAsync
Customer.ServiceAsync asAsync()Description copied from interface:Service
Get an async version of this service -
withNewMask
Customer.Mask withNewMask()Description copied from interface:Maskable
Overwrite the existing mask on this service with a new one and return it- Specified by:
withNewMask
in interfaceMaskable
-
withMask
Customer.Mask withMask()Description copied from interface:Maskable
Use the existing mask on this service or create it if not present -
setMask
-
acknowledgeSupportPolicy
-
addApiAuthenticationKey
Create a user's API authentication key, allowing that user access to query the SoftLayer API. addApiAuthenticationKey() returns the user's new API key. Each portal user is allowed only one API key. -
addBulkDedicatedHostAccess
Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.
Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. -
addBulkHardwareAccess
Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object.
Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. -
addBulkPortalPermission
Add multiple permissions to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user.
Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. -
addBulkRoles
- See Also:
- SoftLayer_User_Customer::addBulkRoles
-
addBulkVirtualGuestAccess
Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object.
Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. -
addDedicatedHostAccess
Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then "not found" exceptions are thrown if the user attempts to access any of these devices.
Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
Only the USER_MANAGE permission is required to execute this. -
addExternalBinding
-
addHardwareAccess
Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true.
Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
Only the USER_MANAGE permission is required to execute this. -
addNotificationSubscriber
Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive. -
addPortalPermission
Add a permission to a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true.
Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter. -
addRole
- See Also:
- SoftLayer_User_Customer::addRole
-
addVirtualGuestAccess
Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true.
Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
Only the USER_MANAGE permission is required to execute this. -
assignNewParentId
@ApiMethod(instanceRequired=true) Customer assignNewParentId(Long parentId, Boolean cascadePermissionsFlag)This method can be used in place of [[SoftLayer_User_Customer::editObject]] to change the parent user of this user.
The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent.
If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions. -
changePreference
@ApiMethod(instanceRequired=true) List<Preference> changePreference(String preferenceTypeKeyName, String value)Select a type of preference you would like to modify using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name. -
checkExternalAuthenticationStatus
This service checks the result of a previously requested external authentication. [[SoftLayer_Container_User_Customer_External_Binding_Phone|Phone external binding]] container can be used for this service. Make sure to set the [[SoftLayer_Container_User_Customer_External_Binding_Phone::authenticationToken|authenticationToken]] that is generated by [[SoftLayer_User_Customer|initiateExternalAuthentication]] service. -
checkPhoneFactorAuthenticationForPasswordSet
@ApiMethod(instanceRequired=true) Boolean checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)Add a description here
-
createNotificationSubscriber
@ApiMethod(instanceRequired=true) Boolean createNotificationSubscriber(String keyName, Long resourceTableId)Create a new subscriber for a given resource. -
createObject
Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access.
An account's master user and sub-users who have the User Manage permission can add new users.
Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access.
secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value.
Note, neither password nor vpnPassword parameters are required.
Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal.
If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password.
If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours. If the user fails to set their password within 24 hours, then a non-master user can use the "Reset Password" link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password.
The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users.
vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password. When creating a vpn only user, the vpnPassword MUST be supplied. If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword.
IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of the user to PaaS. The Platform Services "invite user" API call is asynchronous, and so no user object can be returned from this API call. In this specific case, this API will throw a SoftLayer_Exception_User_Customer_DelegateIamIdInvitationToPaas exception, with text indicating that the call was at least accepted by Platform Services. The Platform Services API is the preferred API for creating users based on IBMid in a linked account pair. If you have automation using this API that depends on getting a synchronous response with a user object with an id, you should contact SoftLayer Support to have the "IBMid authentication" trait set to 0 on this account. In that case, a normal SoftLayer user will be created (no IBMid association set up) and the createObject call will return synchronously as before.- See Also:
- SoftLayer_User_Customer::createObject
-
createSubscriberDeliveryMethods
@ApiMethod(instanceRequired=true) Boolean createSubscriberDeliveryMethods(String notificationKeyName, List<String> deliveryMethodKeyNames)Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. -
deactivateNotificationSubscriber
@ApiMethod(instanceRequired=true) Boolean deactivateNotificationSubscriber(String keyName, Long resourceTableId)Create a new subscriber for a given resource. -
editObject
Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.- See Also:
- SoftLayer_User_Customer::editObject
-
editObjects
Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.- See Also:
- SoftLayer_User_Customer::editObjects
-
findUserPreference
@ApiMethod(instanceRequired=true) List<Profile> findUserPreference(String profileName, String containerKeyname, String preferenceKeyname) -
getActiveExternalAuthenticationVendors
The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding. -
getAgentImpersonationToken
-
getAllowedDedicatedHostIds
-
getAllowedHardwareIds
-
getAllowedVirtualGuestIds
-
getAuthenticationToken
-
getDefaultAccount
This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users. -
getHardwareCount
Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the "administrative" then "user admin" links. -
getImpersonationToken
-
getLoginToken
Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.- See Also:
- SoftLayer_User_Customer::getLoginToken
-
getMappedAccounts
An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all the accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IBMid-authenticated users. -
getObject
getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service. You can only retrieve users that are assigned to the customer account belonging to the user making the API call.- See Also:
- SoftLayer_User_Customer::getObject
-
getOpenIdConnectMigrationState
This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown. -
getPasswordRequirements
-
getPortalLoginToken
@ApiMethod Token getPortalLoginToken(String username, String password, Long securityQuestionId, String securityQuestionAnswer)Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. If authentication is successful then the API returns a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication. -
getPreference
Select a type of preference you would like to get using [[SoftLayer_User_Customer::getPreferenceTypes|getPreferenceTypes]] and invoke this method using that preference type key name.- See Also:
- SoftLayer_User_Customer::getPreference
-
getPreferenceTypes
Use any of the preference types to fetch or modify user preferences using [[SoftLayer_User_Customer::getPreference|getPreference]] or [[SoftLayer_User_Customer::changePreference|changePreference]], respectively. -
getRequirementsForPasswordSet
@ApiMethod(instanceRequired=true) PasswordSet getRequirementsForPasswordSet(PasswordSet passwordSet)Retrieve the authentication requirements for an outstanding password set/reset request. The requirements returned in the same SoftLayer_Container_User_Customer_PasswordSet container which is provided as a parameter into this request. The SoftLayer_Container_User_Customer_PasswordSet::authenticationMethods array will contain an entry for each authentication method required for the user. See SoftLayer_Container_User_Customer_PasswordSet for more details.
If the user has required authentication methods, then authentication information will be supplied to the SoftLayer_User_Customer::processPasswordSetRequest method within this same SoftLayer_Container_User_Customer_PasswordSet container. All existing information in the container must continue to exist in the container to complete the password set/reset process. -
getSupportPolicyDocument
-
getSupportPolicyName
-
getSupportedLocales
-
getUserIdForPasswordSet
Retrieve a user id using a password token provided to the user in an email generated by the SoftLayer_User_Customer::initiatePortalPasswordChange request. Password recovery keys are valid for 24 hours after they're generated.
When a new user is created or when a user has requested a password change using initiatePortalPasswordChange, they will have received an email that contains a url with a token. That token is used as the parameter for getUserIdForPasswordSet. Once the user id is known, then the SoftLayer_User_Customer object can be retrieved which is necessary to complete the process to set or reset a user's password. -
getUserPreferences
@ApiMethod(instanceRequired=true) List<Profile> getUserPreferences(String profileName, String containerKeyname) -
getVirtualGuestCount
Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the "administrative" then "user admin" links. -
inTerminalStatus
-
initiateExternalAuthentication
The service initiates an external authentication with the given external authentication vendor. The authentication container and its content will be verified before an attempt is made to initiate an external authentication. [[SoftLayer_Container_User_Customer_External_Binding_Phone|Phone external binding]] container can be used for this service.
This service returns a unique authentication request token. You can use [[SoftLayer_User_Customer::checkExternalAuthenticationStatus|checkExternalAuthenticationStatus]] service to check if the authentication request is complete or not. -
initiatePortalPasswordChange
Sends password change email to the user containing url that allows the user the change their password. This is the first step when a user wishes to change their password. The url that is generated contains a one-time use token that is valid for only 24-hours.
If this is a new master user who has never logged into the portal, then password reset will be initiated. Once a master user has logged into the portal, they must setup their security questions prior to logging out because master users are required to answer a security question during the password reset process. Should a master user not have security questions defined and not remember their password in order to define the security questions, then they will need to contact support at live chat or Revenue Services for assistance.
Due to security reasons, the number of reset requests per username are limited within a undisclosed timeframe. -
initiatePortalPasswordChangeByBrandAgent
@ApiMethod(instanceRequired=true) Boolean initiatePortalPasswordChangeByBrandAgent(String username)A Brand Agent that has permissions to Add Customer Accounts will be able to request the password email be sent to the Master User of a Customer Account created by the same Brand as the agent making the request. Due to security reasons, the number of reset requests are limited within an undisclosed timeframe. -
inviteUserToLinkOpenIdConnect
Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error. -
isMasterUser
Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal.- See Also:
- SoftLayer_User_Customer::isMasterUser
-
isValidPortalPassword
Determine if a string is the given user's login password to the SoftLayer customer portal. -
performExternalAuthentication
The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor. -
processPasswordSetRequest
@ApiMethod(instanceRequired=true) Boolean processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)Set the password for a user who has an outstanding password request. A user with an outstanding password request will have an unused and unexpired password key. The password key is part of the url provided to the user in the email sent to the user with information on how to set their password. The email was generated by the SoftLayer_User_Customer::initiatePortalPasswordRequest request. Password recovery keys are valid for 24 hours after they're generated.
If the user has required authentication methods as specified by in the SoftLayer_Container_User_Customer_PasswordSet container returned from the SoftLayer_User_Customer::getRequirementsForPasswordSet request, then additional requests must be made to processPasswordSetRequest to authenticate the user before changing the password. First, if the user has security questions set on their profile, they will be required to answer one of their questions correctly. Next, if the user has Verisign, Google Authentication, or Phone Factor on their account, they must authenticate according to the two-factor provider. All of this authentication is done using the SoftLayer_Container_User_Customer_PasswordSet container. If the user has Phone Factor authentication, additional requests to SoftLayer_User_Customer::checkPhoneFactorAuthenticationForPasswordSet is required until a response other than Awaiting Response is received.
User portal passwords must match the following restrictions. Portal passwords must...
* ...be over eight characters long.
* ...be under twenty characters long.
* ...contain at least one uppercase letter
* ...contain at least one lowercase letter
* ...contain at least one number
* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ + =
* ...not match your username -
removeAllDedicatedHostAccessForThisUser
Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. -
removeAllHardwareAccessForThisUser
Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. -
removeAllVirtualAccessForThisUser
Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown.
Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account. -
removeApiAuthenticationKey
Remove a user's API authentication key, removing that user's access to query the SoftLayer API. -
removeBulkDedicatedHostAccess
@ApiMethod(instanceRequired=true) Boolean removeBulkDedicatedHostAccess(List<Long> dedicatedHostIds)Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.
Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
If the user has full dedicatedHost access, then it will provide access to "ALL but passed in" dedicatedHost ids. -
removeBulkHardwareAccess
Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true.
Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
If the user has full hardware access, then it will provide access to "ALL but passed in" hardware ids. -
removeBulkPortalPermission
@ApiMethod(instanceRequired=true) Boolean removeBulkPortalPermission(List<Permission> permissions, Boolean cascadePermissionsFlag)Remove (revoke) multiple permissions from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user.
Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account.
If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission.
If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.
Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter. -
removeBulkRoles
- See Also:
- SoftLayer_User_Customer::removeBulkRoles
-
removeBulkVirtualGuestAccess
Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true.
Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account. -
removeDedicatedHostAccess
Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then "not found" exceptions are thrown if the user attempts to access any of these devices.
Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. -
removeExternalBinding
-
removeHardwareAccess
Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true.
Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. -
removePortalPermission
@ApiMethod(instanceRequired=true) Boolean removePortalPermission(Permission permission, Boolean cascadePermissionsFlag)Remove (revoke) a permission from a portal user's permission set. [[SoftLayer_User_Customer_CustomerPermission_Permission]] control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true.
Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account.
If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission.
If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user.
Use the [[SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects]] method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter. -
removeRole
- See Also:
- SoftLayer_User_Customer::removeRole
-
removeSecurityAnswers
-
removeVirtualGuestAccess
Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns "not found" exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true.
Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account. -
samlAuthenticate
-
samlBeginAuthentication
-
samlBeginLogout
- See Also:
- SoftLayer_User_Customer::samlBeginLogout
-
samlLogout
- See Also:
- SoftLayer_User_Customer::samlLogout
-
selfPasswordChange
@ApiMethod(instanceRequired=true) Void selfPasswordChange(String currentPassword, String newPassword) -
setDefaultAccount
An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users. -
silentlyMigrateUserOpenIdConnect
As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail. -
updateNotificationSubscriber
@ApiMethod(instanceRequired=true) Boolean updateNotificationSubscriber(String notificationKeyName, Long active)Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription. -
updateSecurityAnswers
@ApiMethod(instanceRequired=true) Boolean updateSecurityAnswers(List<Question> questions, List<String> answers)Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers. -
updateSubscriberDeliveryMethod
@ApiMethod(instanceRequired=true) Boolean updateSubscriberDeliveryMethod(String notificationKeyName, List<String> deliveryMethodKeyNames, Long active)Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'. -
updateVpnPassword
Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN passwords must...
* ...be over eight characters long.
* ...be under twenty characters long.
* ...contain at least one uppercase letter
* ...contain at least one lowercase letter
* ...contain at least one number
* ...contain one of the special characters _ - | @ . , ? / ! ~ # $ % ^ & * ( ) { } [ ] \ =
* ...not match your username
Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords. -
updateVpnUser
Always call this function to enable changes when manually configuring VPN subnet access.- See Also:
- SoftLayer_User_Customer::updateVpnUser
-
validateAuthenticationToken
-
getAccount
The customer account that a user belongs to.- See Also:
- SoftLayer_User_Customer::getAccount
-
getActions
- See Also:
- SoftLayer_User_Customer::getActions
-
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. -
getChildUsers
A portal user's child users. Some portal users may not have child users.- See Also:
- SoftLayer_User_Customer::getChildUsers
-
getClosedTickets
An user's associated closed tickets. -
getDedicatedHosts
The dedicated hosts to which the user has been granted access. -
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.- See Also:
- SoftLayer_User_Customer::getHardware
-
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 hardware on their account. -
getIbmIdLink
- See Also:
- SoftLayer_User_Customer::getIbmIdLink
-
getLayoutProfiles
-
getLocale
A user's locale. Locale holds user's language and region information.- See Also:
- SoftLayer_User_Customer::getLocale
-
getLoginAttempts
A user's attempts to log into the SoftLayer customer portal. -
getMobileDevices
A portal user's associated mobile device profiles. -
getNotificationSubscribers
Notification subscription records for the user. -
getOpenTickets
An user's associated open tickets.- See Also:
- SoftLayer_User_Customer::getOpenTickets
-
getOverrides
A portal user's vpn accessible subnets.- See Also:
- SoftLayer_User_Customer::getOverrides
-
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.- See Also:
- SoftLayer_User_Customer::getParent
-
getPermissions
A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.- See Also:
- SoftLayer_User_Customer::getPermissions
-
getPreferences
- See Also:
- SoftLayer_User_Customer::getPreferences
-
getRoles
- See Also:
- SoftLayer_User_Customer::getRoles
-
getSalesforceUserLink
[DEPRECATED] -
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.- See Also:
- SoftLayer_User_Customer::getSubscribers
-
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. -
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.- See Also:
- SoftLayer_User_Customer::getSurveys
-
getTickets
An user's associated tickets.- See Also:
- SoftLayer_User_Customer::getTickets
-
getTimezone
A portal user's time zone.- See Also:
- SoftLayer_User_Customer::getTimezone
-
getUnsuccessfulLogins
A user's unsuccessful attempts to log into the SoftLayer customer portal. -
getUserLinks
- See Also:
- SoftLayer_User_Customer::getUserLinks
-
getUserStatus
A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.- See Also:
- SoftLayer_User_Customer::getUserStatus
-
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.
-