editor
725
edits
Changes
Jump to navigation
Jump to search
ConfirmRegistrationEmail (view source)
Revision as of 18:53, 1 September 2014
, 18:53, 1 September 2014Created page with "{{Api_Method_Spec| Description=Confirm the registration by challenge code and e-mail. This method confirm the user registration using an email and a challenge code to complet..."
{{Api_Method_Spec|
Description=Confirm the registration by challenge code and e-mail.
This method confirm the user registration using an email and a challenge code to complete the registration and allow the user to access the platform.
NOTE: There are two requirements to use this method:
- The user should be inactive or a different status of Active.
- The user status cannot be AwaitingEmailConfirmation.
Then, a verification of challenge code is made and change the currently status to Active.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=challenge
|ParamType=String
|ParamRequired=required
|ParamDescription=The challenge code created to register the Trusted Device.
}}
{{Api_Parameter|
ParamName=email
|ParamType=String
|ParamRequired=required
|ParamDescription=The user email already used in his registration.
}}
|Returns=
Returns a JSON object containing true for success.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #219;">"true"</span>
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
Description=Confirm the registration by challenge code and e-mail.
This method confirm the user registration using an email and a challenge code to complete the registration and allow the user to access the platform.
NOTE: There are two requirements to use this method:
- The user should be inactive or a different status of Active.
- The user status cannot be AwaitingEmailConfirmation.
Then, a verification of challenge code is made and change the currently status to Active.
|Parameters=
{{Api_Parameter|
ParamName=token
|ParamType=String
|ParamRequired=required
|ParamDescription=A valid token for identifying the API session context. The token can be anonymous or logged.
}}
{{Api_Parameter|
ParamName=challenge
|ParamType=String
|ParamRequired=required
|ParamDescription=The challenge code created to register the Trusted Device.
}}
{{Api_Parameter|
ParamName=email
|ParamType=String
|ParamRequired=required
|ParamDescription=The user email already used in his registration.
}}
|Returns=
Returns a JSON object containing true for success.
'''Example:'''
{
: <span style="color: #a11;">"StatusCode"</span>: <span style="color: #164;">0</span>,
: <span style="color: #a11;">"Severity"</span>: <span style="color: #164;">1</span>,
: <span style="color: #a11;">"StatusMessage"</span>: <span style="color: #164;">"OK"</span>,
: <span style="color: #a11;">"Content"</span>: <span style="color: #219;">"true"</span>
}
|Exceptions=
* None
|Cache=
This method is not cached.
|KnownIssues=
* None
|VersionHistory=
{{{!}} border="2" style="width:800px;" cellpadding="5" cellspacing="0"
{{!}}- style="background:#88ccff;font-size:110%"
! API Version Number
! Change description
! Changes author
{{!}}- valign="top"
! 1.0
{{!}} Initial method design
{{!}} Harley Cabral
{{!}}}
|SeeAlso=
}}
