Class Status
- java.lang.Object
-
- com.softlayer.api.Type
-
- com.softlayer.api.service.Entity
-
- com.softlayer.api.service.user.customer.Status
-
@ApiType("SoftLayer_User_Customer_Status") public class Status extends Entity
Each SoftLayer User Customer instance is assigned a status code that determines how it's treated in the customer portal. This status is reflected in the SoftLayer_User_Customer_Status data type. Status differs from user permissions in that user status applies globally to the portal while user permissions are applied to specific portal functions.
Note that a status of "PENDING" also has been added. This status is specific to users that are configured to use IBMid authentication. This would include some (not all) users on accounts that are linked to Platform Services (PaaS, formerly Bluemix) accounts, but is not limited to users in such accounts. Using IBMid authentication is optional for active users even if it is not required by the account type. PENDING status indicates that a relationship between an IBMid and a user is being set up but is not complete. To be complete, PENDING users need to perform an action ("accepting the invitation") before becoming an active user within IBM Cloud and/or IMS. PENDING is a system state, and can not be administered by users (including the account master user). SoftLayer Commercial is the only environment where IBMid and/or account linking are used.
- See Also:
- SoftLayer_User_Customer_Status
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
Status.Mask
static interface
Status.Service
A User's status.static interface
Status.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected Long
id
A user's status identifying number.protected boolean
idSpecified
protected String
keyName
A user's status keynameprotected boolean
keyNameSpecified
protected String
name
A user's status.protected boolean
nameSpecified
-
Fields inherited from class com.softlayer.api.Type
unknownProperties
-
-
Constructor Summary
Constructors Constructor Description Status()
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Status.Service
asService(ApiClient client)
Long
getId()
String
getKeyName()
String
getName()
boolean
isIdSpecified()
boolean
isKeyNameSpecified()
boolean
isNameSpecified()
static Status.Service
service(ApiClient client)
static Status.Service
service(ApiClient client, Long id)
void
setId(Long id)
void
setKeyName(String keyName)
void
setName(String name)
void
unsetId()
void
unsetKeyName()
void
unsetName()
-
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
-
-
-
Field Detail
-
id
@ApiProperty(canBeNullOrNotSet=true) protected Long id
A user's status identifying number.
-
idSpecified
protected boolean idSpecified
-
keyName
@ApiProperty(canBeNullOrNotSet=true) protected String keyName
A user's status keyname
-
keyNameSpecified
protected boolean keyNameSpecified
-
name
@ApiProperty(canBeNullOrNotSet=true) protected String name
A user's status. This can be either "Active" for user accounts with portal access, "Inactive" for users disabled by another portal user, "Disabled" for accounts turned off by SoftLayer, or "VPN Only" for user accounts with no access to the customer portal but VPN access to the private network.
-
nameSpecified
protected boolean nameSpecified
-
-
Method Detail
-
getId
public Long getId()
-
setId
public void setId(Long id)
-
isIdSpecified
public boolean isIdSpecified()
-
unsetId
public void unsetId()
-
getKeyName
public String getKeyName()
-
setKeyName
public void setKeyName(String keyName)
-
isKeyNameSpecified
public boolean isKeyNameSpecified()
-
unsetKeyName
public void unsetKeyName()
-
getName
public String getName()
-
setName
public void setName(String name)
-
isNameSpecified
public boolean isNameSpecified()
-
unsetName
public void unsetName()
-
asService
public Status.Service asService(ApiClient client)
-
service
public static Status.Service service(ApiClient client)
-
service
public static Status.Service service(ApiClient client, Long id)
-
-