/Account/CreateWebForm
Creates an agent account on the server manually (and logs in to it). This account can be used when logging in, using the Agent API, but also to connect to the Neuron® using any of the available XMPP bindings available. The account that is created, is considered a regular XMPP account on the broker.
When first created, the account is in a disabled state. You need to validate the e-mail address provided in the request first (and the phone number, if providing a phone number), before the account can be enabled. An e-mail with a verification code will be sent to the e-mail address provided in the request. If providing a phone number, an SMS will be sent to the phone number.
Note: To use this function, you need to configure the Neuron® for use with Google Recaptcha, to protect against malicious account creation. This can be done using the same configuration as is used by the Feedback page. This also means, that when POSTing the request to the resource, it will be posted as a web form, not JSON or XML, as with most of the the other resources defined in this API. You also provide a redirection URL to redirect the user, upon successful creation of an account.
Security Notice: To create accounts on the Neuron®, an API Key is required. This resource requires an API Key to be generated on the Neuron®, with the Owner set to Agent API. If no such key is available, or if the account limit configured in the key is reached, no more accounts can be generated using this resource until such a key is created or its limit increased. You can disable account creation using this resource, by simply removing any such API Key configured, or setting the limit at the number of accounts already created using the API Key. The following table shows if such a key is available, and if accounts can be created using this resource.
| Agent API Key Information | |
|---|---|
| Key configured: | Yes |
| Account Limit: | 100 |
| Account Created: | 9 |
| Account Deleted: | 0 |
| Account Left: | 91 |
Input Parameters
| Parameter | Description |
|---|---|
UserName |
User Name of the account to create. |
EMail |
e-Mail address of the user. |
PhoneNr |
Phone number of the user. |
Password |
Password to use. |
RedirectionUrl |
URL to redirect client to, upon successful creation of account. |
g-recaptcha-response |
Proof by Google Recaptcha that the user is a human user. |
Output Parameters
As the resource generates a temporary redirection to the URL specified in the request, there are no response with parameters sent to the client, and so the Agent API is not aware of the current state of the login. Instead, the generated JSON Web Token (or JWT) is stored in a session variable on the server side until it is fetched by the client. In order to fetch the token, and register it properly with the Javascript Library, call the GetSessionToken resource from the page to which the client is redirected on successful creation.
Alternative Name Suggestions
If unable to create an account, suggestions for alternative account names will be returned as HTTP headers, with header names X-AlternativeNameN, where N is a random number starting with 1. Digits will be two or more digits.
Javascript Library
You can use this resource in conjunction with the Javascript Library, via the callback URL. The below form redirects the user to the Get Session Token page after account creation, as an example. This redirection information is provided to the API via a hidden input parameter in the form. On that page, you can get the token generated during the creation to properly login.