SoftLayer_User_Customer


SoftLayer_User_Customer

Description

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.

Local


accountId

A portal user’s associated SoftLayer_Account id.
Type: int


address1

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


address2

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


aim

A portal user’s AOL Instant Messenger screen name.
Type: string


alternatePhone

A portal user’s secondary phone number.
Type: string


authenticationToken

The authentication token used for logging into the SoftLayer customer portal.
Type: SoftLayer_Container_User_Authentication_Token


city

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


companyName

A portal user’s associated company. This may not be the same company as the customer that owns this portal user.
Type: string


country

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


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


denyAllResourceAccessOnCreateFlag

Flag used to deny access to all hardware and cloud computing instances upon user creation.
Type: boolean


displayName

None
Type: string


email

A portal user’s email address.
Type: string


firstName

A portal user’s first name.
Type: string


forumPasswordHash

A user’s password for the SoftLayer forums, hashed for auto-login capability from the SoftLayer customer portal
Type: string

Deprecated


iamAuthorizationStatus

None
Type: int


iamId

The IAMid (realm-identifier) of the user being created by PaaS
Type: string


icq

A portal user’s ICQ UIN.
Type: string


id

A portal user’s internal identifying number.
Type: int


ipAddressRestriction

The IP addresses or IP ranges from which a user may login to the SoftLayer customer portal. 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.
Type: string


isMasterUserFlag

None
Type: boolean


lastName

A portal user’s last name.
Type: string


linkedAccountIntegrationMode

The linked account integration mode
Type: string


localeId

A portal user’s associated SoftLayer_Locale id.
Type: int


managedByFederationFlag

Determines if this portal user is managed by SAML federation.
Type: boolean


managedByOpenIdConnectFlag

Determines if this portal user is managed by IBMid federation.
Type: boolean


minimumPasswordLifeHours

The minimum number of hours that must pass between password resets.
Type: int


modifyDate

The date a portal user’s record was last modified.
Type: dateTime


msn

A portal user’s MSN address.
Type: string


nameId

None
Type: string


officePhone

A portal user’s office phone number.
Type: string


openIdConnectUserName

The BlueID username associated to with this user, if the account is managed by OpenIDConnect / BlueID federation
Type: string


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: int


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


pptpVpnAllowedFlag

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

Deprecated


preventPreviousPasswords

None
Type: int


savedId

None
Type: string


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: int


sms

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


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


statusDate

The date a portal users record’s last status change.
Type: dateTime


timezoneId

A portal user’s time zone.
Type: int


userStatusId

A number reflecting the state of a portal user.
Type: int


username

A portal user’s username.
Type: string


verificationCode

The verification code from Bluemix BSS to save in the invitation
Type: string


vpnManualConfig

Whether a portal user vpn subnets have been manual configured.
Type: boolean


yahoo

A portal user’s Yahoo! Chat name.
Type: string

Relational


account

The customer account that a user belongs to.
Type: SoftLayer_Account


additionalEmails

A portal user’s additional email addresses. These email addresses are contacted when updates are made to support tickets.
Type: SoftLayer_User_Customer_AdditionalEmail[]


apiAuthenticationKeys

A portal user’s API Authentication keys. There is a max limit of one API key per user.
Type: SoftLayer_User_Customer_ApiAuthentication[]


childUsers

A portal user’s child users. Some portal users may not have child users.
Type: SoftLayer_User_Customer[]


closedTickets

An user’s associated closed tickets.
Type: SoftLayer_Ticket[]


dedicatedHosts

The dedicated hosts to which the user has been granted access.
Type: SoftLayer_Virtual_DedicatedHost[]


externalBindings

The external authentication bindings that link an external identifier to a SoftLayer user.
Type: SoftLayer_User_External_Binding[]


hardware

A portal user’s accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
Type: SoftLayer_Hardware[]


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’.
Type: SoftLayer_User_Customer_Notification_Hardware[]


hasAcknowledgedSupportPolicyFlag

Whether or not a user has acknowledged the support policy.
Type: boolean


hasFullDedicatedHostAccessFlag

Permission granting the user access to all Dedicated Host devices on the account.
Type: boolean


hasFullHardwareAccessFlag

Whether or not a portal user has access to all hardware on their account.
Type: boolean


hasFullVirtualGuestAccessFlag

Whether or not a portal user has access to all virtual guests on their account.
Type: boolean


Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.
Type: SoftLayer_User_Customer_Link


