/config/{app}/flows/{flow}/locales/{locale}/strings/{string}

Returns information about the specified string. Strings represent the UI text used on web pages built using the JavaScript SDK or Hosted Login.

This endpoint supports the following methods:


GET

Returns a string definition from the flow.

URI Parameters

Parameter Type Required Description
string string Yes Name of the string to be returned.
 

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)

Theis command returns information about the educationCenter string associated with the en-US version of the documentation flow.


curl -X GET \
 -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings/educationCenter 


      Running this command in Postman

Responses

200 OK

Response Example (application/json)


{
  "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByJanrain",
  "name": "poweredByJanrain",
  "value": "Powered by Janrain"
}

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Flow not found."
}
                                                            


PUT

Description

Updates/replaces a string in the flow.

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

Request Example (application/json)


{
  "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/locales/en-US/strings/poweredByAkamai",
  "name": "poweredByAkamai",
  "value": "Powered by Akamai"
}

Sample Request (curl)

The following command updates the educationCenter string associated with the en-US version of the documentation flow:


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings/educationCenter \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "educationCenter",
    "value": "The Akamai Education Center"
    }'
      Running this command in Postman

Responses

204 No Content

Successfully updated the String.

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Flow not found."
}
                                                            


DELETE

Description

Removes a String from the flow.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain 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)

The following command removes the educationCenter string from the en-US version of the documentation flow


curl -X DELETE \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/locales/en-US/strings/educationCenter \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' 

      Running this command in Postman

Responses

204 No Content

Successfully deleted the String.

404 Not Found

String could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Flow not found."
}