APIs / custom forms

Form Fields

This feature is only available in paid plans. Please visit our pricing page to learn more.

Overview

A FusionAuth Form Field is an object that can be customized to receive input within a FusionAuth Form.

The following APIs are provided to manage Forms Fields.

Create a Form Field

This API is used to create a new Form Field.

Request

Create a Form Field with a randomly generated Id

POST /api/form/field

Create a Form Field with the provided unique Id

POST /api/form/field/{fieldId}

Request Parameters

fieldIdUUIDDefaults to secure random UUID

The Id to use for the new Form Field. If not specified a secure random UUID will be generated.

Request Body

field.confirmBooleanDefaults to false

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

field.consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

Using a form field for consent allows you to leverage a FusionAuth consent to allow your end users to self consent to terms and service, end user license agreements, or other opt-in, or opt-out agreements during registration.

field.controlStringDefaults to text

The Form Field control. The possible values are:

checkbox
number
password
radio
select
textarea
text

The field control can only be set for custom fields, and if not provided the default value will be text. For all managed fields, such as user.firstName, the control will be set by FusionAuth and it may not be modified.

field.dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

field.descriptionString

A description of the Form Field.

field.keyStringrequired

The key is the path to the value in the user or registration object.

Predefined keys

Predefined keys are typed values managed by FusionAuth. When using a pre-defined key, the field data type and form control are not configurable.

registration.preferredLanguages Available since 1.20.0
registration.roles Available since 1.20.0
registration.timezone Available since 1.20.0
registration.username
user.birthDate
user.email
user.firstname
user.fullName
user.imageUrl Available since 1.20.0
user.lastName
user.middleName
user.mobilePhone
user.password
user.preferredLanguages Available since 1.20.0
user.timezone Available since 1.20.0
user.username

Custom Keys

When defining a key to store custom data, you may use one of the following prefixes:

user.data.
registration.data.

For example, in order to store a custom value on the user object to collect the User’s favorite color, set the key value equal to user.data.favoriteColor.

A valid key name must not contain spaces or special characters. An array may be specified by using the array syntax of [0] to indicate the first position in an array. Nested objects may be specified by using the object syntax of ['foo'] to indicate the named property of the object named foo. Consider the following examples:

user.data.preferences[0] would store the value in the first position of an array named preferences.
user.data.preferences['color'] would store the value in an object named preferences with a key of color.

Localization

You may localize the displayed value of this key during registration by adding the key to your theme. For example, if you specify the key value of user.data.favoriteColor this key value be rendered in the UI.

If you were to add the following messages to your theme, the localized form of the value will be shown to the end user. This allows you to provide a human readable field name and optionally localize the field name as well.

user.data.favoriteColor=Favorite color

field.nameStringrequired

The unique name of the Form Field.

field.optionsArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

For example, if you specify the values ["red", "green", "blue"] as the field options, these will be stored on the user in this lowercase form. By default the values red, green and blue will be rendered in the UI.

If you were to add the following messages to your theme, the capitalized form of the values will be shown to the end user. This allows you to provide a human-readable form of the value and optionally localize the displayed values.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

field.requiredBooleanDefaults to false

Determines if a value is required to complete the form.

field.typeStringDefaults to string

The data type used to store the value in FusionAuth. The possible values are:

bool the value must be a boolean value, true or false
consent the value will be used to complete self consent
date the value will be stored as a date. The value must be formatted as ISO-8601 or YYY-MM-DD, you may want to use a JavaScript data picker that can convert the selected value to this format.
email the value will be expected to be a valid email address
number the value will be stored as a numerical value
string the value will be stored as a string

All user provided input will be validated to ensure it can be stored in this data type. If the user input cannot be converted a validation error will be shown to the user. When providing options for this control each option must also be compatible with this data type. When using the `consent` type, the field consentId is required and must be included in the request. The data type can only be set for custom fields, and if not provided the default value will be `string`. For all managed fields, such as `user.firstName`, the data type will be set by FusionAuth and it may not be modified.

