Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /fields/{field}
Description
Returns a field definition from the flow. Includes validations. 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.
Respects the API Client Allow List: No
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
field | string | required | The field name. |
API Client Permissions
The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:
owner | access_issuer | direct_access | direct_read_access | login_client |
Yes | No | Yes | No | No |
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
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 associated with the documentation flow.
curl -G \ -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields/signInEmailAddress \
Running this command in Postman
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."
}