This endpoint supports the following methods
- GET
- PUT
- DELETE
GET
Returns a field definition from the flow. Includes validations.
URI Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| field | string | required | The field name. |
Authentication
This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:
abcdefg:hijklmnop
Next, take the string and base64 encode it.
For example, on a Mac, you can base encode the string using this command:
echo -n "abcdefg:hijklmnop" | base64
If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:
[Convert]::ToBase64String([Sys
The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.
If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.
Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.
Base URL
The base URL for this endpoint is your Janrain 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
Query Parameters
locale string
If supplied, the field will be translated into the specified locale before being returned. The response will be identical to calling /config/{app}/flows/{flow}/locales/{locale}/fields/{field}
Sample Request (curl)
This command returns information about the signInEmailAddress field found on the documentation flow:
curl -X GET \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields/signInEmailAddress \ -H 'Authorization: BasicaW1fYV...NfbXk='
Running Code Samples Using Postman
The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:
- Click the Copy to Clipboard button located directly beneath the code sample
- In Postman, click Import to display the Import dialog box.
- In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:
- Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.
Responses
200 OK
Response Example (application/json)
{
"_relationships": {
"forms": [
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/forms/editProfileForm",
"name": "editProfileForm"
}
]
},
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/myCustomTextField",
"type": "text",
"name": "myCustomTextField",
"schemaAttribute": "displayName",
"label": {
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/b6ced670-7140-4446-9839-da3474860b1a",
"key": "b6ced670-7140-4446-9839-da3474860b1a",
"path": "fields.displayName.label",
"values": {
"en-US": "Display Name"
}
},
"tip": {
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/8b93448a-6f00-448c-952b-0f1536107cf7",
"key": "8b93448a-6f00-448c-952b-0f1536107cf7",
"path": "fields.displayName.tip",
"values": {
"en-US": ""
}
},
"socialProfileData": "profile.displayName",
"placeholder": {
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/6e15067b-2ca5-43c3-af96-930766d63375",
"key": "6e15067b-2ca5-43c3-af96-930766d63375",
"path": "fields.displayName.placeholder",
"values": {
"en-US": "Display Name"
}
},
"validation": [
{
"rule": "required",
"value": true,
"message": {
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/bb2b21a1-98df-4dce-84f7-534013c46225",
"key": "bb2b21a1-98df-4dce-84f7-534013c46225",
"path": "fields.displayName.validation.messages.required",
"values": {
"en-US": "Display name is required."
}
}
},
{
"rule": "unique",
"value": true,
"message": {
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/63f7c18f-521a-4b4f-94c4-0b04b870c82e",
"key": "63f7c18f-521a-4b4f-94c4-0b04b870c82e",
"path": "fields.displayName.validation.messages.unique",
"values": {
"en-US": "That display name is already taken."
}
}
}
]
}
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}
PUT
Description
Updates/replaces a field in the flow.
Authentication
This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:
abcdefg:hijklmnop
Next, take the string and base64 encode it.
For example, on a Mac, you can base encode the string using this command:
echo -n "abcdefg:hijklmnop" | base64
If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:
[Convert]::ToBase64String([Sys
The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.
If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.
Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.
Base URL
The base URL for this endpoint is your Janrain 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 updates the userFullName field found on the documentation flow:
curl -X PUT \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields/userFullName \ -H 'Authorization: BasicaW1fYV...NfbXk=' \ -H 'Content-Type: application/json' \ -d '{ "type": "text", "schemaAttribute": "familyName", "name": "userFullName" }'
Running Code Samples Using Postman
The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:
- Click the Copy to Clipboard button located directly beneath the code sample
- In Postman, click Import to display the Import dialog box.
- In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:
- Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.
Responses
204 No Content
Successfully updated the Field.
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}
DELETE
Description
Removes a field from the flow. Also removes the field from any forms that were using it.
Authentication
This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:
abcdefg:hijklmnop
Next, take the string and base64 encode it.
For example, on a Mac, you can base encode the string using this command:
echo -n "abcdefg:hijklmnop" | base64
If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:
[Convert]::ToBase64String([Sys
The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.
If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.
Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.
Base URL
The base URL for this endpoint is your Janrain 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
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| force | string | Forces the deletion of a field even if it's still being used in forms. Forms in question will have the field removed. Allowed values are:
|
Responses
204 No Content
Successfully deleted the Field.
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}