SoftLayer_User_Customer_OpenIdConnect


SoftLayer_User_Customer_OpenIdConnect

Description

Methods

activateOpenIdConnectUser

Completes invitation process for an OIDC user initiated by the

addApiAuthenticationKey

Create a user's API authentication key.

addBulkDedicatedHostAccess

Grant access to the user for one or more dedicated hosts devices.

addBulkHardwareAccess

Add multiple hardware to a portal user's hardware access list.

addBulkPortalPermission

Add multiple permissions to a portal user's permission set.

addBulkVirtualGuestAccess

Add multiple CloudLayer Computing Instances to a portal user's access list.

addDedicatedHostAccess

Grant access to the user for a single dedicated host device.

addHardwareAccess

Add hardware to a portal user's hardware access list.

addNotificationSubscriber

Create a notification subscription record for the user.

addPortalPermission

Add a permission to a portal user's permission set.

addVirtualGuestAccess

Add a CloudLayer Computing Instance to a portal user's access list.

assignNewParentId

Assign a different parent to this user.

changePreference

Change preference values for the current user

checkExternalAuthenticationStatus

Checks if an external authentication is complete or not

checkPhoneFactorAuthenticationForPasswordSet

Check the status of an outstanding Phone Factor Authentication for Password Set

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.

createObject

Create a new user record.

createOpenIdConnectUserAndCompleteInvitation

Completes invitation processing when a new OpenIdConnect user must be created and return an access token.

createSubscriberDeliveryMethods

Create delivery methods for the subscriber.

deactivateNotificationSubscriber

Delete a subscriber for a given resource.

declineInvitation

Sets a customer invitation as declined.

editObject

Update a user's information.

editObjects

Update a collection of users’ information

getAccount

Retrieve the customer account that a user belongs to.

getActiveExternalAuthenticationVendors

Get a list of active external authentication vendors for a SoftLayer user.

getAdditionalEmails

Retrieve a portal user's additional email addresses. These email addresses are contacted when updates are made to support tickets.

getApiAuthenticationKeys

Retrieve a portal user's API Authentication keys. There is a max limit of one API key per user.

getChildUsers

Retrieve a portal user's child users. Some portal users may not have child users.

getClosedTickets

Retrieve an user's associated closed tickets.

getDedicatedHosts

Retrieve the dedicated hosts to which the user has been granted access.

getDefaultAccount

Retrieve the default account for the OpenIdConnect identity that is linked to the current active SoftLayer user identity.

getExternalBindings

Retrieve the external authentication bindings that link an external identifier to a SoftLayer user.

getHardware

Retrieve a portal user's accessible hardware. These permissions control which hardware a user has access to in the SoftLayer customer portal.

getHardwareCount

Retrieve the current number of servers a portal user has access to.

getHardwareNotifications

Retrieve 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

Retrieve whether or not a user has acknowledged the support policy.

getHasFullDedicatedHostAccessFlag

Retrieve permission granting the user access to all Dedicated Host devices on the account.

getHasFullHardwareAccessFlag

Retrieve whether or not a portal user has access to all hardware on their account.

getHasFullVirtualGuestAccessFlag

Retrieve whether or not a portal user has access to all hardware on their account.

getLocale

Retrieve a user's locale. Locale holds user's language and region information.

getLoginAccountInfoOpenIdConnect

Get account for an active user logging into the SoftLayer customer portal

getLoginAttempts

Retrieve a user's attempts to log into the SoftLayer customer portal.

getLoginToken

Authenticate a user for the SoftLayer customer portal

getMappedAccounts

Retrieve a list of all active accounts that belong to this customer.

getMobileDevices

Retrieve a portal user's associated mobile device profiles.

getNotificationSubscribers

Retrieve notification subscription records for the user.

getObject

Retrieve a SoftLayer_User_Customer_OpenIdConnect record.

getOpenIdConnectMigrationState

Get the OpenId migration state

getOpenIdRegistrationInfoFromCode

Get OpenId User Registration details from the provided email code

getOpenTickets

Retrieve an user's associated open tickets.

getOverrides

Retrieve a portal user's vpn accessible subnets.

getParent