layoutProfiles

Contains the definition of the layout profile.
Type: SoftLayer_Layout_Profile[]


locale

A user’s locale. Locale holds user’s language and region information.
Type: SoftLayer_Locale


loginAttempts

A user’s attempts to log into the SoftLayer customer portal.
Type: SoftLayer_User_Customer_Access_Authentication[]


notificationSubscribers

Notification subscription records for the user.
Type: SoftLayer_Notification_Subscriber[]


openTickets

An user’s associated open tickets.
Type: SoftLayer_Ticket[]


overrides

A portal user’s vpn accessible subnets.
Type: SoftLayer_Network_Service_Vpn_Overrides[]


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.
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.
Type: SoftLayer_User_Customer_CustomerPermission_Permission[]


preferences

Data type contains a single user preference to a specific preference type.
Type: SoftLayer_User_Preference[]


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.
Type: SoftLayer_User_Customer_Security_Answer[]


subscribers

A user’s notification subscription records.
Type: SoftLayer_Notification_User_Subscriber[]


successfulLogins

A user’s successful attempts to log into the SoftLayer customer portal.
Type: SoftLayer_User_Customer_Access_Authentication[]


supportPolicyAcknowledgementRequiredFlag

Whether or not a user is required to acknowledge the support policy for portal access.
Type: int


surveyRequiredFlag

Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
Type: boolean


surveys

The surveys that a user has taken in the SoftLayer customer portal.
Type: SoftLayer_Survey[]


tickets

An user’s associated tickets.
Type: SoftLayer_Ticket[]


timezone

A portal user’s time zone.
Type: SoftLayer_Locale_Timezone


unsuccessfulLogins

A user’s unsuccessful attempts to log into the SoftLayer customer portal.
Type: SoftLayer_User_Customer_Access_Authentication[]


User customer link with IBMid and IAMid.
Type: SoftLayer_User_Customer_Link[]


userStatus

A portal user’s status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
Type: SoftLayer_User_Customer_Status


virtualGuests

A portal user’s accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.
Type: SoftLayer_Virtual_Guest[]

Count


actionCount

A count of
Type: unsignedLong


additionalEmailCount

A count of a portal user’s additional email addresses. These email addresses are contacted when updates are made to support tickets.
Type: unsignedLong


apiAuthenticationKeyCount

A count of a portal user’s API Authentication keys. There is a max limit of one API key per user.
Type: unsignedLong


childUserCount

A count of a portal user’s child users. Some portal users may not have child users.
Type: unsignedLong


closedTicketCount

A count of an user’s associated closed tickets.
Type: unsignedLong


dedicatedHostCount

A count of the dedicated hosts to which the user has been granted access.
Type: unsignedLong


externalBindingCount

A count of the external authentication bindings that link an external identifier to a SoftLayer user.
Type: unsignedLong


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.
Type: unsignedLong


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’.
Type: unsignedLong


layoutProfileCount

A count of contains the definition of the layout profile.
Type: unsignedLong


loginAttemptCount

A count of a user’s attempts to log into the SoftLayer customer portal.
Type: unsignedLong


notificationSubscriberCount

A count of notification subscription records for the user.
Type: unsignedLong


openTicketCount

A count of an user’s associated open tickets.
Type: unsignedLong


overrideCount

A count of a portal user’s vpn accessible subnets.
Type: unsignedLong


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.
Type: unsignedLong


preferenceCount

A count of data type contains a single user preference to a specific preference type.
Type: unsignedLong


roleCount

A count of
Type: unsignedLong


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.
Type: unsignedLong


subscriberCount

A count of a user’s notification subscription records.
Type: unsignedLong


successfulLoginCount

A count of a user’s successful attempts to log into the SoftLayer customer portal.
Type: unsignedLong


surveyCount

A count of the surveys that a user has taken in the SoftLayer customer portal.
Type: unsignedLong


ticketCount

A count of an user’s associated tickets.
Type: unsignedLong


unsuccessfulLoginCount

A count of a user’s unsuccessful attempts to log into the SoftLayer customer portal.
Type: unsignedLong


userLinkCount

A count of user customer link with IBMid and IAMid.
Type: unsignedLong


virtualGuestCount

A count of a portal user’s accessible CloudLayer Computing Instances. These permissions control which CloudLayer Computing Instances a user has access to in the SoftLayer customer portal.
Type: unsignedLong