Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /links/{link}
Description
Returns detailed information about a Hosted Login link.
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 these links (terms of service and privacy policy) which enable users to access information without leaving the registration screen:
The /config/{app}/flows/{flow}/links{link} endpoint and the GET method enables you to return detailed information about a specific link.
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 containing the link to be returned. |
{link} | string | Name of the link to be returned. |
Query Parameters
The following query parameters can also be used with this endpoint:
Parameter | Type | Required | Description |
|---|---|---|---|
locale | string | No | When included, limits the returned data to the specified locale; without this parameter information is returned for all your locales. Note that a 500 Internal Server error will occur if you specify a locale that does not exist in your flow. Use the /config/{app}/flows/{flow}/locales endpoint to return a list of available locales. |
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)
The following command returns information about the linkHelp link contained in a flow named testFlow:
curl -X GET \
'https://v1.api.us.janrain.com/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkHelp' \
-H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U='
Responses
200 OK
If your call to this endpoint succeeds you’ll get a response containing detailed information about the link:
{
"elementHref": "#",
"elementText": {
"key": "12ed346de096c8dd8f5407ad1aa4aaa6",
"path": "fields.linkHelp.elementText",
"values": {
"en-US": "Visit our help center.",
"fr-CA": "Visitez notre centre d'aide.",
"he": "",
"it-IT": ""
},
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/translations/12ed346de096c8dd8f5407ad1aa4aaa6"
},
"name": "linkHelp",
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkHelp"
}
If you included the locale parameter then the API response will look similar to this, with the returned data being limited to the specified locale:
{
"elementHref": "https://identitydocs.akamai.com",
"elementText": "Visitez notre centre d'aide.",
"name": "linkHelp",
"_self": "/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/linkHelp"
}
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 | Link not found. You specified the name of a link that is not defined in the flow. |