Returns a list of all the fields defined with the specified flow. A field essentially represents a user profile attribute; for example, a flow will typically have fields for a user's first name, a user's address, a user's phone number, etc.
Note. For detailed information about the different kinds of fields available to you, see the article Field Types.
This endpoint supports the following methods:
- GET
- POST
GET
Description
Returns a list of fields defined in the flow.
Authentication
This endpoint supports Basic authentication.
How to Create an Authentication String
Base URL
The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:
https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr
Allowed regions are:
- us
- eu
- au
- sa
- cn
- sg
Sample Request (curl)
This command returns all the fields for the documentation flow associated with the application htb8fuhxnf8e38jrzub3c7pfrr.
curl -G \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields
Running this command in Postman
Responses
200 OK
Response Example (application/json)
[
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/signInEmailAddress",
"name": "signInEmailAddress"
},
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/currentPassword",
"name": "currentPassword"
}
]404 Not Found
Flow could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Flow not found."
}
POST
Description
Adds a field to the flow. The schemaAttribute must be a dot-separated path to an existing schema attribute.
Authentication
This endpoint supports Basic authentication.
How to Create an Authentication String
Base URL
The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:
https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr
Request Example (application/json)
{
"type": "text",
"name": "myCustomTextField",
"schemaAttribute": "displayName",
"label": {
"key": "b6ced670-7140-4446-9839-da3474860b1a"
},
"tip": {
"key": "8b93448a-6f00-448c-952b-0f1536107cf7"
},
"socialProfileData": "profile.displayName",
"placeholder": {
"key": "6e15067b-2ca5-43c3-af96-930766d63375"
},
"validation": [
{
"rule": "required",
"value": true,
"message": {
"key": "bb2b21a1-98df-4dce-84f7-534013c46225"
}
},
{
"rule": "unique",
"value": true,
"message": {
"key": "63f7c18f-521a-4b4f-94c4-0b04b870c82e"
}
}
]
}
Sample Request (curl)
This command adds a custom field named userFullName to the documentation flow associated with the application
htb8fuhxnf8e38jrzub3c7pfrr.
curl -X POST \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \-H 'Content-Type: application/json' \ -d '{ "type": "text", "name": "userFullName", "schemaAttribute": "displayName" }'
Running this command in Postman
Responses
201 Created
Successfully created a new field.
Response Headers
Location string
The location of the newly-created field.
Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/myField
404 Not Found
Flow could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Flow not found."
}
