This section lists out and describes the operations that are available in the User Information Recovery API .
The User Information Recovery API enables recovering user information during user authentication through various features such as captcha and challenge questions.
API operations
confirmUserSelfRegistration
Description
This operation confirms the self registered user account and unlocks it.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This the user name of the user.
code
[String]
: This is the confirmation code send to the user.
captcha
[Captcha]
: This the captcha code. It uncludes imagePath
, secretKey
, and UserAnswer
.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org" xmlns:xsd="http://beans.mgt.captcha.carbon.wso2.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:confirmUserSelfRegistration>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->
<ser:code>?</ser:code>
<!--Optional:-->
<ser:captcha>
<!--Optional:-->
<xsd:imagePath></xsd:imagePath>
<!--Optional:-->
<xsd:secretKey></xsd:secretKey>
<!--Optional:-->
<xsd:userAnswer>></xsd:userAnswer>
</ser:captcha>
<!--Optional:-->
<ser:tenantDomain></ser:tenantDomain>
</ser:confirmUserSelfRegistration>
</soapenv:Body>
</soapenv:Envelope>
getAllChallengeQuestions
Description
This operation retrieves all the challenge questions.
Permission Level
/permission/admin/login
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:getAllChallengeQuestions/>
</soapenv:Body>
</soapenv:Envelope>
getCaptcha
Description
This operation retrieves the captcha code.
Permission Level
/permission/admin/login
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:getCaptcha/>
</soapenv:Body>
</soapenv:Envelope>
getUserChallengeQuestion
Description
This operation retrieves the challenge question for the user.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name of the user.
confirmation
[String]
: This is the confirmation code that is sent to the user.
questionId
[String]
: This is the question Id.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:getUserChallengeQuestion>
<!--Optional:-->
<ser:userName></ser:userName>
<!--Optional:-->
<ser:confirmation></ser:confirmation>
<!--Optional:-->
<ser:questionI></ser:questionId>
</ser:getUserChallengeQuestion>
</soapenv:Body>
</soapenv:Envelope>
getUserChallengeQuestionIds
Description
This operation retrieves the challenge question Ids.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name of the user.
confirmation
[String]
: This is the confirmation code send to the user.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:getUserChallengeQuestionIds>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->
<ser:confirmation>?</ser:confirmation>
</ser:getUserChallengeQuestionIds>
</soapenv:Body>
</soapenv:Envelope>
getUserIdentitySupportedClaims
Description
This operation retrieves the the user-supported claims.
Permission Level
/permission/admin/login
Input Parameters
dialect
[String]
: This is the claim dialect.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:getUserIdentitySupportedClaims>
<!--Optional:-->
<ser:dialect></ser:dialect>
</ser:getUserIdentitySupportedClaims>
</soapenv:Body>
</soapenv:Envelope>
registerUser
Description
This operation registers a user in the system. The account will be locked if the Authentication.Policy.Account.Lock.On.Creation
property is set to true
, otherwise the user will be able to login after registration.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name of the user.
password
[String]
: This is the user password.
claims
[UserIdentityClaim[]]
: These are user claims. Includes claimUri
and claimValue
.
profileName
[String]
: This is the user profile name.
tenantDomain
[String]
: This is the user's tenant domain.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org" xmlns:xsd="http://dto.mgt.identity.carbon.wso2.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:registerUser>
<!--Optional:-->
<ser:userName></ser:userName>
<!--Optional:-->
<ser:password></ser:password>
<!--Zero or more repetitions:-->
<ser:claims>
<!--Optional:-->
<xsd:claimUri></xsd:claimUri>
<!--Optional:-->
<xsd:claimValue></xsd:claimValue>>
</ser:claims>
<!--Optional:-->
<ser:profileName></ser:profileName>
<!--Optional:-->
<ser:tenantDomain></ser:tenantDomain>
</ser:registerUser>
</soapenv:Body>
</soapenv:Envelope>
resendSignUpConfirmationCode
Description
This operation resend the self sign up confirmation code when the user has not received the email properly.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
code
[String]
: This is the confirmation code that is sent to the user.
tenantDomain
[String]
: This is user's tenant domain.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:resendSignUpConfirmationCode>
<!--Optional:-->
<ser:userName></ser:userName>
<!--Optional:-->
<ser:code>?</ser:code>
<!--Optional:-->
<ser:profileName></ser:profileName>
<!--Optional:-->
<ser:tenantDomain></ser:tenantDomain>
</ser:resendSignUpConfirmationCode>
</soapenv:Body>
</soapenv:Envelope>
sendRecoveryNotification
Description
This operation sends the recovery notification.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
key
[String]
: This is the confirmation key that is sent to the user.
notificationType
[String]
: This is the notification type.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:sendRecoveryNotification>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->>
<ser:key>?</ser:key>
<!--Optional:-->
<ser:notificationType></ser:notificationType>
</ser:sendRecoveryNotification>
</soapenv:Body>
</soapenv:Envelope>
updatePassword
Description
This operation updates the password in the system for password recovery process. Before calling this method, the caller needs to call the verifyConfirmationCode()
method and get the newly generated confirmation code.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
confirmationCode
[String]
: This is the confirmation code that is sent to the user.
newPassword
[String]
: This is the user's new password.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:updatePassword>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->
<ser:confirmationCode></ser:confirmationCode>
<!--Optional:-->
<ser:newPassword></ser:newPassword>
</ser:updatePassword>
</soapenv:Body>
</soapenv:Envelope>
verifyAccount
Description
This operation verifies the user against the provided claims and captcha information.
Permission Level
/permission/admin/login
Input Parameters
claims
[UserIdentityClaim[] ]
: These are user claims. Includes claimUri
and claimValue
.
captcha
[Captcha]
: This is the captcha code. Includes imagePath
, secretKey
, and UserAnswer
.
tenantDomain
[String]
: This is the user's tenant domain.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org" xmlns:xsd="http://dto.mgt.identity.carbon.wso2.org/xsd" xmlns:xsd1="http://beans.mgt.captcha.carbon.wso2.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:verifyAccount>
<!--Zero or more repetitions:-->
<ser:claims>
<!--Optional:-->
<xsd:claimUri></xsd:claimUri>
<!--Optional:-->
<xsd:claimValue></xsd:claimValue>
</ser:claims>
<!--Optional:-->
<ser:captcha>
<!--Optional:-->
<xsd1:imagePath></xsd1:imagePath>
<!--Optional:-->
<xsd1:secretKey></xsd1:secretKey>
<!--Optional:-->
<xsd1:userAnswer></xsd1:userAnswer>
</ser:captcha>
<!--Optional:-->
<ser:tenantDomain></ser:tenantDomain>
</ser:verifyAccount>
</soapenv:Body>
</soapenv:Envelope>
verifyConfirmationCode
Description
This operation verifies the confirmation code supplied by user. This invalidates the current code, generates a new code and sends it to the user.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
code
[String]
: This is the confirmation code that is sent to the user.
captcha
[Captcha]
: This is the captcha code. Includes imagePath
, secretKey
, and UserAnswer
.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org" xmlns:xsd="http://beans.mgt.captcha.carbon.wso2.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:verifyConfirmationCode>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->
<ser:code>?</ser:code>
<!--Optional:-->
<ser:captcha>
<!--Optional:-->
<xsd:imagePath></xsd:imagePath>>
<!--Optional:-->
<xsd:secretKey></xsd:secretKey>
<!--Optional:-->
<xsd:userAnswer></xsd:userAnswer>
</ser:captcha>
</ser:verifyConfirmationCode>
</soapenv:Body>
</soapenv:Envelope>
Response
See below
verifyUser
Description
This operation verifies the user against the captcha code.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
captcha
[Captcha]
: This is the captcha code. Includes imagePath
, secretKey
, and UserAnswer
.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org" xmlns:xsd="http://beans.mgt.captcha.carbon.wso2.org/xsd">
<soapenv:Header/>
<soapenv:Body>
<ser:verifyUser>
<!--Optional:-->
<ser:username></ser:username>
<!--Optional:-->
<ser:captcha>
<!--Optional:-->
<xsd:imagePath></xsd:imagePath>
<!--Optional:-->
<xsd:secretKey></xsd:secretKey>
<!--Optional:-->
<xsd:userAnswer></xsd:userAnswer>
</ser:captcha>
</ser:verifyUser>
</soapenv:Body>
</soapenv:Envelope>
verifyUserChallengeAnswer
Description
This operation verifies the user against the challenge question.
Permission Level
/permission/admin/login
Input Parameters
userName
[String]
: This is the user name.
confirmation
[String]
: This is the confirmation code that is sent to the user.
questionId
[String]
: This is the question Id.
answer
[String]
: This is the answer to the question.
Request
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ser="http://services.mgt.identity.carbon.wso2.org">
<soapenv:Header/>
<soapenv:Body>
<ser:verifyUserChallengeAnswer>
<!--Optional:-->
<ser:userName></ser:userName>
<!--Optional:-->
<ser:confirmation></ser:confirmation>
<!--Optional:-->
<ser:questionId></ser:questionId>
<!--Optional:-->
<ser:answer></ser:answer>
</ser:verifyUserChallengeAnswer>
</soapenv:Body>
</soapenv:Envelope>
Top