Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /translations/{key}
Description
Returns a dictionary of all translations for a key. Translations enable you to offer the login and registration experience in multiple languages. Note that the Identity Cloud ships in English only: you are responsible for adding your own translations.
Respects the API Client Allow List: No
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
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
key | string | Yes | UUID of the translations key. |
Sample Request (curl)
This command returns all the translations associated with the translation key afeba216c561f421e6e19e6cfed3acd.
curl -X GET \
-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/translations/afeba216c561f421e6e19e6cfed3acd8
Running this command in Postman
Responses
200 OK
Response Example (application/json)
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/translations/991a5781-cbe1-4770-bbf1-395168a11d59",
"key": "991a5781-cbe1-4770-bbf1-395168a11d59",
"path": "",
"values": {
"en-US": "Elbow grease.",
"it-IT": "Olio di gomito."
}
}
404 Not Found
Translation string could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Translation string not found."
}