View Available Hosted Login Upgrades

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



Description

The term “migrating a flow” refers to adding (and, in some cases, deleting) fields, translations, and screens in order to make a flow compatible with the specified version of Hosted Login. This endpoint enables you to return information about the versions of Hosted Login  that a flow can be upgraded to. For example, if your API call returns the following response, that means that you can upgrade your flow to Hosted Login 2.0 (currently the only version you can upgrade to):

[
    "hosted_login_v2"
]

The returned value – hosted_login_v2 – is important: you’ll use that value when calling the /config/{appId}/flows/{flow}/upgrades/{upgradeId} endpoint in order to upgrade the flow. 

We should also mention that, although you must include a flow name in your API call, the available upgrades are not flow-dependent; instead, they simply represent all the Hosted Login versions available to you. For example, suppose you have a flow configured for Hosted Login v1. When you call this endpoint using that v1 flow, you’ll get back the following response:

[
    "hosted_login_v2"
]

Let’s further suppose you have another flow that has been configured for Hosted Login v2. When you call this endpoint using that flow, you’ll get back the following:

[
    "hosted_login_v2"
]

In other words, this endpoint provides information about the available upgrades; it does not tell you things like whether a specific flow needs to be upgraded or not. For that kind of information, use the /config/{appId}/flows/{flow}/upgrades/{upgradeId} endpoint and the GET method.


Respects the API Client Allow List:  No

URI Parameters

URI parameters that must be included in the request are listed in the following table:

Parameter

Type

Required

Description

{appId}

string

Yes

Unique identifier of the Identity Cloud application containing the flow to be migrated.

{flow}

string

Yes

Name of the flow to be migrated to a new version.


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 requires Basic authentication. When configuring authentication, use your client ID as the username and your client secret as the password.


Sample Request (curl)

The following command lists the Hosted Login upgrades:

curl -L -X GET \
  'https://v1.api.us.janrain.com/config/79y4mqf2rt3bxs378kw5479xdu/flows/upgradedFlow/upgrades' \
  -H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U='


Responses

200 OK

If your call to this endpoint succeeds, you’ll get back a collection of available Hosted Login upgrades:

[
    "hosted_login_v2"
]


Error Response Codes

The following table includes information about some of the other response codes that you might encounter when calling this endpoint.

Response Code

Description

404

Not Found. Typically occurs if you API call references an invalid application ID or flow name.\