Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /links/{link}
Description
Removes the specified link from the flow.
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 deleted. |
{link} | string | Name of the link to be deleted. |
Query Parameters
The following query parameters can also be used with this endpoint:
Parameter | Type | Required | Description |
|---|---|---|---|
force | boolean | No | Deletes the link even if the link is currently “in use” (i.e., is associated with one or more forms). If the link is in use, the force parameter not only deletes the link itself, but also removes the link from any forms it’s associated with. |
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 deletes a link named testLink2 from the flow testFlow:
curl -X DELETE \
'https://v1.api.us.janrain.com/config/79y4mqf2rt3bxs378kw5479xdu/flows/testFlow/links/testLink2' \
-H 'Authorization: Basic eTR4Zmc2ZjQ0bXNhYzN2ZXBqanZ4Z2d6dnQzZTNzazk6OTVjY3hrN2N6YnZ1eng2ZHB0ZTVrOXA2ZGo1Ynpla3U='
Responses
204 No Content
If your call to this endpoint succeeds you will get back the HTTP status code 204 No Content. No other data is returned.
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 which is not defined within the flow. |
409 | Resource currently locked. Please try again later. The link you are attempting to remove is currently associated with one or more forms. Either remove the link from each form and try again, or include the force parameter in your call. The force parameter removes the link from the flow and from any forms that reference the link. |