/config/{app}/flows/{flow}/screens/{screen}

This endpoint includes the following methods:


GET

Returns a list of information for a specific screen in a flow.

URI Parameters

Parameter Type Required Description
screen string Yes The screen 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 changePassword screen associated with the /changePassword flow :


curl -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/changePassword \

      Running this command in Postman

Responses

200 OK

Response Example (application/json)


{
  "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/screens/signIn",
  "modal": true,
  "name": "signIn"
}

404 Not Found

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

Response Example (application/json)


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


PUT

Description

Updates the modal value for a screen in a flow. Requires 'modal' value as True/False and 'name' of a valid screen name. '_self' path is optional.

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)


{
  "modal": false,
  "name": "signIn"
}

Sample Request (curl)

This command changes the modal value of the changePassword screen associated with the documentation flow:


curl -X PUT \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/changePassword \
  -H 'Authorization: Basic aW1fYV...NfbXk=' \
  -H 'Content-Type: application/json' \
  -d '{    "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/changePassword",
    "name": "changePassword",
    "modal": false
}'
      Running this command in Postman

Responses

204 No Content

Successfully updated the Screen.

404 Not Found

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

Response Example (application/json)


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