field.validator.enabledBooleanDefaults to false

Determines if user input should be validated.

field.validator.expressionString

A regular expression used to validate user input. Must be a valid regular expression pattern.

See Pattern for examples and syntax.

Example Request JSON

{
  "field": {
    "data": {
      "leftAddOn": "send"
    },
    "description": "Information about this custom field",
    "key": "user.firstName",
    "name": "Custom first-name Form Field",
    "required": true
  }
}

Response

The response for this API contains the Form Field that was created.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

field.confirmBoolean

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

field.consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

field.controlString

The Form Field control. The possible values are:

checkbox
number
password
radio
select
textarea
text

field.dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

field.descriptionString

A description of the Form Field.

field.idUUID

The unique Id of the form field.

field.insertInstantLong

The instant that the form field was added to the FusionAuth database.

field.keyString

The key is the path to the value in the user or registration object.

Predefined keys

Predefined keys are typed values managed by FusionAuth. When using a pre-defined key, the field data type and form control are not configurable.

registration.preferredLanguages Available since 1.20.0
registration.roles Available since 1.20.0
registration.timezone Available since 1.20.0
registration.username
user.birthDate
user.email
user.firstname
user.fullName
user.imageUrl Available since 1.20.0
user.lastName
user.middleName
user.mobilePhone
user.password
user.preferredLanguages Available since 1.20.0
user.timezone Available since 1.20.0
user.username

Custom Keys

When defining a key to store custom data, you may use one of the following prefixes:

user.data.
registration.data.

For example, in order to store a custom value on the user object to collect the User’s favorite color, set the key value equal to user.data.favoriteColor.

user.data.preferences[0] would store the value in the first position of an array named preferences.
user.data.preferences['color'] would store the value in an object named preferences with a key of color.

Localization

user.data.favoriteColor=Favorite color

field.lastUpdateInstantLong

The instant that the form field was last updated in the FusionAuth database.

field.nameString

The unique name of the Form Field.

field.optionsArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

field.requiredBoolean

Determines if a value is required to complete the form.

field.typeString

The data type used to store the value in FusionAuth. The possible values are:

bool the value must be a boolean value, true or false
consent the value will be used to complete self consent
date the value will be stored as a date. The value must be formatted as ISO-8601 or YYY-MM-DD, you may want to use a JavaScript data picker that can convert the selected value to this format.
email the value will be expected to be a valid email address
number the value will be stored as a numerical value
string the value will be stored as a string

field.validator.enabledBoolean

Determines if user input should be validated.

field.validator.expressionString

A regular expression used to validate user input. Must be a valid regular expression pattern.

See Pattern for examples and syntax.

Example Response JSON

{
  "field": {
    "confirm": false,
    "control": "text",
    "data": {
      "leftAddOn": "send"
    },
    "description": "Information about this custom field",
    "id": "e96f02db-4567-43a6-a876-74a3869fe94a",
    "insertInstant": 1562189072183,
    "key": "user.firstName",
    "lastUpdateInstant": 1562189927638,
    "name": "Custom first-name Form Field",
    "required": true,
    "type": "string",
    "validator": {
      "enabled": false
    }
  }
}

Retrieve a Form Field

This API is used to retrieve a single Form Field by unique Id or all of the configured Form Fields.

Request

Retrieve all of the Form Fields

GET /api/form/field

Retrieve a Form Field by Id

GET /api/form/field/{fieldId}

Request Parameters

fieldIdUUIDrequired

The unique Id of the Form Field to retrieve.

Response

The response for this API contains either a single Form Field or all of the Form Fields. When you call this API with an Id, the response will contain a single Form Field. When you call this API without an Id, the response will contain all of the Form Fields. Both response types are defined below along with an example JSON response.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

field.confirmBoolean

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

field.consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

field.controlString

The Form Field control. The possible values are:

checkbox
number
password
radio
select
textarea
text

field.dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

field.descriptionString

A description of the Form Field.

field.idUUID

