Creating a Form

REST API Equivalent. You can use the /config/{app}/flows/{flow}/forms endpoint and the POST method to create a new form.


Important. The ability to create your own forms is a relatively new addition to the Akamai Identity Cloud, and is aimed primarily at organizations employing the Identity Cloud Authentication APIs to manage authentication and authorization of their site. Custom forms can be used with the JavaScript SDK, but custom forms can't be used with Hosted Login: that's because Hosted Login doesn't provide a method for incorporating custom forms. However, you can modify the forms that ship with Hosted Login; you just can't create new forms (or at least make use of those new forms).


To create a form, go to the Forms tab and click Create New Form:

On the Create Form page, enter a name for the form in the Name field, then click the Form Type dropdown and select the type of form the new form will be based on:

Before you ask, yes. your form must use one of the following predefined form types; at this point in time there is no provision for creating a truly custom form:

  • Account Deactivation
  • Password Reset
  • Profile Update
  • Social Registration
  • Traditional Registration
  • Traditional Signin
  • Verify Email

Note. And choose wisely: once created, form types can't be changed.

Believe it or not, those are the only requirements for creating a form; if you want to, you can click Save and save the form to the flow:

However, there are two additional options available to you. 

For one, you can add invisible reCaptcha to your forms; that can be done simply by selecting the Enable reCaptcha checkbox:

You can also add fields to your form. (And if you don’t want to add fields to your form right now? That’s fine; you can always edit the form  later, and then add and subtract fields to your heart’s content.) To add fields, click the Add Field button and then, in the Add a field to this form dialog, click the Field name dropdown to select the field you want to use on the form:

Click Add Field, and the field will be added to the form:

If you change your mind, click the X to remove the field from the form.

And yes, you can add additional fields; just repeat the previous procedure as often as needed:

Two things to keep in mind when working with fields. First, the order of the fields is important: this is the same order in which the fields will appear on the form. (In the preceding screenshot, we can see that addressCountry will be the first field displayed, and addressStreetAddress1 will be the last field displayed.) If you want to change the order of the fields, click the move handle located to the left of the field name and then drag and drop the field to a new position. For example:

In addition, the field type, and whether or not the field is required, are displayed on the Forms tab. However, neither of those field properties can be changed from this tab. As noted a moment ago, the field Type can’t be changed at all: a text field will always be a text field. The Required property can be changed, but you’ll need to go to the Fields tab and edit the field in order to make that change.