/config/{appId}/ flows/{flow}/strings

Returns information about all the strings defined in 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
POST

GET

Description

Returns a list of strings defined 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:

Sample Request (curl)

This command returns information about all the strings associated with the documentation flow.


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

Running this command in Postman

Responses

200 OK

Response Example (application/json)


[
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/emailAddressData",
    "name": "emailAddressData"
  },
  {
    "_self": "/config/4qeam8586cpkuru3ju8kj2xwdf/flows/myCoolFlow/strings/poweredByJanrain",
    "name": "poweredByJanrain"
  }
]

404 Not Found

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

Response Example (application/json)


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

POST

Description

Adds a String to 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:

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

Sample Request (curl)

This command adds a new string (akamaiEducationCenter) to the documentation flow.


curl -X POST \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/strings \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "akamaiEducationCenter",
  "schemaId": "akamaiEducationCenter",
  "value": {
    "key": "a0861174cd5d46eb65d38ee3ec137d55",
    "path": "strings.akamaiEducationCenter.value",
    "values": {
      "en-US": "Akamai Education Center"
      }
    }
  }'

Running this command in Postman

Responses

201 Created

Successfully created a new string.

Response Headers

Location string

The location of the newly-created string.

Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/strings/myCoolString

404 Not Found

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

Response Example (application/json)


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

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

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

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

GET

POST

Running this Command in Postman

How to Create an Authentication String

Comments