Endpoint URL: {identityDomain} /config/{appId} /flows/{flow}/ strings/{string}
Description
Returns a string definition from the flow. Strings represent the UI text used on web pages built using the JavaScript SDK or Hosted Login.
Respects the API Client Allow List: No
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
string | string | Yes | Name of the string to be returned. |
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 poweredByAkamai string associated with the documentation flow.
curl -G \
-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/strings/poweredByAkamai
Running this command in Postman
Responses
200 OK
Response Example (application/json)
{
"_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/myCoolString",
"name": "myCoolString",
"schemaId": "myCoolAttribute",
"value": {
"_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/myCoolString",
"key": "a0861174cd5d46eb65d38ee3ec137d55",
"path": "strings.myCoolString.value",
"values": {
"en-US": "This is a cool string"
}
}
}
404 Not Found
String could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "String not found."
}