Add a field

post

https://{hostname}/config/{app_id}/flows/{flow}/fields

Adds a field to the flow.

Path Params

app_id

string

required

Application ID. You can find your application ID on the Console's Manage Application page.

flow

string

required

Name of the flow.

Body Params

Adds a field to a flow.

type

string

required

Datatype of the field.

name

string

required

Name of the field.

schemaAttribute

string

required

Schema attribute assigned with the field.

label

object

required

User interface label for the field any time that field appears on an Identity Cloud screen.

tip

object

required

Tooltip associated with the field.

socialProfileData

string

required

Determines how user data returned from a social login is mapped to the registration field. This is only used for social registration.

placeholder

object

required

HTML `placeholder' text.

validation

array of objects

required

Validations assigned to a field. Validations help verify field data before writing that information to the user profile. For example, a validation might ensure that you don’t attempt to write string data to an attribute that can only accept integer data.

validation*

Responses

201

Successfully added.

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

404Flow not found.