getPortalLoginTokenOpenIdConnect

Classes SoftLayer_User_Customer_OpenIdConnect
Tags method sldn user

SoftLayer_User_Customer_OpenIdConnect::getPortalLoginTokenOpenIdConnect

Deprecated

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

Description

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.

Parameters

Name Type Description
providerType string A value representing the OpenID Connect provider type.
accessToken string The OpenID Connect access token which provides temporary access to a resource by the
accountId int The preferred Softlayer account to query, if not provided a default will be used.
securityQuestionId int A security question you wish to answer when authenticating to the SoftLayer customer portal. This parameter isn’t required if no security questions are set on your portal account or if your account is configured to not require answering a security account upon login.
securityQuestionAnswer string The answer to your security question.

Required Headers

Optional Headers

  • None

Return Values

Error Handling

  • Throw the exception “Invalid answer provided for security question.” if the given security question and answer are invalid and the user is required to answer security questions on portal login. 
curl -g -u $SL_USER:$SL_APIKEY -X POST -d '{"parameters": [string, string, int, int, string]}' \
'https://api.softlayer.com/rest/v3.1/SoftLayer_User_Customer_OpenIdConnect/getPortalLoginTokenOpenIdConnect'