The unique Id of the form field.

field.insertInstantLong

The instant that the form field was added to the FusionAuth database.

field.keyString

The key is the path to the value in the user or registration object.

Predefined keys

Predefined keys are typed values managed by FusionAuth. When using a pre-defined key, the field data type and form control are not configurable.

registration.preferredLanguages Available since 1.20.0
registration.roles Available since 1.20.0
registration.timezone Available since 1.20.0
registration.username
user.birthDate
user.email
user.firstname
user.fullName
user.imageUrl Available since 1.20.0
user.lastName
user.middleName
user.mobilePhone
user.password
user.preferredLanguages Available since 1.20.0
user.timezone Available since 1.20.0
user.username

Custom Keys

When defining a key to store custom data, you may use one of the following prefixes:

user.data.
registration.data.

For example, in order to store a custom value on the user object to collect the User’s favorite color, set the key value equal to user.data.favoriteColor.

user.data.preferences[0] would store the value in the first position of an array named preferences.
user.data.preferences['color'] would store the value in an object named preferences with a key of color.

Localization

user.data.favoriteColor=Favorite color

field.lastUpdateInstantLong

The instant that the form field was last updated in the FusionAuth database.

field.nameString

The unique name of the Form Field.

field.optionsArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

field.requiredBoolean

Determines if a value is required to complete the form.

field.typeString

The data type used to store the value in FusionAuth. The possible values are:

bool the value must be a boolean value, true or false
consent the value will be used to complete self consent
date the value will be stored as a date. The value must be formatted as ISO-8601 or YYY-MM-DD, you may want to use a JavaScript data picker that can convert the selected value to this format.
email the value will be expected to be a valid email address
number the value will be stored as a numerical value
string the value will be stored as a string

field.validator.enabledBoolean

Determines if user input should be validated.

field.validator.expressionString

A regular expression used to validate user input. Must be a valid regular expression pattern.

See Pattern for examples and syntax.

Example Response JSON

{
  "field": {
    "confirm": false,
    "control": "text",
    "data": {
      "leftAddOn": "send"
    },
    "description": "Information about this custom field",
    "id": "e96f02db-4567-43a6-a876-74a3869fe94a",
    "insertInstant": 1562189072183,
    "key": "user.firstName",
    "lastUpdateInstant": 1562189927638,
    "name": "Custom first-name Form Field",
    "required": true,
    "type": "string",
    "validator": {
      "enabled": false
    }
  }
}

Response Body

fieldsArray

The list of Form Field objects.

fields[x].confirmBoolean

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

fields[x].consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

fields[x].controlString

The Form Field control. The possible values are:

checkbox
number
password
radio
select
textarea
text

fields[x].dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

fields[x].descriptionString

A description of the Form Field.

fields[x].idUUID

The unique Id of the form field.

fields[x].inseertInstantLong

The instant that the Form Field was added to the FusionAuth database.

fields[x].keyString

The key is the path to the value in the user or registration object.

Predefined keys

Predefined keys are typed values managed by FusionAuth. When using a pre-defined key, the field data type and form control are not configurable.

registration.preferredLanguages Available since 1.20.0
registration.roles Available since 1.20.0
registration.timezone Available since 1.20.0
registration.username
user.birthDate
user.email
user.firstname
user.fullName
user.imageUrl Available since 1.20.0
user.lastName
user.middleName
user.mobilePhone
user.password
user.preferredLanguages Available since 1.20.0
user.timezone Available since 1.20.0
user.username

Custom Keys

When defining a key to store custom data, you may use one of the following prefixes:

user.data.
registration.data.

For example, in order to store a custom value on the user object to collect the User’s favorite color, set the key value equal to user.data.favoriteColor.

user.data.preferences[0] would store the value in the first position of an array named preferences.
user.data.preferences['color'] would store the value in an object named preferences with a key of color.

Localization

user.data.favoriteColor=Favorite color

fields[x].lastUpdateInstantLong

The instant that the form field was last updated in the FusionAuth database.

