/config/{app}/flows/{flow}

This endpoint includes the following methods:

• GET
• PUT

GET

Description

Returns information about a flow.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

URI Parameters

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)

This command returns information about the standard flow associated with the application htb8fuhxnf8e38jrzub3c7pfrr:

curl -X get \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/standard \
  -H 'Authorization: Basic aW1fYV...NfbXk=' 

Responses

200 OK

Response Example (application/json)

{
  "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow",
  "name": "myCoolFlow",
  "version": "2015111701280483247",
  "userData": [
      "email",
      "displayName",
      "givenName"
  ],
  "schemas": [
      "myCoolEntityType"
  ]
}
                                                            

404 Not Found

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

Response Example (application/json)

{
  "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow",
  "name": "myCoolFlow",
  "version": "2015111701280483247",
  "userData": [
      "email",
      "displayName",
      "givenName"
  ],
  "schemas": [
      "myCoolEntityType"
  ]
}
                                                            

PUT

Description

Updates/replaces userData object and/or entityTypes in the flow. userData lists the schema attributes to store in the janrainCaptureProfileData object in Local Storage for a logged-in user.

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

Request Example (application/json)

{
  "userData": [
    "email",
    "displayName",
    "familyName",
    "primaryAddress.country"
  ],
  "schemas": [
    "myCoolEntityType"
  ]
}
                                                            

Sample Request (curl)

This command sets the userData object for the documentation flow associated with the application htb8fuhxnf8e38jrzub3c7pfrr:

curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{
     "userData": [
        "email",
        "displayName",
        "primaryAddress.country"
    ]
}'

Responses

204 No Content

Successfully updated the Flow.

404 Not Found

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

Response Example (application/json)

{
  "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow",
  "name": "myCoolFlow",
  "version": "2015111701280483247",
  "userData": [
      "email",
      "displayName",
      "givenName"
  ],
  "schemas": [
      "myCoolEntityType"
  ]
}
                                                            

abcdefg:hijklmnop

echo -n "abcdefg:hijklmnop" | base64

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