Retrieve a portal user's parent user. If a SoftLayer_User_Customer has a null parentId property then it doesn't have a parent user.

getPermissions

Retrieve a portal user's permissions. These permissions control that user's access to functions within the SoftLayer customer portal and API.

getPortalLoginToken

Authenticate a user for the SoftLayer customer portal

getPortalLoginTokenOpenIdConnect

Authenticate a user for the SoftLayer customer portal via an openIdConnect provider.

getPreference

Get a preference value for the current user

getPreferenceTypes

Get all available preference types

getRequirementsForPasswordSet

Retrieve the authentication requirements for a user when attempting

Retrieve [DEPRECATED]

getSecurityAnswers

Retrieve 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

Retrieve a user's notification subscription records.

getSuccessfulLogins

Retrieve a user's successful attempts to log into the SoftLayer customer portal.

getSupportPolicyAcknowledgementRequiredFlag

Retrieve whether or not a user is required to acknowledge the support policy for portal access.

getSupportedLocales

Returns all supported locales for the current user

getSurveyRequiredFlag

Retrieve whether or not a user must take a brief survey the next time they log into the SoftLayer customer portal.

getSurveys

Retrieve the surveys that a user has taken in the SoftLayer customer portal.

getTickets

Retrieve an user's associated tickets.

getTimezone

Retrieve a portal user's time zone.

getUnsuccessfulLogins

Retrieve a user's unsuccessful attempts to log into the SoftLayer customer portal.

getUserForUnifiedInvitation

Get the IMS User Object for the provided OpenIdConnect User ID, or (Optional) IBMid Unique Identifier.

getUserIdForPasswordSet

Retrieve a user id using a password request key

getUserStatus

Retrieve a portal user's status, which controls overall access to the SoftLayer customer portal and VPN access to the private network.

getVirtualGuestCount

Retrieve the current number of CloudLayer Computing Instances a portal user has access to.

getVirtualGuests

Retrieve 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.

initiateExternalAuthentication

Initiates an external authentication using the given authentication container.

initiatePortalPasswordChange

Request email to allow user to change their password

initiatePortalPasswordChangeByBrandAgent

Allows a Brand Agent to request password reset email to be sent to

inviteUserToLinkOpenIdConnect

Send email invitation to a user to join a SoftLayer account and authenticate with OpenIdConnect.

isMasterUser

Determine if a portal user is a master user.

isValidPortalPassword

Determine if a string is a user's portal password.

performExternalAuthentication

Perform an external authentication using the given authentication container.

processPasswordSetRequest

Set the password for a user who has a valid password request key

removeAllDedicatedHostAccessForThisUser

Revoke access to all dedicated hosts on the account for this user.

removeAllHardwareAccessForThisUser

Remove all hardware from a portal user's hardware access list.

removeAllVirtualAccessForThisUser

Remove all cloud computing instances from a portal user's instance access list.

removeApiAuthenticationKey

Remove a user's API authentication key.

removeBulkDedicatedHostAccess

Revoke access for the user for one or more dedicated hosts devices.

removeBulkHardwareAccess

Remove multiple hardware from a portal user's hardware access list.

removeBulkPortalPermission

Remove multiple permissions from a portal user's permission set.

removeBulkVirtualGuestAccess

Remove multiple CloudLayer Computing Instances from a portal user's access list.

removeDedicatedHostAccess

Revoke access for the user to a single dedicated hosts device.

removeExternalBinding

Remove an external binding from this user.

removeHardwareAccess

Remove hardware from a portal user's hardware access list.

removePortalPermission

Remove a permission from a portal user's permission set.

removeVirtualGuestAccess

Remove a CloudLayer Computing Instance from a portal user's access list.

setDefaultAccount

Sets the default account for the OpenIdConnect identity that is linked to the current SoftLayer user identity.

silentlyMigrateUserOpenIdConnect

This api is used to migrate a user to IBMid without sending an invitation.

updateNotificationSubscriber

Update the active status for a notification subscription.

updateSecurityAnswers

Update portal login security questions and answers.

updateSubscriberDeliveryMethod

Update a delivery method for the subscriber.

updateVpnPassword

Update a user's VPN password

updateVpnUser

Creates or updates a user's VPN access privileges.