Create a Hosted Login link

post

https://{hostname}/config/{app_id}/flows/{flow}/links

Creates a new Hosted Login link in the specified flow.

Body Params

Creates a new link in the specified flow and the specified Identity Cloud application.

key

string

Reference to a translation key containing the actual text of the link. The endpoint can only be used to point the link towards a different translation key.

path

string

Reference to the internal path of the translation key.

values

string

Locales and localized translations for the translation key.

elementHref

string

URL of the page to be opened when the link is clicked.

name

string

Name of the link.

target

string

HTML target value that specifies how the referenced page should be opened. You should set target to _blank, which causes the referenced page to open in either a new window or a new browser tab, depending on how the user’s browser has been configured. If target is omitted, the value defaults to opening the specified URL in the current tab.

Responses

201Successful response

404Flow not found. You referenced the name of a flow that can’t be found in the specified application.

409Link already exists. You’ve specified a link name that’s already in use. Change the name of the link and try again.