View/Modify/Delete a String

Endpoint URL: {identityDomain}/config/{appId}/flows/{flow}/strings/{string}

The GET method returns information about about a specific string within a flow, while the PUT method enables you to modify a string. And, as the name implies, the DELETE method provides a way to delete a string. 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

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

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:

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

Running this command in Postman

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.

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


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

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

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

DELETE

Description

Removes a String from the flow.

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


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

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='

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

Endpoint URL: {identityDomain}/config/{appId}/flows/{flow}/strings/{string}

GET

PUT

DELETE

Running this Command in Postman

How to Create an Authentication String

Rate this Article