View a Screen

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

Description

Returns information for a specific 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.

URI Parameters

Parameter	Type	Required	Description
screen	string	Yes	The screen name.

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 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"
}

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.

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

Description

URI Parameters

API Client Permissions

Authentication

Base URL

Sample Request (curl)

Responses

Running this Command in Postman

How to Create an Authentication String

Rate this Article