SoftLayer User Customer (type)

From SoftLayer Development Network Wiki

This page refers to the SoftLayer_User_Customer data type. For information on the SoftLayer_User_Customer service please see SoftLayer_User_Customer.

Contents 1 Overview 2 Local Properties 2.1 accountId 2.2 address1 2.3 address2 2.4 aim 2.5 alternatePhone 2.6 city 2.7 companyName 2.8 country 2.9 createDate 2.10 daylightSavingsTimeFlag 2.11 email 2.12 firstName 2.13 forumPasswordHash 2.14 icq 2.15 id 2.16 ipAddressRestriction 2.17 lastName 2.18 modifyDate 2.19 msn 2.20 officePhone 2.21 parentId 2.22 passwordExpireDate 2.23 postalCode 2.24 pptpVpnAllowedFlag 2.25 secondaryLoginManagementFlag 2.26 secondaryLoginRequiredFlag 2.27 secondaryPasswordModifyDate 2.28 secondaryPasswordTimeoutDays 2.29 sms 2.30 sslVpnAllowedFlag 2.31 state 2.32 statusDate 2.33 timezoneId 2.34 userStatusId 2.35 username 2.36 yahoo 3 Relational Properties 3.1 account 3.2 additionalEmails 3.3 apiAuthenticationKeys 3.4 cdnAccounts 3.5 childUsers 3.6 hardware 3.7 hardwareNotifications 3.8 hasFullHardwareAccessFlag 3.9 parent 3.10 permissions 3.11 securityAnswers 3.12 surveyRequiredFlag 3.13 surveys 3.14 timezone 3.15 userStatus 4 Count Properties 4.1 additionalEmailCount 4.2 apiAuthenticationKeyCount 4.3 cdnAccountCount 4.4 childUserCount 4.5 hardwareCount 4.6 hardwareNotificationCount 4.7 permissionCount 4.8 securityAnswerCount 4.9 surveyCount 5 Associated Methods

Overview

The SoftLayer_User_Customer data type contains general information relating to a single SoftLayer customer portal user. Personal information in this type such as names, addresses, and phone numbers are not necessarily associated with the customer account the user is assigned to.

Warning! Even though our API is object based, XML-RPC can only return data as array values. The SOAP implementation treats data as object properties.

Local Properties

accountId

A portal user's associated customer account id.

• Type: integer
• Length: 10 digits

---

address1

The first line of the mailing address belonging to a portal user.

• Type: string
• Length: 100 characters

---

address2

The second line of the mailing address belonging to a portal user.

• Type: string
• Length: 100 characters

---

aim

A portal user's AOL Instant Messenger screen name.

• Type: string
• Length: 100 characters

---

alternatePhone

A portal user's secondary phone number.

• Type: string
• Length: 20 characters

---

city

The city of the mailing address belonging to a portal user.

• Type: string
• Length: 100 characters

---

companyName

A portal user's associated company. This may not be the same company as the customer that owns this portal user.

• Type: string
• Length: 100 characters

---

country

A two-letter abbreviation of the country in the mailing address belonging to a portal user.

• Type: string
• Length: 2 characters

---

createDate

The date a portal user's record was created.

• Type: dateTime

---

daylightSavingsTimeFlag

Whether a portal user's time zone is affected by Daylight Savings Time.

• Type: boolean

---

email

A portal user's email address.

• Type: string
• Length: 100 characters

---

firstName

A portal user's first name.

• Type: string
• Length: 30 characters

---

forumPasswordHash

A user's password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal

• Type: string

---

icq

A portal user's ICQ UIN.

• Type: string
• Length: 100 characters

---

id

A portal user's internal identifying number.

• Type: integer

---

ipAddressRestriction

The IP address or IP range from which a single user can login to the SoftLayer customer portal. Class C range of IP addresses the user may log in from are specified by the first three octets of that IP range.

• Type: string
• Length: 16 characters

---

lastName

A portal user's last name.

• Type: string
• Length: 30 characters

---

modifyDate

The date a portal user's record was last modified.

• Type: dateTime

---

msn

A portal user's MSN address.

• Type: string
• Length: 100 characters

---

officePhone

A portal user's office phone number.

• Type: string
• Length: 20 characters

---

parentId

A portal user's parent user. Id a users parentId is null then it doesn't have a parent user in the customer portal.

• Type: integer
• Length: 10 digits

---

passwordExpireDate

The expiration date for the user's password

• Type: dateTime

---

postalCode

The postal code of the mailing address belonging to an portal user.

• Type: string
• Length: 50 characters

---

pptpVpnAllowedFlag

Whether a portal user may connect to the SoftLayer private network via PPTP VPN or not.

• Type: boolean

---

secondaryLoginManagementFlag

Whether a user may change their security options (IP restriction, password expiration, or enforce security questions on login) which were pre-selected by their account's master user.

