Class ApiAuthentication
java.lang.Object
com.softlayer.api.Type
com.softlayer.api.service.Entity
com.softlayer.api.service.user.customer.ApiAuthentication
@ApiType("SoftLayer_User_Customer_ApiAuthentication") public class ApiAuthentication extends Entity
The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s).
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
ApiAuthentication.Mask
static interface
ApiAuthentication.Service
An account's user may obtain access to SoftLayer's API through this authentication service.static interface
ApiAuthentication.ServiceAsync
-
Field Summary
Fields Modifier and Type Field Description protected String
authenticationKey
The user's authentication key for API access.protected boolean
authenticationKeySpecified
protected Long
id
The user's API authentication identifying number.protected boolean
idSpecified
protected String
ipAddressRestriction
The IP addresses or IP ranges from which this user may access the SoftLayer API.protected boolean
ipAddressRestrictionSpecified
protected Long
timestampKey
The user's authentication key modification date.protected boolean
timestampKeySpecified
protected Customer
user
The user who owns the api authentication key.protected Long
userId
The user's identifying number.protected boolean
userIdSpecified
Fields inherited from class com.softlayer.api.Type
unknownProperties
-
Constructor Summary
Constructors Constructor Description ApiAuthentication()
-
Method Summary
Modifier and Type Method Description ApiAuthentication.Service
asService(ApiClient client)
String
getAuthenticationKey()
Long
getId()
String
getIpAddressRestriction()
Long
getTimestampKey()
Customer
getUser()
Long
getUserId()
boolean
isAuthenticationKeySpecified()
boolean
isIdSpecified()
boolean
isIpAddressRestrictionSpecified()
boolean
isTimestampKeySpecified()
boolean
isUserIdSpecified()
static ApiAuthentication.Service
service(ApiClient client)
static ApiAuthentication.Service
service(ApiClient client, Long id)
void
setAuthenticationKey(String authenticationKey)
void
setId(Long id)
void
setIpAddressRestriction(String ipAddressRestriction)
void
setTimestampKey(Long timestampKey)
void
setUser(Customer user)
void
setUserId(Long userId)
void
unsetAuthenticationKey()
void
unsetId()
void
unsetIpAddressRestriction()
void
unsetTimestampKey()
void
unsetUserId()
Methods inherited from class com.softlayer.api.Type
getUnknownProperties, setUnknownProperties
-
Field Details
-
user
The user who owns the api authentication key. -
authenticationKey
The user's authentication key for API access. -
authenticationKeySpecified
protected boolean authenticationKeySpecified -
id
The user's API authentication identifying number. -
idSpecified
protected boolean idSpecified -
ipAddressRestriction
The IP addresses or IP ranges from which this user may access the SoftLayer API. Specify subnets in CIDR format and separate multiple addresses and subnets by commas. You may combine IPv4 and IPv6 addresses and subnets, for example: 192.168.0.0/16,fe80:021b::0/64. -
ipAddressRestrictionSpecified
protected boolean ipAddressRestrictionSpecified -
timestampKey
The user's authentication key modification date. -
timestampKeySpecified
protected boolean timestampKeySpecified -
userId
The user's identifying number. -
userIdSpecified
protected boolean userIdSpecified
-
-
Constructor Details
-
ApiAuthentication
public ApiAuthentication()
-
-
Method Details
-
getUser
-
setUser
-
getAuthenticationKey
-
setAuthenticationKey
-
isAuthenticationKeySpecified
public boolean isAuthenticationKeySpecified() -
unsetAuthenticationKey
public void unsetAuthenticationKey() -
getId
-
setId
-
isIdSpecified
public boolean isIdSpecified() -
unsetId
public void unsetId() -
getIpAddressRestriction
-
setIpAddressRestriction
-
isIpAddressRestrictionSpecified
public boolean isIpAddressRestrictionSpecified() -
unsetIpAddressRestriction
public void unsetIpAddressRestriction() -
getTimestampKey
-
setTimestampKey
-
isTimestampKeySpecified
public boolean isTimestampKeySpecified() -
unsetTimestampKey
public void unsetTimestampKey() -
getUserId
-
setUserId
-
isUserIdSpecified
public boolean isUserIdSpecified() -
unsetUserId
public void unsetUserId() -
asService
-
service
-
service
-