Deprecated. Registers the user, so that the user can log in and perform authenticated actions. As of version 8.4, this operation is replaced by POST /api/users/completeSignup (extended functionality, different headers). The pre-existing operation is supported for backwards compatibility, but it's best to use the new operation instead.
Before: The user clicks the signup code in the notification email, and then puts in the password. Those actions serve to validate the user input; processing of the new user registration can now be completed by means of the completeSignup operation.
After: When this operation is complete, the user is logged in and can begin using the Akana API Platform.
This operation can be used in two ways:
- The operation sends a signup code from a signup email.
- The operation sends no signup code (signupCode=). In this case, the currently authenticated third-party user (for example, a Google or Facebook user) will be used to complete the authentication process.
After a successful call, any subsequent attempt to sign up using the same email address results in an error.
Authorization Roles/Permissions: Anyone can use this operation; login is not required. This is because the operation is used in the signup process.
This topic includes the following sections:
The example below shows the password and signup code passed as URL parameters. In this example the user is completing the Akana API Platform signup process rather than using Google® or Facebook®.
Sample request headers
Accept: */* Content-Type: application/x-www-form-urlencoded; charset=UTF-8
Sample request body
None: the content is passed in URL parameters.
For general information on request header values, refer to HTTP Request Headers.
|Accept||application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json|
|Parameter||Parm Type||Data Type||Required||Description|
|signupCode||Form||string||Conditional||The signup code that was emailed to the email account used in the signupUser API. This is not required for third-party authentication registration.|
|password||Form||string||Conditional||The password that was initially used during the signup process. This is not required for third-party authentication registration.|
|firstName||Form||string||Required||The user's first name.|
|lastName||Form||string||Required||The user's last name.|
|emailAddress||Form||string||Required||The user's email address.|
|signupAgreementsAccepted||Form||boolean||Required||Indicates whether the user has accepted the required signup agreements, if there are any. Defaults to false.|
|countryCode||Form||string||Conditional||The country code for the user's phone number to be used in authentication. Required if two-factor authentication is turned on.|
|phoneNumber||Form||string||Conditional||The user's phone number to be used in authentication. Required if two-factor authentication is turned on.|
If successful, this operation returns HTTP status code 200. There is no response body.
The sample response below shows that the message was successful since HTTP code 200 is returned in the header.
Sample response headers
HTTP/1.1 200 OK Date: Mon, 17 Sep 2012 23:31:17 GMT Set-Cookie: AtmoAuthToken_acme=TokenID%3Dc7a5ecab-011f-11e2-8920-facd34229ee6 %2Cclaimed_id%3Durn%3Aacme%3Auser%3Aacme%3Auser10015%2CissueTime %3D1347924677986%2CexpirationTime%3D1347926477969%2CAttributesIncluded%3Dtrue %2CUserFDN%3Duser10015.acmepaymentscorp%2CUserName%3DJaneSaoirse%2Csig%3DRSxPijSfkfAqQbP1T ZFNJfYd1NUjvb4iBZPJvYvfeYmtYNJPNs3743nUN9mRU4dvnkjbY_mNaw1fTJXhcAg5pk0Y8oKcbHyIGTfskn P86SeI6WCDCfucYyEJspsL1RQGg-Hp-5-C3dHzR_aS1MTxdGEmvDlrQ4BwdOb-zEr7yjQ;path=/; expires=Mon, 17-Sep-2012 23:56:17 GMT;HttpOnly;Version=1
Sample response body
For general information on response header values, refer to HTTP Response Headers.
Any one of the following media types is valid for the request Content-Type:
application/json, application/vnd.soa.v71+json, application/vnd.soa.v72+json, application/vnd.soa.v80+json, application/vnd.soa.v81+json
|Set-Cookie||The set-cookie response header sets, updates, or expires the platform cookie to reflect changes made by the operation.|
If the call is unsuccessful an error code/message is returned. One or more examples of possible errors for this operation are shown below.
If the user has already completed the signup registration process, this operation returns an error.
|500||An error occurred processing the call.|