API Client Permissions: Flow and Flow Management API

Last Modified on 02/24/2021 4:44 pm PST

The following tables list the API client types (based on client features) that can be used to call the Configuration API's Flow and Flow Management endpoints.

Flows

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Flows GET /config/{appId}/flows	Yes	No	Yes	No	No
View a Flow GET /config/{appId}/flows/{flow)	Yes	No	Yes	No	No
List Flow Versions GET /config/{appId}/flows/{flow}/versions	Yes	No	Yes	No	No
View a Specified Flow Version GET /config/{appId}/flows/{flow}/versions/{versionId}	Yes	No	Yes	No	No
Modify userData Objects or Entity Types PUT /config/{appId}/flows/{flow}	Yes	No	No	No	No
Copy a Flow POST /config/{appId}/flows/{flow}/copy	Yes	No	Yes	No	No
Restore a Flow POST /config/{appId}/flows/{flow}/versions/{versionId}	Yes	No	Yes	No	No
Promote a Flow POST /config/{appId}/flows/{flow}/promote	Yes	No	Yes	No	No

Fields

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Fields GET /config/{appId}/flows/{flow}/fields	Yes	No	Yes	No	No
View a Field GET /config/{appId}/flows/{flow}/fields/{field}	Yes	No	Yes	No	No
Modify a Field PUT /config/{appId}/flows/{flow}//fields/{field}	Yes	No	Yes	No	No
Create a Field POST /config/{appId}/flows/{flow}/fields	Yes	No	Yes	No	No
Delete a Field DELETE /config/{appId}/flows/{flow}/fields/{field}	Yes	No	Yes	No	No

Forms

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Forms GET /config/{appId}/flows/{flow}/forms	Yes	No	Yes	No	No
View a Form GET /config/{appId}/flows/{flow}/forms{/form}	Yes	No	Yes	No	No
Modify a Form PUT /config/{appId}/flows/{flow}/forms/{form}	Yes	No	Yes	No	No
Create a Form POST /config/{appId}/flows/{flow}/forms	Yes	No	Yes	No	No
Delete a Form DELETE /config/{appId}/flows/{flow}/forms/{form}	Yes	No	Yes	No	No

Locales

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Locales GET /config/{appId}/flows/{flow}/locales	Yes	No	Yes	No	No
List Localized Fields GET /config/{appId}/flows/{flow}/locales/{locale}/fields	Yes	No	Yes	No	No
Create a Localized Field POST /config/{appId}/flows/{flow}/locales/{locale}/fields	Yes	No	Yes	No	No
View a Localized Field GET /config/{appId}/flows/{flow}/locales /{locale}/fields/{field}	Yes	No	Yes	No	No
Modify a Localized Field PUT /config/{appId}/flows/{flow}/locales/ {locale}/fields/{field}	Yes	No	Yes	No	No
Modify a Localized String PUT /config/{appId}/flows/{flow}/locales /{locale}/strings/{string}	Yes	No	Yes	No	No
Delete a String from a Locale DELETE /config/{appId}/flows/{flow}/locales/ {locale}/strings/{string}	Yes	No	Yes	No	No

Email Templates

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Your Email Templates GET /config/{appId}/flows/{flow}/locales/{locale} /mailTemplates	Yes	No	Yes	No	No
View an Email Template GET /config/{appId}/flows/{flow}/locales/ {locale}/mailTemplates/ {template}	Yes	No	Yes	No	No
View the Subject Line of an Email GET /config/{appId}/flows/{flow}/locales/{locale} /mailTemplates/ {template}/subject	Yes	No	Yes	No	No
View the Body of an Email GET /config/{appId}/flows/{flow}/locales/{locale} /mailTemplates/ {template}/body	Yes	No	Yes	No	No
Modify an Email PUT /config/{appId}/flows/{flow}/locales/{locale} /mailTemplates/ {template}	Yes	No	Yes	No	No
Modify the Subject Line of an Email PUT /config/{appId}/flows/{flow}/locales/{locale}/ mailTemplates/ {template}/subject	Yes	No	Yes	No	No
Modify the Body of an Email PUT /config/{appId}/flows/{flow}/locales/{locale} /mailTemplates/ {template}/body	Yes	No	Yes	No	No

