Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /versions/{flowVersion}
Description
Returns the version of the flow. Each time a flow is updated a new flow version is created.
Respects the API Client Allow List: No
URI Parameters
Parameter | Type | Required | Description |
---|---|---|---|
version | string | Yes | Version number of the flow to be returned. |
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
Sample Request (curl)
This command returns information about version 20180813153404361880 of the documentation flow.
curl -G \
-H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg=' \ https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/versions/20180813153404361880
Running this command in Postman
Responses
200 OK
Response Example (application/json)
{
"authProfileData": [
"name",
"verifiedEmail",
"identifier"
],
"...shortened...": "...for brevity...",
"userData": [
"email",
"displayName"
],
"version": "00000000-0000-0000-0000-000000000000"
}
404 Not Found
Flow Version could not be found. Please check the value and try again.
Response Example (application/json)
{
"errors": "Flow Version not found."
}