Package com.softlayer.api.service.user.customer.openidconnect

Interface TrustedProfile.Service

All Superinterfaces:

Customer.Service, Maskable, OpenIdConnect.Service, ResultLimitable, Service

Enclosing class:

TrustedProfile

@ApiService("SoftLayer_User_Customer_OpenIdConnect_TrustedProfile")
public static interface TrustedProfile.Service
extends OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile

Method Summary

Modifier and Type	Method	Description
String	addApiAuthenticationKeyForTrustedProfile()	Create a user's API authentication key, allowing that user access to query the SoftLayer API.
Binding	addExternalBinding(Binding externalBinding)
TrustedProfile.ServiceAsync	asAsync()	Get an async version of this service
Boolean	checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer)	Add a description here
TrustedProfile	createObject(TrustedProfile templateObject, String password, String vpnPassword)
TrustedProfile	getObjectForTrustedProfile()
Token	getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer)	Deprecated.
PasswordSet	getRequirementsForPasswordSetForTrustedProfile(PasswordSet passwordSet)	Retrieve the authentication requirements for an outstanding password set/reset request.
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.
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	isValidPortalPassword(String password)	Determine if a string is the given user's login password to the SoftLayer customer portal.
Boolean	processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer)	Set the password for a user who has an outstanding password request.
void	setMask(TrustedProfile.Mask mask)
Boolean	updateVpnUserForTrustedProfile()	Always call this function to enable changes when manually configuring VPN subnet access.
TrustedProfile.Mask	withMask()	Use the existing mask on this service or create it if not present
TrustedProfile.Mask	withNewMask()	Overwrite the existing mask on this service with a new one and return it

Methods inherited from interface com.softlayer.api.service.user.Customer.Service

acknowledgeSupportPolicy, addApiAuthenticationKey, addBulkDedicatedHostAccess, addBulkHardwareAccess, addBulkPortalPermission, addBulkRoles, addBulkVirtualGuestAccess, addDedicatedHostAccess, addHardwareAccess, addNotificationSubscriber, addPortalPermission, addRole, addVirtualGuestAccess, assignNewParentId, changePreference, checkExternalAuthenticationStatus, createNotificationSubscriber, createObject, createSubscriberDeliveryMethods, deactivateNotificationSubscriber, editObject, editObjects, findUserPreference, getAccount, getActions, getActiveExternalAuthenticationVendors, getAdditionalEmails, getAgentImpersonationToken, getAllowedDedicatedHostIds, getAllowedHardwareIds, getAllowedVirtualGuestIds, getApiAuthenticationKeys, getAuthenticationToken, getChildUsers, getClosedTickets, getDedicatedHosts, getExternalBindings, getHardware, getHardwareCount, getHardwareNotifications, getHasAcknowledgedSupportPolicyFlag, getHasFullDedicatedHostAccessFlag, getHasFullHardwareAccessFlag, getHasFullVirtualGuestAccessFlag, getIbmIdLink, getImpersonationToken, getLayoutProfiles, getLocale, getLoginAttempts, getLoginToken, getMobileDevices, getNotificationSubscribers, getObject, getOpenIdConnectMigrationState, getOpenTickets, getOverrides, getParent, getPasswordRequirements, getPermissions, getPortalLoginToken, getPreference, getPreferences, getPreferenceTypes, getRequirementsForPasswordSet, getRoles, getSalesforceUserLink, getSecurityAnswers, getSubscribers, getSuccessfulLogins, getSupportedLocales, getSupportPolicyAcknowledgementRequiredFlag, getSupportPolicyDocument, getSupportPolicyName, getSurveyRequiredFlag, getSurveys, getTickets, getTimezone, getUnsuccessfulLogins, getUserLinks, getUserPreferences, getUserStatus, getVirtualGuestCount, getVirtualGuests, initiateExternalAuthentication, inTerminalStatus, inviteUserToLinkOpenIdConnect, isMasterUser, performExternalAuthentication, removeAllDedicatedHostAccessForThisUser, removeAllHardwareAccessForThisUser, removeAllVirtualAccessForThisUser, removeApiAuthenticationKey, removeBulkDedicatedHostAccess, removeBulkHardwareAccess, removeBulkPortalPermission, removeBulkRoles, removeBulkVirtualGuestAccess, removeDedicatedHostAccess, removeExternalBinding, removeHardwareAccess, removePortalPermission, removeRole, removeSecurityAnswers, removeVirtualGuestAccess, resetOpenIdConnectLink, resetOpenIdConnectLinkUnifiedUserManagementMode, samlAuthenticate, samlBeginAuthentication, samlBeginLogout, samlLogout, setMask, silentlyMigrateUserOpenIdConnect, updateNotificationSubscriber, updateSecurityAnswers, updateSubscriberDeliveryMethod, updateVpnPassword, updateVpnUser, validateAuthenticationToken

Methods inherited from interface com.softlayer.api.Maskable

