Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /links
Description
Returns a collection of all the links defined within the specified flow and the specified Identity Cloud application.
By default, an Identity Cloud flow includes a handful of links that enable users to access additional information when logging in or registering, or when modifying their user profile. For example, in Hosted Login the traditionalRegistration screen includes a pair of links (terms of service and privacy policy) that enable users to access information without leaving the registration screen:
The /config/{app}/flows/{flow}/links endpoint and the GET method enable you to return information about all the links defined within a flow. In addition, the POST method provides a way for you to create custom links of your own. Because links are a type of field, that means that you can later add these links to, say, any of your Hosted Login forms, using the same approach employed to add any field to a Hosted Login form.
Respects the API Client Allow List: No
Base URL
The base URL for this endpoint is your Identity Cloud API URL, including the appropriate region. For example, if you are in the US region, then your base URL will look like this:
If you are in the Australian (AU) region your base URL will look like this:
URL path parameters
Parameter | Type | Description |
|---|---|---|
{app} | string | Unique identifier of the Identity Cloud application associated with the links. |
{flow} | string | Name of the Identity Cloud flow where the links are defined. |
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.
How to Create an Authentication String
Sample Request (curl)
This command returns all the links associated with application 79y4mqf2rt3bxs378kw5479xdu and a flow named testFlow:
curl -X GET \
'https://v1.api.us.janrain.com/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links' \
-H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U='
Responses
200 OK
If your call to this endpoint succeeds you’ll get back information about all the links contained in testFlow:
[
{
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkHelp",
"name": "linkHelp"
},
{
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkPrivacyPolicy",
"name": "linkPrivacyPolicy" },
{
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkTermsOfService",
"name": "linkTermsOfService" }
]
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 | Flow not found. You referenced the name of a flow which can’t be found in the specified application. Use the /config/{app}/flows endpoint to return the names of all the flows contained in the application. |