List Your Fields

Endpoint URL: {identityDomain} /config/{appId} /flows/{flow} /fields


Description

Returns a list of fields defined in the flow. A field essentially represents a user profile attribute; for example, a flow will typically have fields for a user's first name, a user's address, a user's phone number, etc.


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


Sample Request (curl)

This command returns all the fields for the documentation flow associated with the application htb8fuhxnf8e38jrzub3c7pfrr.


curl -G \
  -H 'Authorization: Basic c2dueXZ1czZwYzRqbTdraHIybmVxNWdzODlnYnIyZXE6d3Q0YzN1bjl3a2tjZnZ5a25xeDQ0eW5jNDc2YWZzNjg' \
  https://v1.api.us.janrain.com/config/htb8fuhxnf8e38jrzub3c7pfrr/flows/documentation/fields 

      Running this command in Postman


Responses

200 OK

Response Example (application/json)


[
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/signInEmailAddress",
    "name": "signInEmailAddress"
  },
  {
    "_self": "/config/v86cchggr5cdvbfh7ydk8s63zz/flows/myCoolFlow/fields/currentPassword",
    "name": "currentPassword"
  }

]

404 Not Found

Flow could not be found. Please check the value and try again.

Response Example (application/json)


{
  "errors": "Flow not found."
}