Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /locales/{locale} /fields/{field}
Description
The GET method returns information about a specific field associated with a specific locale; the PUT method enables you to modify an existing field. Each locale represents a specific language, region, and collection of locale variant preferences; having different locales enable you to better personalize the user login and registration experience.
Respects the API Client Allow List: No
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
field | string | Yes | ISO language code for the locale. For example:
|
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
Sample Request (curl)
This command returns information about the optIn field associated with the documentation flow.
curl -GET \
-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/fields/optIn
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": "foo",
"tip": "foo",
"socialProfileData": "profile.displayName",
"placeholder": "foo",
"validation": [
{
"rule": "required",
"value": true,
"message": "foo"
},
{
"rule": "unique",
"value": true,
"message": "foo"
}
]
}
404 Not Found
Field could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Field not found."
}