Configuration API

The Configuration APIs are used to manage flows and all the things -- forms, fields, screens, locales, etc. -- that help to make up a flow.

An introduction to the Configuration APIs can be found in the following articles:

The actual API endpoints are listed below.

/config/{app}/entityTypes
Returns information about the entity types associated with an application.
GET
/config/{app}/entityTypes/{entity_type}
Returns information about a specific entity type.
GET
/config/{app}/entityType/{entity_type}/attributes
Returns information about all the attributes associated with an entity type.
GET
/config/{app}/entityType/{entity_type}/attributes/{attribute_name}
Returns detailed information about a specific entity type attribute.
GET
/config/{app}/flows
Returns information about your available flows.
GET
/config/{app}/flows/{flow}
The GET method returns information about the specified flow. The PUT method updates or replaces userData objects or entityTypes referenced in the flow.
GET-PUT
/config/{app}/flows/{flow}/copy
Creates a copy of the specified flow.
POST
/config/{app}/flows/{flow}/fields
The GET method returns a list of all the fields defined in the specified flow, while the POST method provides a way to add a field to a flow.
GET - POST
/config/{app}/flows/{flow}/fields/{field}
The GET method returns information about the specified field (as found in the specified flow). The PUT method enables you to update or replace that field, while the DELETE method removes the field from the flow and from any forms that reference that field.
GET - PUT - DELETE
/config/{app}/flows/{flow}/forms
Returns information about the forms referenced within a flow.
GET
/config/{app}/flows/{flow}/forms/{form}
The GET method returns information about all the fields used in the specified form. The PUT method provides a way to update or replace any of those fields.
GET - PUT
/config/{app}/flows/{flow}/locales
Returns information about the available locales.
GET
/config/{app}/flows/{flow}/locales/{locale}
Returns the available translation values for the specified field.
GET
/config/{app}/flows/{flow}/locales/{locale}/fields
The GET method returns information about the fields referenced in the specified flow. The POST method lets you add a field to the flow, and to use translatable values when doing so.
GET - POST
/config/{app}/flows/{flow}/locales/{locale}/fields/{field}
The GET method returns a field definition from the specified flow, translated into the locale language. The PUT method enables you to update/replace a field in the flow.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates
Returns a list of all the email templates found in the specified flow (and the specified locale).
GET
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}
The GET method returns information about the specified email template, while the PUT method enables you to update that template.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
The GET method returns the body text (or HTML) for the specified email template, while the PUT method provides a way to update that body text.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
The GET method returns the Subject line for the specified email template. The PUT method is used to modify the Subject line.
GET - PUT
/config/{app}/flows/{flow}/locales/{locale}/strings
The GET method returns all the string defined in the specified flow. The POST method enables you to add an additional string to the flow.
GET - POST
/config/{app}/flows/{flow}/locales/{locale}/strings/{string}
The GET method returns the specified string from the specified flow. The PUT method enables you to update or replace that string, while the DELETE method provides a way to delete the string altogether.
GET - PUT - DELETE
/config/{app}/flows/{flow}/promote
Copies a flow to another application.
POST
/config/{app}/flows/{flow}/screens
Returns information about all the screens associated with a flow.
GET
/config/{app}/flows/{flow}/screens/{screen}
The GET method returns basic information about the specified screen, while the PUT method lets you set the "modality" of that screen. (If modal is set to TRUE, that means the user must interact with the screen before he or she can do anything else related to Janrain registration.)
GET - PUT
/config/{app}/flows/{flow}/strings
The GET method returns information about all the string found in the specified flow. The POST method enables you to add a string to the flow.
GET - POST
/config/{app}/flows/{flow}/strings/{string}
The GET method returns information about the specified string. The PUT method provides a way to update or replace that string, and the DELETE method is used to remove that string from the flow.
GET - PUT - DELETE
/config/{app}/flows/{flow}/translations
The GET method returns information about all the translations in the specified flow, and the PATCH method enables you to update any of the translations. You use the POST method to create new translations.
GET - PATCH - POST
/config/{app}/flows/{flow}/translations/{key}
The GET method returns all the translations associated with the specified key, while the DELETE method lets you delete a translation string. Note that strings cannot be deleted in if a translation key is currently in use.
GET - DELETE
/config/{app}/flows/{flow}/versions
Returns information, including change notes, for all versions of the specified flow.
GET
/config/{app}/flows/{flow}/versions/{version}
The GET method returns information about the specified version of a flow. The POST method lets you restore a flow to one of its previous versions.
GET - POST