Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /copy
Description
Creates a new flow by copying an existing flow; flows are JSON files that help manage the user login and registration experience. Note that this endpoint can only create a new flow based on an existing flow: it cannot be used to update an existing flow.
Respects the API Client Allow List: No
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 supports Basic authentication.
How to Create an Authentication String
Base URL
The base URL for this endpoint is your Configuration API domain followed by /config/ followed by your application ID. For example, if you are in the US region and your application ID is htb8fuhxnf8e38jrzub3c7pfrr, then your base URL would be:
https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr
Allowed regions are:
- us
- eu
- au
- sa
- cn
- sg
Request Example (application/json)
{
"name": "myCoolFlow"
}
Sample Request (curl)
This command copies the standard flow and the creates a new flow (documentation) based on the standard flow.
curl -X POST \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/standard/copy \ -H 'Authorization: Basic
c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \ -H 'Content-Type: application/json' \ -d '{ "name": "documentation" }'
Running this command in Postman
Responses
201 Created
Successfully created a new flow.
Response Headers
Location string
The location of the newly-created flow.
Example: Location: /config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow
Response Example (application/json)
{
"_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow",
"name": "myCoolFlow",
"version": "2015111705580676795"
}
404 Not Found
Capture application could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Flow not found."
}