com.softlayer.api.service.user.customer.openidconnect.TrustedProfile Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of softlayer-api-client Show documentation
Show all versions of softlayer-api-client Show documentation
API client for accessing the SoftLayer API
The newest version!
package com.softlayer.api.service.user.customer.openidconnect;
import com.softlayer.api.ApiClient;
import com.softlayer.api.ResponseHandler;
import com.softlayer.api.annotation.ApiMethod;
import com.softlayer.api.annotation.ApiType;
import com.softlayer.api.service.container.user.customer.PasswordSet;
import com.softlayer.api.service.container.user.customer.external.Binding;
import com.softlayer.api.service.container.user.customer.portal.Token;
import com.softlayer.api.service.user.customer.OpenIdConnect;
import java.util.concurrent.Future;
/**
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
*/
@ApiType("SoftLayer_User_Customer_OpenIdConnect_TrustedProfile")
public class TrustedProfile extends OpenIdConnect {
public Service asService(ApiClient client) {
return service(client, id);
}
public static Service service(ApiClient client) {
return client.createService(Service.class, null);
}
public static Service service(ApiClient client, Long id) {
return client.createService(Service.class, id == null ? null : id.toString());
}
/**
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
*/
@com.softlayer.api.annotation.ApiService("SoftLayer_User_Customer_OpenIdConnect_TrustedProfile")
public static interface Service extends OpenIdConnect.Service {
public ServiceAsync asAsync();
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* 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 SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addApiAuthenticationKey
*/
@ApiMethod(value = "addApiAuthenticationKey", instanceRequired = true)
public String addApiAuthenticationKeyForTrustedProfile();
/**
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::addExternalBinding
*/
@ApiMethod(instanceRequired = true)
public com.softlayer.api.service.user.customer.external.Binding addExternalBinding(com.softlayer.api.service.user.external.Binding externalBinding);
/**
* Add a description here
*
*
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::checkPhoneFactorAuthenticationForPasswordSet
*/
@ApiMethod(instanceRequired = true)
public Boolean checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer);
/**
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::createObject
*/
@ApiMethod
public TrustedProfile createObject(TrustedProfile templateObject, String password, String vpnPassword);
/**
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getObject
*/
@ApiMethod(value = "getObject", instanceRequired = true)
public TrustedProfile getObjectForTrustedProfile();
/**
* 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.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getPortalLoginTokenOpenIdConnect
*/
@Deprecated
@ApiMethod
public Token getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer);
/**
* 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 SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getRequirementsForPasswordSet
*/
@ApiMethod(value = "getRequirementsForPasswordSet", instanceRequired = true)
public PasswordSet getRequirementsForPasswordSetForTrustedProfile(PasswordSet passwordSet);
/**
* 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.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::getUserIdForPasswordSet
*/
@ApiMethod
public Long getUserIdForPasswordSet(String key);
/**
* 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.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChange
*/
@ApiMethod
public Boolean initiatePortalPasswordChange(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.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::initiatePortalPasswordChangeByBrandAgent
*/
@ApiMethod(instanceRequired = true)
public Boolean initiatePortalPasswordChangeByBrandAgent(String username);
/**
* Determine if a string is the given user's login password to the SoftLayer customer portal.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::isValidPortalPassword
*/
@ApiMethod(instanceRequired = true)
public Boolean isValidPortalPassword(String password);
/**
* 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
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::processPasswordSetRequest
*/
@ApiMethod(instanceRequired = true)
public Boolean processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer);
/**
* Always call this function to enable changes when manually configuring VPN subnet access.
*
* @see SoftLayer_User_Customer_OpenIdConnect_TrustedProfile::updateVpnUser
*/
@ApiMethod(value = "updateVpnUser", instanceRequired = true)
public Boolean updateVpnUserForTrustedProfile();
}
public static interface ServiceAsync extends OpenIdConnect.ServiceAsync {
public Mask withNewMask();
public Mask withMask();
public void setMask(Mask mask);
/**
* Async version of {@link Service#addApiAuthenticationKeyForTrustedProfile}
*/
public Future addApiAuthenticationKeyForTrustedProfile();
public Future addApiAuthenticationKeyForTrustedProfile(ResponseHandler callback);
/**
* Async version of {@link Service#addExternalBinding}
*/
public Future addExternalBinding(com.softlayer.api.service.user.external.Binding externalBinding);
public Future addExternalBinding(com.softlayer.api.service.user.external.Binding externalBinding, ResponseHandler callback);
/**
* Async version of {@link Service#checkPhoneFactorAuthenticationForPasswordSet}
*/
public Future checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer);
public Future checkPhoneFactorAuthenticationForPasswordSet(PasswordSet passwordSet, Binding authenticationContainer, ResponseHandler callback);
/**
* Async version of {@link Service#createObject}
*/
public Future createObject(TrustedProfile templateObject, String password, String vpnPassword);
public Future createObject(TrustedProfile templateObject, String password, String vpnPassword, ResponseHandler callback);
/**
* Async version of {@link Service#getObjectForTrustedProfile}
*/
public Future getObjectForTrustedProfile();
public Future getObjectForTrustedProfile(ResponseHandler callback);
/**
* Async version of {@link Service#getPortalLoginTokenOpenIdConnect}
*/
@Deprecated
public Future getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer);
@Deprecated
public Future getPortalLoginTokenOpenIdConnect(String providerType, String accessToken, Long accountId, Long securityQuestionId, String securityQuestionAnswer, ResponseHandler callback);
/**
* Async version of {@link Service#getRequirementsForPasswordSetForTrustedProfile}
*/
public Future getRequirementsForPasswordSetForTrustedProfile(PasswordSet passwordSet);
public Future getRequirementsForPasswordSetForTrustedProfile(PasswordSet passwordSet, ResponseHandler callback);
/**
* Async version of {@link Service#getUserIdForPasswordSet}
*/
public Future getUserIdForPasswordSet(String key);
public Future getUserIdForPasswordSet(String key, ResponseHandler callback);
/**
* Async version of {@link Service#initiatePortalPasswordChange}
*/
public Future initiatePortalPasswordChange(String username);
public Future initiatePortalPasswordChange(String username, ResponseHandler callback);
/**
* Async version of {@link Service#initiatePortalPasswordChangeByBrandAgent}
*/
public Future initiatePortalPasswordChangeByBrandAgent(String username);
public Future initiatePortalPasswordChangeByBrandAgent(String username, ResponseHandler callback);
/**
* Async version of {@link Service#isValidPortalPassword}
*/
public Future isValidPortalPassword(String password);
public Future isValidPortalPassword(String password, ResponseHandler callback);
/**
* Async version of {@link Service#processPasswordSetRequest}
*/
public Future processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer);
public Future processPasswordSetRequest(PasswordSet passwordSet, Binding authenticationContainer, ResponseHandler callback);
/**
* Async version of {@link Service#updateVpnUserForTrustedProfile}
*/
public Future updateVpnUserForTrustedProfile();
public Future updateVpnUserForTrustedProfile(ResponseHandler callback);
}
public static class Mask extends com.softlayer.api.service.user.customer.OpenIdConnect.Mask {
}
}