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

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

This endpoint includes the following methods:

• GET
• PUT
• DELETE

GET

Returns a string definition from the flow.

URI Parameters

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 

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

PUT

Description

Updates/replaces a string in the flow. Strings must contain either schemaId or value. Do not provide both.

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)

{
  "name": "myCoolString",
  "schemaId": "myCoolAttribute",
  "value": {
    "key": "a0861174cd5d46eb65d38ee3ec137d55",
    "path": "strings.myCoolString.value",
    "values": {
      "en-US": "This is a cool string"
    }
  }
}

Sample Request (curl)

This command updates the akamaiEducationCenter string associated with the documentation flow.

curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/strings/akamaiEducationCenter \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "akamaiEducationCenter",
    "value": {
        "path": "strings.addressCountry.options[40].text",
        "values": {
            "en-US": "Akamai Education Center"
        },
        "key": "2e644df5ac113d206b4cf8acbf469fa1"
      }
  }'

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": "String 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 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 akamaiEducationCenter string from the documentation flow.

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

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": "String not found."
}
                                                            

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

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