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

Endpoint for managing the screens associated with a flow. These management tasks include:

Returning information about the screens.
Modifying an existing screen.
Deleting an existing screen.

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.

This endpoint includes the following methods:

GET
PUT
DELETE

GET

Returns information for a specific screen. Screens are primarily used as a container for hosting forms.

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 Identity Cloud 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:

Sample Request (curl)

This command returns information about the changePassword screen associated with the documentation flow.

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

Running this command in Postman

Responses

200 OK

Response Example (application/json)


{
  "_self": "/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/screens/changePassword",
  "hasUserData": false,
  "modal": true,
  "name": "changePassword",
  "source": "client"
}

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

Modifies property values for a screen. Screens, primarily used as a container for hosting forms, contain three primary properties; each of these property values must be included in the request body of your API call (including values that aren’t being changed). Screen property values are:

hasUserData. Boolean value that indicates whether the screen displays user data. For example, the confirmAccountDeactivation screen does not display any user data; instead, it simply asks the user to verify that they really do want to deactivate their account. By default, only the editProfile and the emailVerificationRequired screens display user data.
modal. Boolean value that indicates whether the new screen is a “modal.” With a modal screen, the screen must be completed (or dismissed) before the user can do anything else. By default, all Identity Cloud screens have the modal property set to true except for the editProfile screen.
name. Name of the screen. The name value must be included in the request body even though you cannot change the name of a screen. If you omit the name, your call will fail with the following error:

{
    "errors": "Missing payload argument 'name'."
}

An error will also occur if you attempt to change the name of the screen. For example, suppose you have a screen named testScreen and you try change the name to newRegistrationScreen. That API call will fail with this error:

{
    "errors": "Screen name in URL path and request body must match. Got 'testScreen' in the URL and 
    'newRegistrationScreen' in the request body."
}

source. Must be set to client. This property is required in order for the screen to render properly.

A typical request body will look similar to this:

{
    "hasUserData": false,
    "modal": true,
    "name": "testScreen",
    "source": "client"
}

Authentication

This endpoint supports Basic authentication.

How to Create an Authentication String

Base URL


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

Request Example (application/json)


{
  "modal": false,
  "name": "signIn",
  "hasUserData": true,
  "source": "client"
}

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 c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \
  -H 'Content-Type: application/json' \
  -d '{
    "hasUserData": true,
    "name": "changePassword",
    "modal": false,
    "source": "client"
   }'

Running this command in Postman

Responses

204 No Content

If the screen is successfully modified you will see the HTTP status code 204 No Content.

404 Not Found

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

Response Example (application/json)


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

DELETE

Description

Removes the specified screen. Note that calling the DELETE method only removes the screen; it does not remove any forms or fields associated with the screen.

Authentication

This endpoint supports Basic authentication.

How to Create an Authentication String

Base URL


https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr

Allowed regions are:

Sample Request (curl)

This command deletes the screen testScreen associated with the standard flow and the application htb8fuhxnf8e38jrzub3c7pfrr.


curl -X DELETE \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/standard/screens/testScreen \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg='

Running this command in Postman

Responses

204 No Content

If the screen is successfully deleted you will see the HTTP status code 204 No Content.

404 Not Found

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

Response Example (application/json)


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

How to Create an Authentication String

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

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

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Before you actually try your authentication string, make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

GET

PUT

DELETE

Running this Command in Postman

How to Create an Authentication String