Strings

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Your Strings GET /config/{appId}/flows/{flow}/strings	Yes	No	Yes	No	No
View String GET /config/{appId}/flows/{flow}/strings/{string}	Yes	No	Yes	No	No
List the Localized Strings for a Flow GET /config/{appId}/flows/{flow}/locales/{locale}/strings	Yes	No	Yes	No	No
View a Localized String GET /config/{appId}/flows/{flow}/locales/ {locale}/strings/{string}	Yes	No	Yes	No	No
Modify a String PUT /config/{appId}/flows/{flow}/strings/{string}	Yes	No	Yes	No	No
Create a String POST /config/{appId}/flows/{flow}/strings	Yes	No	Yes	No	No
Create a Localized String POST /config/{appId}/flows/{flow}/locales/{locale}/strings	Yes	No	Yes	No	No
Delete a String DELETE /config/{appId}/flows/{flow}/strings/{string}	Yes	No	Yes	No	No

Screens

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Screens GET /config/{appId}/flows /{flow}/screens	Yes	No	Yes	No	No
View a Screen GET /config/{appId}/flows /{flow}/screens/{screen}	Yes	No	Yes	No	No
Modify a Screen PATCH /config/{appId}/flows /{flow}/screens/{screen}	Yes	No	Yes	No	No
Create a Screen POST /config/{appId}/flows /{flow}/screens	Yes	No	Yes	No	No
Delete a Screen DELETE /config/{appId}/flows /{flow}/screens/{screen}	Yes	No	Yes	No	No

Hosted Login Links

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Links GET /config/{appId}/flows/{flow}/links	Yes	No	Yes	No	No
View a Link GET /config/{appId}/flows/{flow}/links/{link}	Yes	No	Yes	No	No
Modify a Link PUT /config/{appId}/flows/{flow}/links/{link}	Yes	No	Yes	No	No
Create a Link POST /config/{appId}/flows/{flow}/links	Yes	No	Yes	No	No
Delete a Link DELETE /config/{appId}/flows/{flow}/links/{link}	Yes	No	Yes	No	No

Hosted Login 2FA Messages

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Your 2FA Messages GET /config/{appId}/flows/{flow}/locales/ {locale}/2faMessages	Yes	No	Yes	No	No
View a 2FA Message GET /config/{appId}/flows/{flow}/locales/ {locale}/2faMessages/{message}	Yes	No	Yes	No	No
View the Email Subject Line of a 2FA Message GET /config/{appId}/flows/{flow}/2faMessages /{message}/email/subject	Yes	No	Yes	No	No
Add the Default 2FA Messages to a Flow POST /config/{appId}/flows/{flow}/2faMessages	Yes	No	Yes	No	No
Modify a 2FA Message PUT /config/{appId}/flows/{flow}/locales /{locale}/2faMessages/{message}	Yes	No	Yes	No	No

Hosted Login Migration

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
View Available Hosted Login Upgrades GET /config/{appId}/flows/{flow}/upgrades	Yes	No	Yes	No	No
View Requirements for Making a Flow Hosted-Login Compatible GET /config/{appId}/flows/{flow}/upgrades /{upgradeId}	Yes	No	Yes	No	No
Upgrade Hosted Login POST /config/{appId}/flows/{flow}/upgrades /{upgradeId}	Yes	No	Yes	No	No

Translations

Endpoint	owner	access_ issuer	direct_ access	direct_read _access	login_client
List Your Translations GET /config/{appId}/flows/{flow}/translations	Yes	No	Yes	No	No
List Localized Translation GET /config/{appId}/flows/{flow}/locales/{locale}	Yes	No	Yes	No	No
View a Translation GET /config/{appId}/flows/{flow}/translations/{keyId}	Yes	No	Yes	No	No
Modify a Translation PATCH /config/{appId}/flows/{flow}/translations	Yes	No	Yes	No	No
Modify Multiple Translations PATCH /config/{appId}/flows/{flow}/translations	Yes	No	Yes	No	No
Create a Translation POST /config/{appId}/flows/{flow}/translations	Yes	No	Yes	No	No
Delete a Translation DELETE /config/{appId}/flows/{flow}/translations/{keyId}	Yes	No	Yes	No	No

Rate this Article

How would you rate this article?

Copyright © 2015 – 2016 Your Company, LLC. All rights reserved.