clearMask, setMask, setMask

Methods inherited from interface com.softlayer.api.service.user.customer.OpenIdConnect.Service

activateOpenIdConnectUser, completeInvitationAfterLogin, createObject, createOpenIdConnectUserAndCompleteInvitation, declineInvitation, getDefaultAccount, getLoginAccountInfoOpenIdConnect, getMappedAccounts, getObjectForOpenIdConnect, getOpenIdRegistrationInfoFromCode, getRequirementsForPasswordSetForOpenIdConnect, getUserForUnifiedInvitation, selfPasswordChange, setDefaultAccount, setMask

Methods inherited from interface com.softlayer.api.ResultLimitable

getLastResponseTotalItemCount, getResultLimit, setResultLimit

Method Detail

asAsync

TrustedProfile.ServiceAsync asAsync()

Description copied from interface: Service

Get an async version of this service

Specified by:

asAsync in interface Customer.Service

Specified by:

asAsync in interface OpenIdConnect.Service

Specified by:

asAsync in interface Service

withNewMask

TrustedProfile.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 interface Customer.Service

Specified by:

withNewMask in interface Maskable

Specified by:

withNewMask in interface OpenIdConnect.Service

withMask

TrustedProfile.Mask withMask()

Description copied from interface: Maskable

Use the existing mask on this service or create it if not present

Specified by:

withMask in interface Customer.Service

Specified by:

withMask in interface Maskable

Specified by:

withMask in interface OpenIdConnect.Service

setMask

void setMask(TrustedProfile.Mask mask)

addApiAuthenticationKeyForTrustedProfile

@ApiMethod(value="addApiAuthenticationKey",
           instanceRequired=true)
String addApiAuthenticationKeyForTrustedProfile()

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.

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addApiAuthenticationKey

addExternalBinding

@ApiMethod(instanceRequired=true)
Binding addExternalBinding(Binding externalBinding)

Specified by:

addExternalBinding in interface Customer.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addExternalBinding

checkPhoneFactorAuthenticationForPasswordSet

@ApiMethod(instanceRequired=true)
Boolean checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet,
                                                     Binding authenticationContainer)

Add a description here

Specified by:

checkPhoneFactorAuthenticationForPasswordSet in interface Customer.Service

Specified by:

checkPhoneFactorAuthenticationForPasswordSet in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::checkPhoneFactorAuthenticationForPasswordSet

createObject

@ApiMethod
TrustedProfile createObject(TrustedProfile templateObject,
                            String password,
                            String vpnPassword)

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createObject

getObjectForTrustedProfile

@ApiMethod(value="getObject",
           instanceRequired=true)
TrustedProfile getObjectForTrustedProfile()

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getObject

getPortalLoginTokenOpenIdConnect

@Deprecated
@ApiMethod
Token getPortalLoginTokenOpenIdConnect(String providerType,
                                       String accessToken,
                                       Long accountId,
                                       Long securityQuestionId,
                                       String securityQuestionAnswer)

Deprecated.

Attempt to authenticate a supplied OpenIdConnect access token to the SoftLayer customer portal. 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.

Specified by:

getPortalLoginTokenOpenIdConnect in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPortalLoginTokenOpenIdConnect

getRequirementsForPasswordSetForTrustedProfile

@ApiMethod(value="getRequirementsForPasswordSet",
           instanceRequired=true)
PasswordSet getRequirementsForPasswordSetForTrustedProfile(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.

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getRequirementsForPasswordSet

getUserIdForPasswordSet

@ApiMethod
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. 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.

Specified by:

getUserIdForPasswordSet in interface Customer.Service

Specified by:

getUserIdForPasswordSet in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserIdForPasswordSet

initiatePortalPasswordChange

@ApiMethod
Boolean initiatePortalPasswordChange(String username)

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.

Specified by:

initiatePortalPasswordChange in interface Customer.Service

Specified by:

initiatePortalPasswordChange in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChange

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.

Specified by:

initiatePortalPasswordChangeByBrandAgent in interface Customer.Service

Specified by:

initiatePortalPasswordChangeByBrandAgent in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChangeByBrandAgent

isValidPortalPassword

@ApiMethod(instanceRequired=true)
Boolean isValidPortalPassword(String password)

Determine if a string is the given user's login password to the SoftLayer customer portal.

Specified by:

isValidPortalPassword in interface Customer.Service

Specified by:

isValidPortalPassword in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::isValidPortalPassword

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

Specified by:

processPasswordSetRequest in interface Customer.Service

Specified by:

processPasswordSetRequest in interface OpenIdConnect.Service

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::processPasswordSetRequest

updateVpnUserForTrustedProfile

@ApiMethod(value="updateVpnUser",
           instanceRequired=true)
Boolean updateVpnUserForTrustedProfile()

Always call this function to enable changes when manually configuring VPN subnet access.

See Also:

SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateVpnUser