/config/{app}/flows/{flow}/forms/{form}

This endpoint supports the following methods:


GET

Returns a list of fields in a form.

URI Parameters

Parameter Type Required Description
form string Yes The form name.
 

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)

This command returns information about the form associated with the documentation flow:


curl -X GET \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/forms/registrationForm \
  -H 'Authorization: Basic aW1fYV...NfbXk=' 


      Running this command in Postman

Responses

200 OK

Response Example (application/json)


{
  "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/forms/signInForm",
  "fields": [
    {
      "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/signInEmailAddress",
      "name": "signInEmailAddress",
      "required": false
    },
    {
      "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/currentPassword",
      "name": "currentPassword",
      "required": false
    }
  ]
}
                                                            

404 Not Found

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

Response Example (application/json)


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


PUT

Description

Updates/replaces the list of fields and features in the form. Any fields added to the form must already exist in the flow.

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

Request Example (application/json)


{
  "fields": [
    {
      "name": "signInEmailAddress"
    },
    {
      "name": "currentPassword"
    }
  ]
}
                                                            

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 adds three fields to the signInForm associated with the documentation flow:


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/forms/signInForm \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{
    "fields": [
        {
            "required": true,
            "name": "signInEmailAddress"
        },
        {
            "required": true,
            "name": "currentPassword"
        },
         {
            "required": false,
            "name": "displayName"
        }
    ]
}'
      Running this command in Postman

Responses

204 No Content

Successfully updated the Form.

404 Not Found

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

Response Example (application/json)


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