Items with tag user

    python

    reference

    • acknowledgeSupportPolicy
    • acknowledgeSupportPolicy
    • acknowledgeSupportPolicy
    • activate
    • activateOpenIdConnectUser
      Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.
    • activateOpenIdConnectUser
      Completes invitation process for an OpenIdConnect user created by Bluemix Unified User Console.
    • addAction
      Assigns a SoftLayer_User_Permission_Action object to the group.
    • addApiAuthenticationKey
      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.
    • addApiAuthenticationKey
      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.
    • addApiAuthenticationKey
      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.
    • addBulkActions
      Assigns multiple SoftLayer_User_Permission_Action objects to the group.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkDedicatedHostAccess
      Grants the user access to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkHardwareAccess
      Add multiple hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkHardwareAccess() does not attempt to add hardware access if the given user already has access to that hardware object. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkPortalPermission
      Add multiple permissions to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. addBulkPortalPermission() does not attempt to add permissions already assigned to the user. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • addBulkResourceObjects
      Links multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects to the group. All objects must be of the same type.
    • addBulkRoles
    • addBulkRoles
    • addBulkRoles
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addBulkVirtualGuestAccess
      Add multiple CloudLayer Computing Instances to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. addBulkVirtualGuestAccess() does not attempt to add CloudLayer Computing Instance access if the given user already has access to that CloudLayer Computing Instance object. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account.
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addDedicatedHostAccess
      Grants the user access to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addExternalBinding
    • addExternalBinding
    • addExternalBinding
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addHardwareAccess
      Add hardware to a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the hardware you're attempting to add then addHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addNotificationSubscriber
      Create a notification subscription record for the user. If a subscription record exists for the notification, the record will be set to active, if currently inactive.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addPortalPermission
      Add a permission to a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. If the user already has the permission you're attempting to add then addPortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are added based on the keyName property of the permission parameter.
    • addResourceObject
      Links a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object to the group.
    • addRole
    • addRole
    • addRole
    • addUser
      Assigns a SoftLayer_User_Customer object to the role.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • addVirtualGuestAccess
      Add a CloudLayer Computing Instance to a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user already has access to the CloudLayer Computing Instance you're attempting to add then addVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set CloudLayer Computing Instance access for any of the other users on their account. Only the USER_MANAGE permission is required to execute this.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • assignNewParentId
      This method can be used in place of [SoftLayer_User_Customer::editObject](/reference/datatypes/$1/#$2) to change the parent user of this user. The new parent must be a user on the same account, and must not be a child of this user. A user is not allowed to change their own parent. If the cascadeFlag is set to false, then an exception will be thrown if the new parent does not have all of the permissions that this user possesses. If the cascadeFlag is set to true, then permissions will be removed from this user and the descendants of this user as necessary so that no children of the parent will have permissions that the parent does not possess. However, setting the cascadeFlag to true will not remove the access all device permissions from this user. The customer portal will need to be used to remove these permissions.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • changePreference
      Select a type of preference you would like to modify using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • completeInvitationAfterLogin
      Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token
    • completeInvitationAfterLogin
      Completes invitation processing after logging on an existing OpenIdConnect user identity and return an access token
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createNotificationSubscriber
      Create a new subscriber for a given resource.
    • createObject
      Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. An account's master user and sub-users who have the User Manage permission can add new users. Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. Note, neither password nor vpnPassword parameters are required. Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the 'Reset Password' link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any 'invitation email' that comes to the user, will come from PaaS, not from IMS via IBMid. Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).
    • createObject
      Create a new mobile device association for a user.
    • createObject
      Passing in an unsaved instances of a Customer_Notification_Hardware object into this function will create the object and return the results to the user.
    • createObject
      Passing in an unsaved instance of a SoftLayer_Customer_Notification_Virtual_Guest object into this function will create the object and return the results to the user.
    • createObject
      Create a new user in the SoftLayer customer portal. It is not possible to set up SLL enable flags during object creation. These flags are ignored during object creation. You will need to make a subsequent call to edit object in order to enable VPN access. An account's master user and sub-users who have the User Manage permission can add new users. Users are created with a default permission set. After adding a user it may be helpful to set their permissions and device access. secondaryPasswordTimeoutDays will be set to the system configured default value if the attribute is not provided or the attribute is not a valid value. Note, neither password nor vpnPassword parameters are required. Password When a new user is created, an email will be sent to the new user's email address with a link to a url that will allow the new user to create or change their password for the SoftLayer customer portal. If the password parameter is provided and is not null, then that value will be validated. If it is a valid password, then the user will be created with this password. This user will still receive a portal password email. It can be used within 24 hours to change their password, or it can be allowed to expire, and the password provided during user creation will remain as the user's password. If the password parameter is not provided or the value is null, the user must set their portal password using the link sent in email within 24 hours.  If the user fails to set their password within 24 hours, then a non-master user can use the 'Reset Password' link on the login page of the portal to request a new email. A master user can use the link to retrieve a phone number to call to assist in resetting their password. The password parameter is ignored for VPN_ONLY users or for IBMid authenticated users. vpnPassword If the vpnPassword is provided, then the user's vpnPassword will be set to the provided password.  When creating a vpn only user, the vpnPassword MUST be supplied.  If the vpnPassword is not provided, then the user will need to use the portal to edit their profile and set the vpnPassword. IBMid considerations When a SoftLayer account is linked to a Platform Services (PaaS, formerly Bluemix) account, AND the trait on the SoftLayer Account indicating IBMid authentication is set, then SoftLayer will delegate the creation of an ACTIVE user to PaaS. This means that even though the request to create a new user in such an account may start at the IMS API, via this delegation we effectively turn it into a request that is driven by PaaS. In particular this means that any 'invitation email' that comes to the user, will come from PaaS, not from IMS via IBMid. Users created in states other than ACTIVE (for example, a VPN_ONLY user) will be created directly in IMS without delegation (but note that no invitation is sent for a user created in any state other than ACTIVE).
    • createObject
    • createObject
      Customer created permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • createObject
      Customer created permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • createObjects
      Passing in a collection of unsaved instances of Customer_Notification_Hardware objects into this function will create all objects and return the results to the user.
    • createObjects
      Passing in a collection of unsaved instances of SoftLayer_Customer_Notification_Virtual_Guest objects into this function will create all objects and return the results to the user.
    • createOpenIdConnectUserAndCompleteInvitation
      Completes invitation processing when a new OpenIdConnect user must be created.
    • createOpenIdConnectUserAndCompleteInvitation
      Completes invitation processing when a new OpenIdConnect user must be created.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • createSubscriberDeliveryMethods
      Create delivery methods for a notification that the user is subscribed to. Multiple delivery method keyNames can be supplied to create multiple delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • deactivate
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • deactivateNotificationSubscriber
      Create a new subscriber for a given resource.
    • declineInvitation
      Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.
    • declineInvitation
      Declines an invitation to link an OpenIdConnect identity to a SoftLayer (Atlas) identity and account. Note that this uses a registration code that is likely a one-time-use-only token, so if an invitation has already been processed (accepted or previously declined) it will not be possible to process it a second time.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Delete a VeriSign external binding. The only VeriSign external binding that can be deleted through this method is the free VeriSign external binding for the master user of a SoftLayer account. All other external bindings must be canceled using the SoftLayer service cancellation form. When a VeriSign external binding is deleted the credential is deactivated in VeriSign's system for use on the SoftLayer site and the $0 billing item associated with the free VeriSign external binding is cancelled.
    • deleteObject
      Delete a mobile device association for a user.
    • deleteObject
      Delete an external authentication binding. If the external binding currently has an active billing item associated you will be prevented from deleting the binding. The alternative method to remove an external authentication binding is to use the service cancellation form.
    • deleteObject
      Customer users can only delete permission groups of type NORMAL. The SYSTEM type is reserved for internal use. The user who is creating the permission group must have the permission to manage users.
    • deleteObject
      Customer users can only delete permission roles with systemFlag set to false. The SYSTEM type is reserved for internal use. The user who is creating the permission role must have the permission to manage users.
    • deleteObjects
      Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • deleteObjects
      Like any other API object, the customer notification objects can be deleted by passing an instance of them into this function. The ID on the object must be set.
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • disable
      Disabling an external binding will allow you to keep the external binding on your SoftLayer account, but will not require you to authentication with our trusted 2 form factor vendor when logging into the SoftLayer customer portal. You may supply one of the following reason when you disable an external binding: *Unspecified *TemporarilyUnavailable *Lost *Stolen
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Edit the properties of customer ApiAuthentication record by passing in a modified instance of a SoftLayer_User_Customer_ApiAuthentication object. Only the ipAddressRestriction property can be modified.
    • editObject
      Edit the object by passing in a modified instance of the object
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObject() if you wish to edit a single user account. Users who do not have the User Manage permission can only update their own information.
    • editObject
      Allows a user to modify the name and description of an existing customer permission group. Customer permission groups must be of type NORMAL. The SYSTEM type is reserved for internal use. The account id supplied in the template permission group must match account id of the user who is creating the permission group. The user who is creating the permission group must have the permission to manage users.
    • editObject
      Allows a user to modify the name and description of an existing customer permission role. Customer permission roles must set the systemFlag attribute to false. The SYSTEM type is reserved for internal use. The account id supplied in the template permission role must match account id of the user who is creating the permission role. The user who is creating the permission role must have the permission to manage users.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • editObjects
      Account master users and sub-users who have the User Manage permission in the SoftLayer customer portal can update other user's information. Use editObjects() if you wish to edit multiple users at once. Users who do not have the User Manage permission can only update their own information.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enable
      Enabling an external binding will activate the binding on your account and require you to authenticate with our trusted 3rd party 2 form factor vendor when logging into the SoftLayer customer portal. Please note that API access will be disabled for users that have an active external binding.
    • enroll
      Create a new Service Provider Enrollment
    • findByGuestId
      This method returns all SoftLayer_User_Customer_Notification_Virtual_Guest objects associated with the passed in ID as long as that Virtual Guest ID is owned by the current user's account. This behavior can also be accomplished by simply tapping monitoringUserNotification on the Virtual_Guest object.
    • findByHardwareId
      This method returns all Customer_Notification_Hardware objects associated with the passed in hardware ID as long as that hardware ID is owned by the current user's account. This behavior can also be accomplished by simply tapping monitoringUserNotification on the Hardware_Server object.
    • findUserPreference
    • findUserPreference
    • findUserPreference
    • generateSecretKey
    • getAccount
      The customer account that a user belongs to.
    • getAccount
      The customer account that a user belongs to.
    • getAccount
      The customer account that a user belongs to.
    • getAccount
    • getAccount
    • getActions
    • getActions
    • getActions
    • getActions
    • getActions
    • getActivationCodeForMobileClient
      An activation code is required when provisioning a new mobile credential from Verisign. This method will return the required activation code.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getActiveExternalAuthenticationVendors
      The getActiveExternalAuthenticationVendors method will return a list of available external vendors that a SoftLayer user can authenticate against. The list will only contain vendors for which the user has at least one active external binding.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAdditionalEmails
      A portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.
    • getAgentImpersonationToken
    • getAgentImpersonationToken
    • getAgentImpersonationToken
    • getAllObjects
      Retrieve all available permissions.
    • getAllObjects
      getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.
    • getAllObjects
    • getAllObjects
    • getAllObjects
      Retrieve all user status objects.
    • getAllObjects
      getAllObjects() will return a list of the available external binding vendors that SoftLayer supports. Use this list to select the appropriate vendor when creating a new external binding.
    • getAllObjects
      Object filters and result limits are enabled on this method.
    • getAllObjects
      Retrieve an array of SoftLayer_User_Permission_Resource_Type objects.
    • getAllObjects
      Retrieve all viewable security questions.
    • getAllowedDedicatedHostIds
    • getAllowedDedicatedHostIds
    • getAllowedDedicatedHostIds
    • getAllowedHardwareIds
    • getAllowedHardwareIds
    • getAllowedHardwareIds
    • getAllowedVirtualGuestIds
    • getAllowedVirtualGuestIds
    • getAllowedVirtualGuestIds
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getApiAuthenticationKeys
      A portal user's API Authentication keys. There is a max limit of one API key per user.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAttributes
      Attributes of an external authentication binding.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAuthenticationToken
      This method generate user authentication token and return [SoftLayer_Container_User_Authentication_Token](/reference/datatypes/SoftLayer_Container_User_Authentication_Token) object which will be used to authenticate user to login to SoftLayer customer portal.
    • getAvailablePushNotificationSubscriptions
      Notification subscriptions available to a mobile device.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getBillingItem
      Information regarding the billing item for external authentication.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getChildUsers
      A portal user's child users. Some portal users may not have child users.
    • getClosedTickets
      An user's associated closed tickets.
    • getClosedTickets
      An user's associated closed tickets.
    • getClosedTickets
      An user's associated closed tickets.
    • getCompanyType
      Catalyst company types.
    • getCredentialExpirationDate
      The date that a VeriSign credential expires.
    • getCredentialLastUpdateDate
      The last time a VeriSign credential was updated.
    • getCredentialState
      The current state of a VeriSign credential. This can be 'Enabled', 'Disabled', or 'Locked'.
    • getCredentialType
      The type of VeriSign credential. This can be either 'Hardware' or 'Software'.
    • getCustomer
      The user this mobile device belongs to.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDedicatedHosts
      The dedicated hosts to which the user has been granted access.
    • getDefaultAccount
      This method is not applicable to legacy SoftLayer-authenticated users and can only be invoked for IBMid-authenticated users.
    • getDefaultAccount
      This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.
    • getDefaultAccount
      This API gets the account associated with the default user for the OpenIdConnect identity that is linked to the current active SoftLayer user identity. When a single active user is found for that IAMid, it becomes the default user and the associated account is returned. When multiple default users are found only the first is preserved and the associated account is returned (remaining defaults see their default flag unset). If the current SoftLayer user identity isn't linked to any OpenIdConnect identity, or if none of the linked users were found as defaults, the API returns null. Invoke this only on IAMid-authenticated users.
    • getExternalBindings
      The external authentication bindings that link an external identifier to a SoftLayer user.
    • getExternalBindings
      The external authentication bindings that link an external identifier to a SoftLayer user.
    • getExternalBindings
      The external authentication bindings that link an external identifier to a SoftLayer user.
    • getGroups
      The groups that are of this type.
    • getGroups
    • getGuest
      The virtual guest object that will be monitored.
    • getHardware
      A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
    • getHardware
      The hardware object that will be monitored.
    • getHardware
      A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
    • getHardware
      A portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.
    • getHardwareCount
      Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getHardwareCount
      Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getHardwareCount
      Retrieve the number of servers that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on hardware. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getHardwareNotifications
      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'.
    • getHardwareNotifications
      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'.
    • getHardwareNotifications
      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'.
    • getHasAcknowledgedSupportPolicyFlag
      Whether or not a user has acknowledged the support policy.
    • getHasAcknowledgedSupportPolicyFlag
      Whether or not a user has acknowledged the support policy.
    • getHasAcknowledgedSupportPolicyFlag
      Whether or not a user has acknowledged the support policy.
    • getHasFullDedicatedHostAccessFlag
      Permission granting the user access to all Dedicated Host devices on the account.
    • getHasFullDedicatedHostAccessFlag
      Permission granting the user access to all Dedicated Host devices on the account.
    • getHasFullDedicatedHostAccessFlag
      Permission granting the user access to all Dedicated Host devices on the account.
    • getHasFullHardwareAccessFlag
      Whether or not a portal user has access to all hardware on their account.
    • getHasFullHardwareAccessFlag
      Whether or not a portal user has access to all hardware on their account.
    • getHasFullHardwareAccessFlag
      Whether or not a portal user has access to all hardware on their account.
    • getHasFullVirtualGuestAccessFlag
      Whether or not a portal user has access to all virtual guests on their account.
    • getHasFullVirtualGuestAccessFlag
      Whether or not a portal user has access to all virtual guests on their account.
    • getHasFullVirtualGuestAccessFlag
      Whether or not a portal user has access to all virtual guests on their account.
    • getIbmIdLink
      Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.
    • getIbmIdLink
      Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.
    • getIbmIdLink
      Specifically relating the Customer instance to an IBMid. A Customer instance may or may not have an IBMid link.
    • getImpersonationToken
    • getImpersonationToken
    • getImpersonationToken
    • getLayoutProfiles
      Contains the definition of the layout profile.
    • getLayoutProfiles
      Contains the definition of the layout profile.
    • getLayoutProfiles
      Contains the definition of the layout profile.
    • getLocale
      A user's locale. Locale holds user's language and region information.
    • getLocale
      A user's locale. Locale holds user's language and region information.
    • getLocale
      A user's locale. Locale holds user's language and region information.
    • getLoginAccountInfoOpenIdConnect
      Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found.
    • getLoginAccountInfoOpenIdConnect
      Validates a supplied OpenIdConnect access token to the SoftLayer customer portal and returns the default account name and id for the active user. An exception will be thrown if no matching customer is found.
    • getLoginAttempts
      A user's attempts to log into the SoftLayer customer portal.
    • getLoginAttempts
      A user's attempts to log into the SoftLayer customer portal.
    • getLoginAttempts
      A user's attempts to log into the SoftLayer customer portal.
    • getLoginToken
      Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.
    • getLoginToken
      Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.
    • getLoginToken
      Attempt to authenticate a user to the SoftLayer customer portal using the provided authentication container. Depending on the specific type of authentication container that is used, this API will leverage the appropriate authentication protocol. If authentication is successful then the API returns a list of linked accounts for the user, a token containing the ID of the authenticated user and a hash key used by the SoftLayer customer portal to maintain authentication.
    • getMappedAccounts
      An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all the accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IBMid-authenticated users.
    • getMappedAccounts
      An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users.
    • getMappedAccounts
      An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one SoftLayer user per account. This effectively links the OpenIdConnect identity to those accounts. This API returns a list of all active accounts for which there is a link between the OpenIdConnect identity and a SoftLayer user. Invoke this only on IAMid-authenticated users.
    • getMobileDevices
      A portal user's associated mobile device profiles.
    • getMobileDevices
      A portal user's associated mobile device profiles.
    • getMobileDevices
      A portal user's associated mobile device profiles.
    • getNote
      An optional note for identifying the external binding.
    • getNote
      An optional note for identifying the external binding.
    • getNote
      An optional note for identifying the external binding.
    • getNote
      An optional note for identifying the external binding.
    • getNotificationSubscribers
      Notification subscription records for the user.
    • getNotificationSubscribers
      Notification subscription records for the user.
    • getNotificationSubscribers
      Notification subscription records for the user.
    • getObject
      getObject retrieves the SoftLayer_User_Customer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer service. You can only retrieve users that are assigned to the customer account belonging to the user making the API call.
    • getObject
      getObject retrieves the SoftLayer_User_Customer_ApiAuthentication object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_ApiAuthentication service.
    • getObject
      getObject retrieves the SoftLayer_User_Customer_CustomerPermission_Permission object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_CustomerPermission_Permission service.
    • getObject
      Retrieve a SoftLayer_User_Customer_External_Binding record.
    • getObject
      Retrieve a SoftLayer_User_Customer_External_Binding_Totp record.
    • getObject
      Retrieve a SoftLayer_User_Customer_External_Binding_Vendor record.
    • getObject
      Retrieve a SoftLayer_User_Customer_External_Binding_Verisign record.
    • getObject
      Retrieve a SoftLayer_User_Customer_Invitation record.
    • getObject
      Retrieve a SoftLayer_User_Customer_MobileDevice record.
    • getObject
      Retrieve a SoftLayer_User_Customer_MobileDevice_OperatingSystem record.
    • getObject
      Retrieve a SoftLayer_User_Customer_MobileDevice_Type record.
    • getObject
      getObject retrieves the SoftLayer_User_Customer_Notification_Hardware object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Hardware service. You can only retrieve hardware notifications attached to hardware and users that belong to your account
    • getObject
      getObject retrieves the SoftLayer_User_Customer_Notification_Virtual_Guest object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Notification_Virtual_Guest service. You can only retrieve guest notifications attached to virtual guests and users that belong to your account
    • getObject
      Retrieve a SoftLayer_User_Customer_OpenIdConnect record.
    • getObject
      Retrieve a SoftLayer_User_Customer_OpenIdConnect_TrustedProfile record.
    • getObject
      Retrieve a SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest record.
    • getObject
      getObject retrieves the SoftLayer_User_Customer_Security_Answer object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Security_Answer service.
    • getObject
      getObject retrieves the SoftLayer_User_Customer_Status object whose ID number corresponds to the ID number of the init parameter passed to the SoftLayer_User_Customer_Status service.
    • getObject
      Retrieve a SoftLayer_User_External_Binding record.
    • getObject
      Retrieve a SoftLayer_User_External_Binding_Vendor record.
    • getObject
      Retrieve a SoftLayer_User_Permission_Action record.
    • getObject
      Retrieve a SoftLayer_User_Permission_Group record.
    • getObject
      Retrieve a SoftLayer_User_Permission_Group_Type record.
    • getObject
      Retrieve a SoftLayer_User_Permission_Resource_Type record.
    • getObject
      Retrieve a SoftLayer_User_Permission_Role record.
    • getObject
      getAllObjects retrieves all the SoftLayer_User_Security_Question objects where it is set to be viewable.
    • getOpenIdConnectMigrationState
      This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.
    • getOpenIdConnectMigrationState
      This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.
    • getOpenIdConnectMigrationState
      This API returns a SoftLayer_Container_User_Customer_OpenIdConnect_MigrationState object containing the necessary information to determine what migration state the user is in. If the account is not OpenIdConnect authenticated, then an exception is thrown.
    • getOpenIdRegistrationInfoFromCode
      Get OpenId User Registration details from the provided email code
    • getOpenIdRegistrationInfoFromCode
      Get OpenId User Registration details from the provided email code
    • getOpenTickets
      An user's associated open tickets.
    • getOpenTickets
      An user's associated open tickets.
    • getOpenTickets
      An user's associated open tickets.
    • getOperatingSystem
      The operating system this device is using
    • getOverrides
      A portal user's vpn accessible subnets.
    • getOverrides
      A portal user's vpn accessible subnets.
    • getOverrides
      A portal user's vpn accessible subnets.
    • getParent
      A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
    • getParent
      A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
    • getParent
      A portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.
    • getPasswordRequirements
    • getPasswordRequirements
    • getPasswordRequirements
    • getPermissions
      A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
    • getPermissions
      A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
    • getPermissions
      A portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.
    • getPortalLoginToken
      Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. 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.
    • getPortalLoginToken
      Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. 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.
    • getPortalLoginToken
      Attempt to authenticate a username and password to the SoftLayer customer portal. Many portal user accounts are configured to require answering a security question on login. In this case getPortalLoginToken() also verifies the given security question ID and answer. 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.
    • getPortalLoginTokenOpenIdConnect
      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.
    • getPortalLoginTokenOpenIdConnect
      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.
    • getPreference
      Select a type of preference you would like to get using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • getPreference
      Select a type of preference you would like to get using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • getPreference
      Select a type of preference you would like to get using [SoftLayer_User_Customer::getPreferenceTypes](/reference/datatypes/$1/#$2) and invoke this method using that preference type key name.
    • getPreferences
      Data type contains a single user preference to a specific preference type.
    • getPreferences
      Data type contains a single user preference to a specific preference type.
    • getPreferences
      Data type contains a single user preference to a specific preference type.
    • getPreferenceTypes
      Use any of the preference types to fetch or modify user preferences using [SoftLayer_User_Customer::getPreference](/reference/datatypes/$1/#$2) or [SoftLayer_User_Customer::changePreference](/reference/datatypes/$1/#$2), respectively.
    • getPreferenceTypes
      Use any of the preference types to fetch or modify user preferences using [SoftLayer_User_Customer::getPreference](/reference/datatypes/$1/#$2) or [SoftLayer_User_Customer::changePreference](/reference/datatypes/$1/#$2), respectively.
    • getPreferenceTypes
      Use any of the preference types to fetch or modify user preferences using [SoftLayer_User_Customer::getPreference](/reference/datatypes/$1/#$2) or [SoftLayer_User_Customer::changePreference](/reference/datatypes/$1/#$2), respectively.
    • getPushNotificationSubscriptions
      Notification subscriptions attached to a mobile device.
    • getQuestion
      The question the security answer is associated with.
    • getRequirementsForPasswordSet
      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.
    • getRequirementsForPasswordSet
      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.
    • getRequirementsForPasswordSet
      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.
    • getRoles
    • getRoles
    • getRoles
    • getRoles
    • getSecurityAnswers
      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.
    • getSecurityAnswers
      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.
    • getSecurityAnswers
      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.
    • getSubscribers
      A user's notification subscription records.
    • getSubscribers
      A user's notification subscription records.
    • getSubscribers
      A user's notification subscription records.
    • getSuccessfulLogins
      A user's successful attempts to log into the SoftLayer customer portal.
    • getSuccessfulLogins
      A user's successful attempts to log into the SoftLayer customer portal.
    • getSuccessfulLogins
      A user's successful attempts to log into the SoftLayer customer portal.
    • getSupportedLocales
      Returns all supported locales for the current user
    • getSupportedLocales
      Returns all supported locales for the current user
    • getSupportedLocales
      Returns all supported locales for the current user
    • getSupportPolicyAcknowledgementRequiredFlag
      Whether or not a user is required to acknowledge the support policy for portal access.
    • getSupportPolicyAcknowledgementRequiredFlag
      Whether or not a user is required to acknowledge the support policy for portal access.
    • getSupportPolicyAcknowledgementRequiredFlag
      Whether or not a user is required to acknowledge the support policy for portal access.
    • getSupportPolicyDocument
    • getSupportPolicyDocument
    • getSupportPolicyDocument
    • getSupportPolicyName
    • getSupportPolicyName
    • getSupportPolicyName
    • getSurveyRequiredFlag
      Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
    • getSurveyRequiredFlag
      Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
    • getSurveyRequiredFlag
      Whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.
    • getSurveys
      The surveys that a user has taken in the SoftLayer customer portal.
    • getSurveys
      The surveys that a user has taken in the SoftLayer customer portal.
    • getSurveys
      The surveys that a user has taken in the SoftLayer customer portal.
    • getTickets
      An user's associated tickets.
    • getTickets
      An user's associated tickets.
    • getTickets
      An user's associated tickets.
    • getTimezone
      A portal user's time zone.
    • getTimezone
      A portal user's time zone.
    • getTimezone
      A portal user's time zone.
    • getType
      The type of external authentication binding.
    • getType
      The type of external authentication binding.
    • getType
      The type of external authentication binding.
    • getType
      The type of device this user is using
    • getType
      The type of external authentication binding.
    • getType
      The type of the permission group.
    • getUnsuccessfulLogins
      A user's unsuccessful attempts to log into the SoftLayer customer portal.
    • getUnsuccessfulLogins
      A user's unsuccessful attempts to log into the SoftLayer customer portal.
    • getUnsuccessfulLogins
      A user's unsuccessful attempts to log into the SoftLayer customer portal.
    • getUser
      The user who owns the api authentication key.
    • getUser
      The SoftLayer user that the external authentication binding belongs to.
    • getUser
      The SoftLayer user that the external authentication binding belongs to.
    • getUser
      The SoftLayer user that the external authentication binding belongs to.
    • getUser
    • getUser
      The user that will be notified when the associated hardware object fails a monitoring instance.
    • getUser
      The user that will be notified when the associated virtual guest object fails a monitoring instance.
    • getUser
      The user who the security answer belongs to.
    • getUserForUnifiedInvitation
      Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided.
    • getUserForUnifiedInvitation
      Returns an IMS User Object from the provided OpenIdConnect User ID or IBMid Unique Identifier for the Account of the active user. Enforces the User Management permissions for the Active User. An exception will be thrown if no matching IMS User is found. NOTE that providing IBMid Unique Identifier is optional, but it will be preferred over OpenIdConnect User ID if provided.
    • getUserIdForPasswordSet
      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.
    • getUserIdForPasswordSet
      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.
    • getUserIdForPasswordSet
      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.
    • getUserLinks
      User customer link with IBMid and IAMid.
    • getUserLinks
      User customer link with IBMid and IAMid.
    • getUserLinks
      User customer link with IBMid and IAMid.
    • getUserPreferences
    • getUserPreferences
    • getUserPreferences
    • getUsers
    • getUserStatus
      A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
    • getUserStatus
      A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
    • getUserStatus
      A portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.
    • getVendor
      The vendor of an external authentication binding.
    • getVendor
      The vendor of an external authentication binding.
    • getVendor
      The vendor of an external authentication binding.
    • getVendor
      The vendor of an external authentication binding.
    • getVirtualGuestCount
      Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getVirtualGuestCount
      Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getVirtualGuestCount
      Retrieve the number of CloudLayer Computing Instances that a portal user has access to. Portal users can have restrictions set to limit services for and to perform actions on CloudLayer Computing Instances. You can set these permissions in the portal by clicking the 'administrative' then 'user admin' links.
    • getVirtualGuests
      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.
    • getVirtualGuests
      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.
    • getVirtualGuests
      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.
    • initiatePortalPasswordChange
      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.
    • initiatePortalPasswordChange
      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.
    • initiatePortalPasswordChange
      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.
    • initiatePortalPasswordChangeByBrandAgent
      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.
    • initiatePortalPasswordChangeByBrandAgent
      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.
    • initiatePortalPasswordChangeByBrandAgent
      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.
    • inTerminalStatus
    • inTerminalStatus
    • inTerminalStatus
    • inviteUserToLinkOpenIdConnect
      Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.
    • inviteUserToLinkOpenIdConnect
      Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.
    • inviteUserToLinkOpenIdConnect
      Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect. Throws an exception on error.
    • isMasterUser
      Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal.
    • isMasterUser
      Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal.
    • isMasterUser
      Portal users are considered master users if they don't have an associated parent user. The only users who don't have parent users are users whose username matches their SoftLayer account name. Master users have special permissions throughout the SoftLayer customer portal.
    • isValidPortalPassword
      Determine if a string is the given user's login password to the SoftLayer customer portal.
    • isValidPortalPassword
      Determine if a string is the given user's login password to the SoftLayer customer portal.
    • isValidPortalPassword
      Determine if a string is the given user's login password to the SoftLayer customer portal.
    • linkGroup
      Links a SoftLayer_User_Permission_Group object to the role.
    • linkRole
      Links a SoftLayer_User_Permission_Role object to the group.
    • performExternalAuthentication
      The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.
    • performExternalAuthentication
      The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.
    • performExternalAuthentication
      The perform external authentication method will authenticate the given external authentication container with an external vendor. The authentication container and its contents will be verified before an attempt is made to authenticate the contents of the container with an external vendor.
    • processPasswordSetRequest
      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 or Google Authentication 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. 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
    • processPasswordSetRequest
      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 or Google Authentication 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. 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
    • processPasswordSetRequest
      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 or Google Authentication 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. 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
    • receiveEventDirect
      Modifies linked Paas user data based on changes initiated by Bluemix.
    • removeAction
      Unassigns a SoftLayer_User_Permission_Action object from the group.
    • removeAllDedicatedHostAccessForThisUser
      Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllDedicatedHostAccessForThisUser
      Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllDedicatedHostAccessForThisUser
      Revoke access to all dedicated hosts on the account for this user. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllHardwareAccessForThisUser
      Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllHardwareAccessForThisUser
      Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllHardwareAccessForThisUser
      Remove all hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllVirtualAccessForThisUser
      Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllVirtualAccessForThisUser
      Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeAllVirtualAccessForThisUser
      Remove all cloud computing instances from a portal user's instance access list. A user's instance access list controls which of an account's computing instance objects a user has access to in the SoftLayer customer portal and API. If the current user does not have administrative privileges over this user, an inadequate permissions exception will get thrown. Users can call this function on child users, but not to themselves. An account's master has access to all users permissions on their account.
    • removeApiAuthenticationKey
      Remove a user's API authentication key, removing that user's access to query the SoftLayer API.
    • removeApiAuthenticationKey
      Remove a user's API authentication key, removing that user's access to query the SoftLayer API.
    • removeApiAuthenticationKey
      Remove a user's API authentication key, removing that user's access to query the SoftLayer API.
    • removeBulkActions
      Unassigns multiple SoftLayer_User_Permission_Action objects from the group.
    • removeBulkDedicatedHostAccess
      Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. If the user has full dedicatedHost access, then it will provide access to 'ALL but passed in' dedicatedHost ids.
    • removeBulkDedicatedHostAccess
      Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. If the user has full dedicatedHost access, then it will provide access to 'ALL but passed in' dedicatedHost ids.
    • removeBulkDedicatedHostAccess
      Revokes access for the user to one or more dedicated host devices. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account. If the user has full dedicatedHost access, then it will provide access to 'ALL but passed in' dedicatedHost ids.
    • removeBulkHardwareAccess
      Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. If the user has full hardware access, then it will provide access to 'ALL but passed in' hardware ids.
    • removeBulkHardwareAccess
      Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. If the user has full hardware access, then it will provide access to 'ALL but passed in' hardware ids.
    • removeBulkHardwareAccess
      Remove multiple hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting to remove then removeBulkHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account. If the user has full hardware access, then it will provide access to 'ALL but passed in' hardware ids.
    • removeBulkPortalPermission
      Remove (revoke) multiple permissions from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • removeBulkPortalPermission
      Remove (revoke) multiple permissions from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • removeBulkPortalPermission
      Remove (revoke) multiple permissions from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. removePortalPermission() does not attempt to remove permissions that are not assigned to the user. Users can grant or revoke permissions to their child users, but not to themselves. An account's master has all portal permissions and can grant permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permissions from a user will cascade down the child hierarchy and remove the permissions from this user along with all child users who also have the permission. If the cascadePermissionsFlag is not provided or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission objects within the permissions parameter.
    • removeBulkResourceObjects
      Unlinks multiple SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost objects from the group. All objects must be of the same type.
    • removeBulkRoles
    • removeBulkRoles
    • removeBulkRoles
    • removeBulkVirtualGuestAccess
      Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.
    • removeBulkVirtualGuestAccess
      Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.
    • removeBulkVirtualGuestAccess
      Remove multiple CloudLayer Computing Instances from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's CloudLayer Computing Instance objects a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeBulkVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set hardware access for any of the other users on their account.
    • removeDedicatedHostAccess
      Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • removeDedicatedHostAccess
      Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • removeDedicatedHostAccess
      Revokes access for the user to a single dedicated host device. The user will only be allowed to see and access devices in both the portal and the API to which they have been granted access. If the user's account has devices to which the user has not been granted access or the access has been revoked, then 'not found' exceptions are thrown if the user attempts to access any of these devices. Users can assign device access to their child users, but not to themselves. An account's master has access to all devices on their customer account and can set dedicated host access for any of the other users on their account.
    • removeExternalBinding
      Remove an external binding from this user.
    • removeExternalBinding
      Remove an external binding from this user.
    • removeExternalBinding
      Remove an external binding from this user.
    • removeHardwareAccess
      Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • removeHardwareAccess
      Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • removeHardwareAccess
      Remove hardware from a portal user's hardware access list. A user's hardware access list controls which of an account's hardware objects a user has access to in the SoftLayer customer portal and API. Hardware does not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the hardware you're attempting remove add then removeHardwareAccess() returns true. Users can assign hardware access to their child users, but not to themselves. An account's master has access to all hardware on their customer account and can set hardware access for any of the other users on their account.
    • removePortalPermission
      Remove (revoke) a permission from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.
    • removePortalPermission
      Remove (revoke) a permission from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.
    • removePortalPermission
      Remove (revoke) a permission from a portal user's permission set. [SoftLayer_User_Customer_CustomerPermission_Permission](/reference/datatypes/SoftLayer_User_Customer_CustomerPermission_Permission) control which features in the SoftLayer customer portal and API a user may use. Removing a user's permission will affect that user's portal and API access. If the user does not have the permission you're attempting to remove then removePortalPermission() returns true. Users can assign permissions to their child users, but not to themselves. An account's master has all portal permissions and can set permissions for any of the other users on their account. If the cascadePermissionsFlag is set to true, then removing the permission from a user will cascade down the child hierarchy and remove the permission from this user and all child users who also have the permission. If the cascadePermissionsFlag is not set or is set to false and the user has children users who have the permission, then an exception will be thrown, and the permission will not be removed from this user. Use the [SoftLayer_User_Customer_CustomerPermission_Permission::getAllObjects](/reference/datatypes/$1/#$2) method to retrieve a list of all permissions available in the SoftLayer customer portal and API. Permissions are removed based on the keyName property of the permission parameter.
    • removeResourceObject
      Unlinks a SoftLayer_Hardware_Server, SoftLayer_Virtual_Guest, or SoftLayer_Virtual_DedicatedHost object from the group.
    • removeRole
    • removeRole
    • removeRole
    • removeSecurityAnswers
    • removeSecurityAnswers
    • removeSecurityAnswers
    • removeUser
      Unassigns a SoftLayer_User_Customer object from the role.
    • removeVirtualGuestAccess
      Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account.
    • removeVirtualGuestAccess
      Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account.
    • removeVirtualGuestAccess
      Remove a CloudLayer Computing Instance from a portal user's access list. A user's CloudLayer Computing Instance access list controls which of an account's computing instances a user has access to in the SoftLayer customer portal and API. CloudLayer Computing Instances do not exist in the SoftLayer portal and returns 'not found' exceptions in the API if the user doesn't have access to it. If a user does not has access to the CloudLayer Computing Instance you're attempting remove add then removeVirtualGuestAccess() returns true. Users can assign CloudLayer Computing Instance access to their child users, but not to themselves. An account's master has access to all CloudLayer Computing Instances on their customer account and can set instance access for any of the other users on their account.
    • resetOpenIdConnectLink
      This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.
    • resetOpenIdConnectLink
      This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.
    • resetOpenIdConnectLink
      This method will change the IBMid that a SoftLayer user is linked to, if we need to do that for some reason. It will do this by modifying the link to the desired new IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is already Bluemix linked. To reset a link for the Bluemix-linked user account, use resetOpenIdConnectLinkUnifiedUserManagementMode.
    • resetOpenIdConnectLinkUnifiedUserManagementMode
      This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.
    • resetOpenIdConnectLinkUnifiedUserManagementMode
      This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.
    • resetOpenIdConnectLinkUnifiedUserManagementMode
      This method will change the IBMid that a SoftLayer master user is linked to, if we need to do that for some reason. It will do this by unlinking the new owner IBMid from its current user association in this account, if there is one (note that the new owner IBMid is not required to already be a member of the IMS account). Then it will modify the existing IBMid link for the master user to use the new owner IBMid-realm IAMid. At this point, if the new owner IBMid isn't already a member of the PaaS account, it will attempt to add it. As a last step, it will call PaaS to modify the owner on that side, if necessary. Only when all those steps are complete, it will commit the IMS-side DB changes. Then, it will clean up the SoftLayer user that was linked to the new owner IBMid (this user became unlinked as the first step in this process). It will also call BSS to delete the old owner IBMid. NOTE: This method cannot be used to 'un-link' a SoftLayer user. Once linked, a SoftLayer user can never be un-linked. Also, this method cannot be used to reset the link if the user account is not Bluemix linked. To reset a link for the user account not linked to Bluemix, use resetOpenIdConnectLink.
    • samlAuthenticate
    • samlAuthenticate
    • samlAuthenticate
    • samlBeginAuthentication
    • samlBeginAuthentication
    • samlBeginAuthentication
    • samlBeginLogout
    • samlBeginLogout
    • samlBeginLogout
    • samlLogout
    • samlLogout
    • samlLogout
    • selfPasswordChange
    • selfPasswordChange
    • selfPasswordChange
    • setDefaultAccount
      An OpenIdConnect identity, for example an IBMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.
    • setDefaultAccount
      An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.
    • setDefaultAccount
      An OpenIdConnect identity, for example an IAMid, can be linked or mapped to one or more individual SoftLayer users, but no more than one per account. If an OpenIdConnect identity is mapped to multiple accounts in this manner, one such account should be identified as the default account for that identity. Invoke this only on IBMid-authenticated users.
    • silentlyMigrateUserOpenIdConnect
      As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.
    • silentlyMigrateUserOpenIdConnect
      As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.
    • silentlyMigrateUserOpenIdConnect
      As master user, calling this api for the IBMid provider type when there is an existing IBMid for the email on the SL account will silently (without sending an invitation email) create a link for the IBMid. NOTE: If the SoftLayer user is already linked to IBMid, this call will fail. If the IBMid specified by the email of this user, is already used in a link to another user in this account, this call will fail. If there is already an open invitation from this SoftLayer user to this or any IBMid, this call will fail. If there is already an open invitation from some other SoftLayer user in this account to this IBMid, then this call will fail.
    • SoftLayer_User_Access_Facility_Log
      This class represents a login/logout sheet for facility visitors.
    • SoftLayer_User_Access_Facility_Log_Type
    • SoftLayer_User_Access_Facility_Visitor
      This class represents a facility visitor that is not an active employee or customer.
    • SoftLayer_User_Access_Facility_Visitor_Type
    • SoftLayer_User_Customer
      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.
    • SoftLayer_User_Customer
      Every SoftLayer account has one or more portal users which are defined by the SoftLayer_User_Customer service. Every SoftLayer customer account has a master user account whose name corresponds to their account id preceded by the letters 'SL'. Users exist in a parent-child relationship. Child users inherit the properties and permissions of their parent user while conversely a user may have more than one child users. API users have full access to their own portal user account and they could also have access to other users under their SoftLayer customer account, if they have 'Manage Users' permission in the customer portal. There are two relational properties that contain the permissions assigned to a customer user; permissions and actions. These are simply two different representations of the same information. The permissions ORM key creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Customer_CustomerPermission_Permission objects which is populated from the same data source as the actions ORM key which creates a SoftLayer_Container_Collection_Permissions collection from SoftLayer_User_Permission_Action objects.
    • SoftLayer_User_Customer_Access_Authentication
      SoftLayer_User_Customer_Access_Authentication models a single attempt to log into the SoftLayer customer portal. A SoftLayer_User_Customer_Access_Authentication record is created every time a user attempts to log into the portal. Use this service to audit your users' portal activity and diagnose potential security breaches of your SoftLayer portal accounts. Unsuccessful login attempts can be caused by an incorrect password, failing to answer or not answering a login security question if the user has them configured, or attempting to log in from an IP address outside of the user's IP address restriction list. SoftLayer employees periodically log into our customer portal as users to diagnose portal issues, verify settings and configuration, and to perform maintenance on your account or services. SoftLayer employees only log into customer accounts from the following IP ranges: * 2607:f0d0:1000::/48 * 2607:f0d0:2000::/48 * 2607:f0d0:3000::/48 * 66.228.118.67/32 * 66.228.118.86/32
    • SoftLayer_User_Customer_Access_Authentication_TokenValidation
      SoftLayer_User_Customer_Access_Authentication_TokenValidation is for logging token validations from IAM, as something distinct from a traditional 'login'. A single login to IBM Cloud/IAM as perceived by the end user, may result in many token validation calls to IMS. This is a very shallow subclass of SoftLayer_User_Customer_Access_Authentication
    • SoftLayer_User_Customer_AdditionalEmail
      The SoftLayer_User_Customer_AdditionalEmail data type contains the additional email for use in ticket update notifications.
    • SoftLayer_User_Customer_ApiAuthentication
      The SoftLayer_User_Customer_ApiAuthentication type contains user's authentication key(s).
    • SoftLayer_User_Customer_ApiAuthentication
      An account's user may obtain access to SoftLayer's API through this authentication service.
    • SoftLayer_User_Customer_CustomerPermission_Permission
      Each SoftLayer portal account is assigned a series of permissions that determine what access the user has to functions within the SoftLayer customer portal. This status is reflected in the SoftLayer_User_Customer_Status data type. Permissions differ from user status in that user status applies globally to the portal while user permissions are applied to specific portal functions.
    • SoftLayer_User_Customer_CustomerPermission_Permission
      Portal account users who are not the master user (account owner) have permissions to allow them access to portal functionalities.
    • SoftLayer_User_Customer_External_Binding
      The SoftLayer_User_Customer_External_Binding data type contains general information for a single external binding. This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service.
    • SoftLayer_User_Customer_External_Binding
      <<<
    • SoftLayer_User_Customer_External_Binding_Attribute
      The SoftLayer_User_Customer_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
    • SoftLayer_User_Customer_External_Binding_Totp
      The SoftLayer_User_Customer_External_Binding_Totp data type contains information about a single time-based one time password external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them. The information provided by this external binding data type includes: * The type of credential * The current state of the credential ** Active ** Inactive SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
    • SoftLayer_User_Customer_External_Binding_Totp
      SoftLayer provides its customers the ability to add an additional layer of security to the SoftLayer customer portal by requiring that a user login and authenticate with a trusted 3rd party before they are given access to their SoftLayer account. This is accomplished by creating an external binding for a specific vendor, in this case Time-based One Time Password. When the SoftLayer user attempts to log in to the SoftLayer customer portal they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to generate and provide a security code from their Time-based One Time Password application. Once the security code has been authenticated the user will be allowed access to the SoftLayer customer portal. The time-based one time password external binding service allows a user to create an external binding, enable, disable, and delete an external binding. Once a SoftLayer user has a valid and active time-based one time password external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
    • SoftLayer_User_Customer_External_Binding_Type
      The SoftLayer_User_Customer_External_Binding_Type data type contains information relating to a type of external authentication binding. It contains a user friendly name as well as a unique key name.
    • SoftLayer_User_Customer_External_Binding_Vendor
      The SoftLayer_User_Customer_External_Binding_Vendor data type contains information for a single external binding vendor. This information includes a user friendly vendor name, a unique version of the vendor name, and a unique internal identifier that can be used when creating a new external binding.
    • SoftLayer_User_Customer_External_Binding_Vendor
      The SoftLayer_User_Customer_External_Binding_Vendor service is used to retrieve a list of available 3rd party vendors that SoftLayer supports for external bindings.
    • SoftLayer_User_Customer_External_Binding_Verisign
      The SoftLayer_User_Customer_External_Binding_Verisign data type contains information about a single VeriSign external binding. The external binding information is used when a SoftLayer customer logs into the SoftLayer customer portal to authenticate them against a 3rd party, in this case VeriSign. The information provided by the VeriSign external binding data type includes: * The type of credential * The current state of the credential ** Enabled ** Disabled ** Locked * The credential's expiration date * The last time the credential was updated SoftLayer users with an active external binding will be prohibited from using the API for security reasons.
    • SoftLayer_User_Customer_External_Binding_Verisign
      SoftLayer provides its customers the ability to add an additional layer of security to the SoftLayer customer portal by requiring that a user login and authenticate with a trusted 3rd party before they are given access to their SoftLayer account. This is accomplished by creating an external binding for a specific vendor, in this case VeriSign. When the SoftLayer user attempts to log in to the SoftLayer customer portal they will first be prompted for their normal SoftLayer username and password. Once that information is verified they will be asked to generate and provide a security code from their VeriSign credential. Once the security code has been authenticated with VeriSign the user will be allowed access to the SoftLayer customer portal. The VeriSign external binding service allows a user to create an external binding, enable, disable, or unlock an external binding, and delete an external binding. Currently SoftLayer provides the master account user of a SoftLayer account with one free VeriSign external binding. All subsequent VeriSign external bindings will need to be created by placing an order. Once a SoftLayer user has a valid and active VeriSign external binding, they will be required to always use their credential to login to the SoftLayer customer portal. In addition any user with an active external binding will be prohibited from using the API.
    • SoftLayer_User_Customer_Invitation
    • SoftLayer_User_Customer_Invitation
    • SoftLayer_User_Customer_Link
    • SoftLayer_User_Customer_Link_TrustedProfile
    • SoftLayer_User_Customer_Link_VerifiedIamIdLinkCollection
    • SoftLayer_User_Customer_MobileDevice
      This class represents a mobile device belonging to a user. The device can be a phone, tablet, or possibly even some Android based net books. The purpose is to tie just enough info with the device and the user to enable push notifications through non-softlayer entities (Google, Apple, RIM).
    • SoftLayer_User_Customer_MobileDevice
    • SoftLayer_User_Customer_MobileDevice_OperatingSystem
      This class represents the mobile operating system installed on a user's registered mobile device. It assists us when determining the how to get a push notification to the user.
    • SoftLayer_User_Customer_MobileDevice_OperatingSystem
    • SoftLayer_User_Customer_MobileDevice_Type
      Describes a supported class of mobile device. In this the word class is used in the context of classes of consumer electronic devices, the two most prominent examples being mobile phones and tablets.
    • SoftLayer_User_Customer_MobileDevice_Type
    • SoftLayer_User_Customer_Notification_Hardware
      The Customer_Notification_Hardware object stores links between customers and the hardware devices they wish to monitor. This link is not enough, the user must be sure to also create SoftLayer_Network_Monitor_Version1_Query_Host instance with the response action set to 'notify users' in order for the users linked to that hardware object to be notified on failure.
    • SoftLayer_User_Customer_Notification_Hardware
      This service represents the link between a monitored hardware instance, and a user account. When a monitoring service on that hardware instance fails and the monitor is set to 'notify users,' any users linked to that hardware instance using this service will be notified of the failure.
    • SoftLayer_User_Customer_Notification_Virtual_Guest
      The SoftLayer_User_Customer_Notification_Virtual_Guest object stores links between customers and the virtual guests they wish to monitor. This link is not enough, the user must be sure to also create SoftLayer_Network_Monitor_Version1_Query_Host instance with the response action set to 'notify users' in order for the users linked to that Virtual Guest object to be notified on failure.
    • SoftLayer_User_Customer_Notification_Virtual_Guest
      This service represents the link between a monitored guest instance, and a user account. When a monitoring service on that guest instance fails and the monitor is set to 'notify users,' any users linked to that guest instance using this service will be notified of the failure.
    • SoftLayer_User_Customer_OpenIdConnect
    • SoftLayer_User_Customer_OpenIdConnect
    • SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
    • SoftLayer_User_Customer_OpenIdConnect_TrustedProfile
    • SoftLayer_User_Customer_Profile_Event_HyperWarp
    • SoftLayer_User_Customer_Profile_Event_HyperWarp
    • SoftLayer_User_Customer_Prospect
    • SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest
      Contains user information for Service Provider Enrollment.
    • SoftLayer_User_Customer_Prospect_ServiceProvider_EnrollRequest
    • SoftLayer_User_Customer_Prospect_Type
    • SoftLayer_User_Customer_Security_Answer
      The SoftLayer_User_Customer_Security_Answer type contains user's answers to security questions.
    • SoftLayer_User_Customer_Security_Answer
      An account's user have security answers for secondary security measures. These questions/answers can be found during login and password update. These questions/answers are also needed for password reset.
    • SoftLayer_User_Customer_Status
      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.
    • SoftLayer_User_Customer_Status
      A User's status. It can be Active, Inactive, Disabled, Delete User, or VPN Only.
    • SoftLayer_User_Employee
      A SoftLayer_User_Employee models a single SoftLayer employee for the purposes of ticket updates created by SoftLayer employees. SoftLayer portal and API users cannot see individual employee names in ticket responses. SoftLayer employees can be assigned to customer accounts as a personal support representative. Employee names and email will be available if an employee is assigned to the account.
    • SoftLayer_User_Employee_Department
      SoftLayer_User_Employee_Department models a department within SoftLayer's internal employee hierarchy. Common departments include Support, Sales, Accounting, Development, Systems, and Networking.
    • SoftLayer_User_External_Binding
      The SoftLayer_User_External_Binding data type contains general information for a single external binding. This includes the 3rd party vendor, type of binding, and a unique identifier and password that is used to authenticate against the 3rd party service.
    • SoftLayer_User_External_Binding
      <<<
    • SoftLayer_User_External_Binding_Attribute
      The SoftLayer_User_External_Binding_Attribute data type contains the value for a single attribute associated with an external binding. External binding attributes contain additional information about an external binding. An attribute can be generic or specific to a 3rd party vendor. For example these attributes relate to Verisign: *Credential Type *Credential State *Credential Expiration Date *Credential Last Update Date
    • SoftLayer_User_External_Binding_Type
      The SoftLayer_User_External_Binding_Type data type contains information relating to a type of external authentication binding. It contains a user friendly name as well as a unique key name.
    • SoftLayer_User_External_Binding_Vendor
      The SoftLayer_User_External_Binding_Vendor data type contains information for a single external binding vendor. This information includes a user friendly vendor name, a unique version of the vendor name, and a unique internal identifier that can be used when creating a new external binding.
    • SoftLayer_User_External_Binding_Vendor
      The SoftLayer_User_External_Binding_Vendor service is used to retrieve a list of available 3rd party vendors that SoftLayer supports for external bindings.
    • SoftLayer_User_Interface
      A SoftLayer_User_Interface represents a generic user instance within the SoftLayer API. The SoftLayer API uses SoftLayer_User_Interfaces in cases where a user object could be one of many types of users. Currently the [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) and [SoftLayer_User_Employee](/reference/datatypes/SoftLayer_User_Employee) classes are abstracted by this type.
    • SoftLayer_User_Permission_Action
      The SoftLayer_User_Permission_Action data type contains local attributes to identify and describe the valid actions a customer user can perform within IMS. This includes a name, key name, and description. This data can not be modified by users of IMS. It also contains relational attributes that indicate which SoftLayer_User_Permission_Group's include the action.
    • SoftLayer_User_Permission_Action
      The SoftLayer_User_Permission_Action class is one of several classes that make up the customer permission system. The system is a role-based system that includes defined actions which can be grouped together using a SoftLayer_User_Permission_Group. These groups of actions are then used to define roles, and the roles are assigned to users. When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them. User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination. Proceed with caution. The SoftLayer_User_Permission_Action class defines the permissions that are required in order for a SoftLayer_User_Customer to perform certain actions within IMS. See [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) and [SoftLayer_Permission_Role](/reference/datatypes/SoftLayer_Permission_Role) for more details.
    • SoftLayer_User_Permission_Group
      The SoftLayer_User_Permission_Group data type contains local attributes to identify and describe the permission groups that have been created within IMS. These includes a name, description, and account id. Permission groups are defined specifically for a single [SoftLayer_Account](/reference/datatypes/SoftLayer_Account). It also contains relational attributes that indicate what SoftLayer_User_Permission_Action objects belong to a particular group, and what SoftLayer_User_Permission_Role objects the group is linked.
    • SoftLayer_User_Permission_Group
      The SoftLayer_User_Permission_Group class is one of several classes that make up the customer permission system. It is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users. The SoftLayer_User_Permission_Group is also used to track the resources or account devices to which a user has been granted access. The types of resources that users can be granted access is defined in [SoftLayer_User_Permission_Resource_Type](/reference/datatypes/SoftLayer_User_Permission_Resource_Type). When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them. This is also true for device access. Either, the UI can be used to track the devices to which users are granted access which will use the SYSTEM group, or the api can be used, making the UI information inaccurate. User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination. Proceed with caution. One or more [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) are assigned to one or more SoftLayer_User_Permission_Group Objects. One ore more SoftLayer_User_Permission_Group objects can be linked to a [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role). A single SoftLayer_User_Permission_Group object can be linked to multiple SoftLayer_User_Permission_Role objects. The [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role) is assigned to one or more [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer). The [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) class defines the permissions that are required in order for a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) to perform certain actions within IMS. Resources belonging to the user's account can also be linked to permission groups. See [SoftLayer_User_Permission_Resource_Type](/reference/datatypes/SoftLayer_User_Permission_Resource_Type).
    • SoftLayer_User_Permission_Group_Type
      These are the attributes which describe a SoftLayer_User_Permission_Group_Type. All SoftLayer_User_Permission_Group objects must be linked to one of these types. For further information see: [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group).
    • SoftLayer_User_Permission_Group_Type
      The SoftLayer_User_Permission_Group_Type class is one of several classes that make up the customer permission system. This class defines the valid group types. The SYSTEM group type is reserved for internal use. It is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users. When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Group and SoftLayer_User_Permission_Role is created specifically for the user with a group type of SYSTEM. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them.
    • SoftLayer_User_Permission_Resource_Type
      These are the variables relating to SoftLayer_User_Permission_Resource_Type. Collectively they describe the types of resources which can be linked to [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group).
    • SoftLayer_User_Permission_Resource_Type
      The SoftLayer_User_Permission_Resource_Type class is one of several classes that make up the customer permission system. The permission system is used to track the permissions assigned to each customer user. These permissions can also include tracking the devices to which users are granted access. The SoftLayer_User_Permission_Resource_Type class is used to define the valid types of resources to which users can be granted access. Hardware server is an example of a resource type. See [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) for more information on tracking device access.
    • SoftLayer_User_Permission_Role
      The SoftLayer_User_Permission_Role data type contains local attributes to identify and describe the permission roles that have been created within IMS. These includes a name, description, and account id. Permission groups are defined specifically for a single [SoftLayer_Account](/reference/datatypes/SoftLayer_Account). It also contains relational attributes that indicate what SoftLayer_User_Permission_Group objects are linked to a particular role, and the SoftLayer_User_Customer objects assigned to the role.
    • SoftLayer_User_Permission_Role
      The SoftLayer_User_Permission_Role class is one of several classes that make up the customer permission system. The system is a role-based system that includes defined actions which can be 'grouped' together using a SoftLayer_User_Permission_Group class. These groups of actions are then used to define roles, and the roles are assigned to users. When a [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer) is created, a SoftLayer_User_Permission_Role is created for the user with a group type of SYSTEM. This role is linked to the SYSTEM SoftLayer_User_Permission_Group that was also created specifically for this user. When the UI is used to alter the permissions of a customer user, the actions are added or removed from this group. The api can not be used to alter the permissions in this group. If an account wants to create their own unique permission groups and roles, the UI can not be used to manage them. User Customers can be assigned to multiple roles but it is recommended to either use the UI for managing account users permissions or only use the api. Mixing the two will lead to confusing results as the UI will not show any permissions assigned to a user via a customer created role/group combination. Proceed with caution. One or more [SoftLayer_User_Permission_Action](/reference/datatypes/SoftLayer_User_Permission_Action) are assigned to one or more [SoftLayer_User_Permission_Group](/reference/datatypes/SoftLayer_User_Permission_Group) Objects. One ore more SoftLayer_User_Permission_Group objects can be linked to a [SoftLayer_User_Permission_Role](/reference/datatypes/SoftLayer_User_Permission_Role). A single SoftLayer_User_Permission_Group object can be linked to multiple SoftLayer_User_Permission_Role objects. The SoftLayer_User_Permission_Role is assigned to one or more [SoftLayer_User_Customer](/reference/datatypes/SoftLayer_User_Customer). A single SoftLayer_User_Customer can be assigned to one or more roles. The SoftLayer_User_Permission_Action class defines the permissions that are required in order for a SoftLayer_User_Customer to perform certain actions within IMS.
    • SoftLayer_User_Preference
      The SoftLayer_User_Preference data type contains a single user preference to a specific preference type.
    • SoftLayer_User_Preference_Type
      The SoftLayer_User_Preference_Type data type contains a single preference type including the accepted values.
    • SoftLayer_User_Security_Question
      The SoftLayer_User_Security_Question data type contains questions.
    • SoftLayer_User_Security_Question
      Every user has an option of a secondary security login feature. This SoftLayer_User_Security_Question service provides a list of security questions.
    • turnOffMasterUserPermissionCheckMode
      This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an 'alternate/auxiliary master user / account owner'.
    • turnOffMasterUserPermissionCheckMode
      This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an 'alternate/auxiliary master user / account owner'.
    • turnOffMasterUserPermissionCheckMode
      This method allows the master user of an account to undo the designation of this user as an alternate master user. This can not be applied to the true master user of the account. Note that this method, by itself, WILL NOT affect the IAM Policies granted this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner turns off an 'alternate/auxiliary master user / account owner'.
    • turnOnMasterUserPermissionCheckMode
      This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have 'all the same IMS permissions as a master user'. Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an 'alternate/auxiliary master user / account owner'.
    • turnOnMasterUserPermissionCheckMode
      This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have 'all the same IMS permissions as a master user'. Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an 'alternate/auxiliary master user / account owner'.
    • turnOnMasterUserPermissionCheckMode
      This method allows the master user of an account to designate this user as an alternate master user. Effectively this means that this user should have 'all the same IMS permissions as a master user'. Note that this method, by itself, WILL NOT affect the IAM Policies granted to this user. This API is not intended for general customer use. It is intended to be called by IAM, in concert with other actions taken by IAM when the master user / account owner designates an 'alternate/auxiliary master user / account owner'.
    • unlinkGroup
      Unlinks a SoftLayer_User_Permission_Group object to the role.
    • unlinkRole
      Removes a link from SoftLayer_User_Permission_Role object to the group.
    • unlock
      If a VeriSign credential becomes locked because of too many failed login attempts the unlock method can be used to unlock a VeriSign credential. As a security precaution a valid security code generated by the credential will be required before the credential is unlocked.
    • updateNote
      Update the note of an external binding. The note is an optional property that is used to store information about a binding.
    • updateNote
      Update the note of an external binding. The note is an optional property that is used to store information about a binding.
    • updateNote
      Update the note of an external binding. The note is an optional property that is used to store information about a binding.
    • updateNote
      Update the note of an external binding. The note is an optional property that is used to store information about a binding.
    • updateNotificationSubscriber
      Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.
    • updateNotificationSubscriber
      Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.
    • updateNotificationSubscriber
      Update the active status for a notification that the user is subscribed to. A notification along with an active flag can be supplied to update the active status for a particular notification subscription.
    • updateSecurityAnswers
      Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.
    • updateSecurityAnswers
      Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.
    • updateSecurityAnswers
      Update a user's login security questions and answers on the SoftLayer customer portal. These questions and answers are used to optionally log into the SoftLayer customer portal using two-factor authentication. Each user must have three distinct questions set with a unique answer for each question, and each answer may only contain alphanumeric or the . , - _ ( ) [ ] : ; > < characters. Existing user security questions and answers are deleted before new ones are set, and users may only update their own security questions and answers.
    • updateSubscriberDeliveryMethod
      Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • updateSubscriberDeliveryMethod
      Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • updateSubscriberDeliveryMethod
      Update a delivery method for a notification that the user is subscribed to. A delivery method keyName along with an active flag can be supplied to update the active status of the delivery methods for the specified notification. Available delivery methods - 'EMAIL'. Available notifications - 'PLANNED_MAINTENANCE', 'UNPLANNED_INCIDENT'.
    • updateVpnPassword
      Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN 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 Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.
    • updateVpnPassword
      Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN 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 Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.
    • updateVpnPassword
      Update a user's VPN password on the SoftLayer customer portal. As with portal passwords, VPN passwords must match the following restrictions. VPN 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 Finally, users can only update their own VPN password. An account's master user can update any of their account users' VPN passwords.
    • updateVpnUser
      Always call this function to enable changes when manually configuring VPN subnet access.
    • updateVpnUser
      Always call this function to enable changes when manually configuring VPN subnet access.
    • updateVpnUser
      Always call this function to enable changes when manually configuring VPN subnet access.
    • validateAuthenticationToken
      This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [SoftLayer_Container_User_Customer_Portal_Token](/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token) object
    • validateAuthenticationToken
      This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [SoftLayer_Container_User_Customer_Portal_Token](/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token) object
    • validateAuthenticationToken
      This method validate the given authentication token using the user id by comparing it with the actual user authentication token and return [SoftLayer_Container_User_Customer_Portal_Token](/reference/datatypes/SoftLayer_Container_User_Customer_Portal_Token) object
    • validateCredentialId
      Validate the user id and VeriSign credential id used to create an external authentication binding.