List Your Screens

Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /screens


Description

Returns a collection of all the screens in a flow. Screens are sections (i.e., the HTML <div> tag) included on a JavaScript SDK or Hosted Login page, and are primarily used as a container for forms and fields.


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:

  • us 
  • eu 
  • au 
  • sa 
  • cn
  • sg


Sample Request (curl)

This command returns information about all the screens associated with the documentation flow.


curl -G \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens \
  -H 'Authorization: Basic hyu752xh1czZwY2xwd2toaDc3Nzk4aDVkdmdiZGc1dDp1ZdlodGRqMzI3MjRzZnRlYzkzODYbbDc3ZTYzcz096f==' 

      Running this command in Postman


Responses

200 OK

Response Example (application/json)


[
  {
    "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/traditionalAuthenticateMerge",
    "name": "traditionalAuthenticateMerge"
  },
  {
    "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/reactivateAccountSuccess",
    "name": "reactivateAccountSuccess"
  },
  {
    "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/signIn",
    "name": "signIn"
  }
]

404 Not Found

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

Response Example (application/json)


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