fields[x].nameString

The unique name of the Form Field.

fields[x].confirmArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

fields[x].requiredBoolean

Determines if a value is required to complete the form.

fields[x].typeString

The data type used to store the value in FusionAuth. The possible values are:

bool the value must be a boolean value, true or false
consent the value will be used to complete self consent
date the value will be stored as a date. The value must be formatted as ISO-8601 or YYY-MM-DD, you may want to use a JavaScript data picker that can convert the selected value to this format.
email the value will be expected to be a valid email address
number the value will be stored as a numerical value
string the value will be stored as a string

fields[x].validator.enabledBoolean

Determines if user input should be validated.

fields[x].validator.expressionString

A regular expression used to validate user input.

Example Response JSON

{
  "fields": [
    {
      "confirm": false,
      "control": "text",
      "data": {
        "leftAddOn": "send"
      },
      "description": "Information about this custom field",
      "id": "e96f02db-4567-43a6-a876-74a3869fe94a",
      "insertInstant": 1562189072183,
      "key": "user.firstName",
      "lastUpdateInstant": 1562189927638,
      "name": "Custom first-name Form Field",
      "required": true,
      "type": "string",
      "validator": {
        "enabled": false
      }
    }
  ]
}

Update a Form Field

This API is used to update an existing Form Field.

You must specify all of the properties of the Form Field when calling this API with the PUT HTTP method. When used with PUT, this API doesn’t merge the existing Form Field and your new data. It replaces the existing Form Field with your new data.

Utilize the PATCH HTTP method to send specific changes to merge into an existing Form Field.

Some attributes, such as type , cannot be changed after form field creation.

Request

Update the Form Field with the given Id

PUT /api/form/field/{fieldId}

PATCH /api/form/field/{fieldId}

When using the PATCH method, you can either use the same request body documentation that is provided for the PUT request for backward compatibility. Or you may use either JSON Patch/RFC 6902] or JSON Merge Patch/RFC 7396. See the PATCH documentation for more information.

When using the PATCH method with a Content-Type of application/json the provided request parameters will be merged into the existing object, this means all parameters are optional when using the PATCH method and you only provide the values you want changed. A null value can be used to remove a value. Patching an Array will result in all values from the new list being appended to the existing list, this is a known limitation to the current implementation of PATCH.

Request Parameters

fieldIdUUIDrequired

The Id of the Form Field to update.

Request Body

field.confirmBooleanDefaults to false

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

field.consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

field.dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

field.descriptionString

A description of the Form Field.

field.nameStringrequired

The unique name of the Form Field.

field.optionsArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

field.requiredBooleanDefaults to false

Determines if a value is required to complete the form.

field.validator.enabledBooleanDefaults to false

Determines if user input should be validated.

field.validator.expressionString

A regular expression used to validate user input. Must be a valid regular expression pattern.

See Pattern for examples and syntax.

Example Request JSON

{
  "field": {
    "data": {
      "leftAddOn": "send"
    },
    "description": "Updated information about this custom field",
    "name": "Custom, updated, first-name Form Field",
    "required": false
  }
}

Response

The response for this API contains the Form Field that was updated.

Response Codes

Code	Description
200	The request was successful. The response will contain a JSON body.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you are trying to update doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Response Body

field.confirmBoolean

Determines if the user input should be confirmed by requiring the value to be entered twice. If true, a confirmation field is included.

field.consentIdUUID

The Id of an existing Consent. This field will be required when the type is set to consent.

field.controlString

The Form Field control. The possible values are:

checkbox
number
password
radio
select
textarea
text

field.dataObject

An object that can hold any information about the Form Field that should be persisted.

This may be useful to add additional meta data to the field that will help you style or render the Form Field. For example, in the JSON example an attribute is added to this data field as follows:

{
  "data": {
    "leftAddOn": "user"
  }
}

This additional meta data is then used to render an icon on the Form Field. Use of this additional data is optional and not required to render the field.

field.descriptionString

A description of the Form Field.