• Type: boolean

---

secondaryLoginRequiredFlag

Whether a user is required to answer a security question when logging into the SoftLayer customer portal.

• Type: boolean

---

secondaryPasswordModifyDate

The date when a user's password was last updated.

• Type: dateTime

---

secondaryPasswordTimeoutDays

The number of days for which a user's password is active.

• Type: integer
• Length: 8 digits

---

sms

A phone number that can receive SMS text messages for this portal user.

• Type: string
• Length: 100 characters

---

sslVpnAllowedFlag

Whether a portal user may connect to the SoftLayer private network via SSL VPN or not.

• Type: boolean

---

state

A two-letter abbreviation of the state in the mailing address belonging to a portal user. If a user does not reside in a province then this is typically blank.

• Type: string
• Length: 2 characters

---

statusDate

The date a portal users record's last status change.

• Type: dateTime

---

timezoneId

A portal user's time zone.

• Type: integer
• Length: 10 digits

---

userStatusId

A number reflecting the state of a portal user.

• Type: integer
• Length: 10 digits

---

username

A portal user's username.

• Type: string
• Length: 255 characters

---

yahoo

A portal user's Yahoo! Chat name.

• Type: string
• Length: 100 characters

Relational Properties

account

The customer account that a user belongs to.
account can be queried by object mask.
account must be a unique value.

• Type: SoftLayer_Account

---

additionalEmails

A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
additionalEmails can be queried by object mask.

• Type: SoftLayer_User_Customer_AdditionalEmailArray

---

apiAuthenticationKeys

A portal user's API Authentication keys. There is a max limit of two API keys per user.
apiAuthenticationKeys can be queried by object mask.

• Type: SoftLayer_User_Customer_ApiAuthenticationArray

---

cdnAccounts

The CDN accounts associated with a portal user.
cdnAccounts can be queried by object mask.

• Type: SoftLayer_Network_ContentDelivery_AccountArray

---

childUsers

A portal user's child users. Some portal users may not have child users.
childUsers can be queried by object mask.

• Type: SoftLayer_User_CustomerArray

---

hardware

A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
hardware can be queried by object mask.

• Type: SoftLayer_HardwareArray

---

hardwareNotifications

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'.
hardwareNotifications can be queried by object mask.

• Type: SoftLayer_User_Customer_Notification_HardwareArray

---

hasFullHardwareAccessFlag

Whether or not a portal user has access to all hardware on their account.
hasFullHardwareAccessFlag can be queried by object mask.
hasFullHardwareAccessFlag must be a unique value.

• Type: boolean

---

parent

A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
parent can be queried by object mask.
parent must be a unique value.

• Type: SoftLayer_User_Customer

---

permissions

A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
permissions can be queried by object mask.

• Type: SoftLayer_User_Customer_CustomerPermission_PermissionArray

---

securityAnswers

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.
securityAnswers can be queried by object mask.

• Type: SoftLayer_User_Customer_Security_AnswerArray

---

surveyRequiredFlag

Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
surveyRequiredFlag can be queried by object mask.
surveyRequiredFlag must be a unique value.

• Type: boolean

---

surveys

The surveys that a user has taken in the SoftLayer customer portal.
surveys can be queried by object mask.

• Type: SoftLayer_SurveyArray

---

timezone

A portal user's time zone.
timezone must be a unique value.

• Type: SoftLayer_Locale_Timezone

---

userStatus

A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
userStatus must be a unique value.

• Type: SoftLayer_User_Customer_Status

Count Properties

additionalEmailCount

A count of a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
additionalEmailCount must be a unique value.

• Type: unsigned long

---

apiAuthenticationKeyCount

A count of a portal user's API Authentication keys. There is a max limit of two API keys per user.
apiAuthenticationKeyCount must be a unique value.

• Type: unsigned long

---

cdnAccountCount

A count of the CDN accounts associated with a portal user.
cdnAccountCount must be a unique value.

• Type: unsigned long

---

childUserCount

A count of a portal user's child users. Some portal users may not have child users.
childUserCount must be a unique value.

• Type: unsigned long

---

hardwareCount

A count of a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
hardwareCount must be a unique value.

• Type: unsigned long

---

hardwareNotificationCount

A count of 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'.
hardwareNotificationCount must be a unique value.

• Type: unsigned long

---

permissionCount

A count of a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
permissionCount must be a unique value.

• Type: unsigned long

---

securityAnswerCount

A count of 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.
securityAnswerCount must be a unique value.

• Type: unsigned long

---

surveyCount

A count of the surveys that a user has taken in the SoftLayer customer portal.
surveyCount must be a unique value.

• Type: unsigned long

Associated Methods

• SoftLayer_User_Customer::getObject
• SoftLayer_Account::getUsers