Modify a field

put

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

Updates or replaces a field in the flow.

Path Params

app_id

string

required

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

field

string

required

Name of the field.

flow

string

required

Name of the flow.

Body Params

Updates a field in the flow.

type

string

enum

required

Type of field. After a field has been created, the field type can’t be changed.

name

string

required

Unique name assigned to the field.

schemaAttribute

string

required

User profile attribute assigned to a field. For example, a field named firstName might be associated with the givenName attribute.

label

string

Optional label used when the field appears on an Identity Cloud screen. Labels need to reference a translation identifier.

tip

string

Optional tooltip used when the field appears on an Identity Cloud screen. Tooltips need to reference a translation identifier.

socialProfileData

string

Specifies the data returned following a social identity login that can be used to populate the value of this field. For example, the syntax profile.emailAddress indicates that the emailAddress property returned from the social identity provider can be used as the value for this field.

placeholder

string

HTML placeholder attribute when the field appears on an Identity Cloud screen. The placeholder is sample text that appears in a field, but then disappears as soon as the user begins to type in that field.

validation

array of objects

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

204

Successfully modified.

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.