Add a translatable field

post

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

Adds a field to the specified locale.

Path Params

flow

string

required

Name of the flow.

locale

string

required

ISO language code for the locale.

app_id

string

required

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

Body Params

Adds a field to the flow.

type

string

enum

required

Type of field. Note that the field type can’t be changed after the field has been created.

name

string

required

Unique name assigned to the field.

schemaAttribute

string

required

User profile attribute associated with 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 from a social identity login that can populate the value of this field. For example, the syntax profile.emailAddress means that the emailAddress property returned from the social identity provider can be used as the value for this field.

placeholder

string

Serves as the 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

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.