This field is for website users who are already logged into your site. In site registration forms use the User - Create User field.
The Create Login field allows an existing user to create an additional username and password to use when logging into your site. This could be used by a user who only has "social" logins linked to their account and would like to add a method for direct login, or used to create multiple logins for the same account.
When the form this field is used on is submitted a new login of the iCMSiteUser provider type is added to their account. Most commonly the username and password of the new login user will be entered onto the form by the user (because the user needs to know what they are so they can use them to log in).
Usernames and Security
By default this field does not show an error message should a chosen username already exist in this subsite zone. This is to prevent username enumeration (guessing the names of existing users). If you add a Validation Errors field to your form the user will see the message "User name is already in use".
The field cannot be used by users who aren't already logged in.
Properties
| Label | Description | Type Name |
|---|---|---|
| New User Name Function | A server-side JavaScript function that returns the new username. Most commonly this will query the value of a field on the form:function(helper) { | USERNAMEFUNC |
| Description Function | A server-side JavaScript function that returns the new description. Descriptions are not required, but they are displayed to users when managing the logins linked to their account. You could add some fixed text:function(helper) { | DESCRIPTIONFUNC |
| Password Function | A server-side JavaScript function that returns the new password. Most commonly this will query the value of a field on the form:function(helper) { | PASSWORDFUNC |
| Success Message | The message to display when the new user has been created successfully. Leave blank for no message | SUCCESSMESSAGE |
| Failure Message | The message to display if an error occurs. Leave blank for no message | FAILUREMESSAGE |
| Maximum Users | You can use this field to limit the number of login users someone can add to their account. 0 or an empty value removes any limit | MAXUSERS |
| Stop Processing on Error | If true, and an error is encountered, further action fields on the form won't be processed. See The Form Lifecycle: Control and Action Processing for more information | STOPPROCESSINGONERROR |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
Share this page
