Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /locales/{locale} /strings
Description
Returns a list of strings defined in the flow. Strings represent the UI text used on web pages built using the JavaScript SDK or Hosted Login.
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 all the strings associated with the en-US version of the documentation flow.
curl -G \-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings
Running this command in Postman
Responses
200 OK
Response Example (application/json)
[
{
"_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/emailAddressData",
"name": "emailAddressData"
},
{
"_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByJanrain",
"name": "poweredByJanrain"
}
]
404 Not Found
String could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "String not found."
}