field.idUUID

The unique Id of the form field.

field.insertInstantLong

The instant that the form field was added to the FusionAuth database.

field.keyString

The key is the path to the value in the user or registration object.

Predefined keys

Predefined keys are typed values managed by FusionAuth. When using a pre-defined key, the field data type and form control are not configurable.

registration.preferredLanguages Available since 1.20.0
registration.roles Available since 1.20.0
registration.timezone Available since 1.20.0
registration.username
user.birthDate
user.email
user.firstname
user.fullName
user.imageUrl Available since 1.20.0
user.lastName
user.middleName
user.mobilePhone
user.password
user.preferredLanguages Available since 1.20.0
user.timezone Available since 1.20.0
user.username

Custom Keys

When defining a key to store custom data, you may use one of the following prefixes:

user.data.
registration.data.

For example, in order to store a custom value on the user object to collect the User’s favorite color, set the key value equal to user.data.favoriteColor.

user.data.preferences[0] would store the value in the first position of an array named preferences.
user.data.preferences['color'] would store the value in an object named preferences with a key of color.

Localization

user.data.favoriteColor=Favorite color

field.lastUpdateInstantLong

The instant that the form field was last updated in the FusionAuth database.

field.nameString

The unique name of the Form Field.

field.optionsArray<String>

A list of options that are applied to checkbox, radio, or select controls.

The options for a field must conform to the field.type . If the field.type is number, the options must be numbers. If the field.type is boolean, only true and/or false are allowed.

You may localize the displayed values during registration by adding these values to your theme.

Default

red=Red
green=Green
blue=Blue

Spanish

red=Roja
green=Verde
blue=Azul

field.requiredBoolean

Determines if a value is required to complete the form.

field.typeString

The data type used to store the value in FusionAuth. The possible values are:

bool the value must be a boolean value, true or false
consent the value will be used to complete self consent
date the value will be stored as a date. The value must be formatted as ISO-8601 or YYY-MM-DD, you may want to use a JavaScript data picker that can convert the selected value to this format.
email the value will be expected to be a valid email address
number the value will be stored as a numerical value
string the value will be stored as a string

field.validator.enabledBoolean

Determines if user input should be validated.

field.validator.expressionString

A regular expression used to validate user input. Must be a valid regular expression pattern.

See Pattern for examples and syntax.

Example Response JSON

{
  "field": {
    "confirm": false,
    "control": "text",
    "data": {
      "leftAddOn": "send"
    },
    "description": "Information about this custom field",
    "id": "e96f02db-4567-43a6-a876-74a3869fe94a",
    "insertInstant": 1562189072183,
    "key": "user.firstName",
    "lastUpdateInstant": 1562189927638,
    "name": "Custom first-name Form Field",
    "required": true,
    "type": "string",
    "validator": {
      "enabled": false
    }
  }
}

Delete a Form Field

This API is used to permanently delete a Form Field. A form field cannot be deleted when in use by a one or more forms.

Request

Delete a Form Field by Id

DELETE /api/form/field/{fieldId}

Request Parameters

fieldIdUUIDrequired

The unique Id of the Form Field to delete.

Response

This API does not return a JSON response body.

Response Codes

Code	Description
200	The request was successful.
400	The request was invalid and/or malformed. The response will contain an Errors JSON Object with the specific errors. This status will also be returned if a paid FusionAuth license is required and is not present.
401	You did not supply a valid Authorization header. The header was omitted or your API key was not valid. The response will be empty. See Authentication.
404	The object you requested doesn't exist. The response will be empty.
500	There was an internal error. A stack trace is provided and logged in the FusionAuth log files. The response will be empty.

Results

Recent

Form Fields

Overview

Create a Form Field

Request

Request Parameters

Request Body

Response

Response Body

Retrieve a Form Field

Request

Request Parameters

Response

Response Body

Response Body

Update a Form Field

Request

Request Parameters

Request Body

Response

Response Body

Delete a Form Field

Request

Request Parameters

Response

Results

Recent