/config/{appId}/flows/ {flow}/translations/{keyId}

Returns all translations associated with a translation 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.

This endpoint includes the following methods:

• GET
• DELETE

GET

Description

Returns a dictionary of all translations for a key.

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

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 

Copy to Clipboard      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."
}
                                                            

DELETE

Description

Deletes a translation string if it is not in use.

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 removes the 826d98bbef2eea2cee1058da8f6d6b2b translation key from the documentation flow.

curl -X DELETE \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/translations/826d98bbef2eea2cee1058da8f6d6b2b \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' 

Copy to Clipboard      Running this command in Postman

Responses

204 No Content

Successfully deleted the Translation string.

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."
}
                                                            

409 Conflict

The request could not be completed because the string is in use.

Response Example (application/json)

{
  "errors": "Cannot delete a translation key that is still in use"
}

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))