TrainingSupportCommunity

Get started

The Configuration API operations use basic authentication. To employ this authentication method, use the client ID of an API client as your username and the client secret of that API client as the password. Both the client ID and client secret can be found in the Manage Properties section of Console (in Console, API clients are referred to as properties):

img

Note that you need to use an API call that has the required permissions when calling an operation. Typically this means a client assigned the owner feature. See the API client permissions section of this documentation for more information.

Create an authentication string

To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is*hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it. On a Mac, you can encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If youā€™re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., WJjZGVmZzpoaWprbG1ub3A) can then be used in your authorization header.

If you're making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password. In this case, there's no need to combine the values and create a base64-encoded string. Postman does that for you automatically.


API client permissions

The following tables list the API client types (based on client features) that can be used to call the Configuration API operations. In order to successfully call an operation the client must include at least one of the features allowed to make the call.

API clients

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Your API Clients GETāœ“āœ—āœ—āœ—āœ—
View a Client GETāœ“āœ—āœ—āœ—āœ—
Modify a Client PUTāœ“āœ—āœ—āœ—āœ—
Reset a Client Secret PUTāœ“āœ—āœ—āœ—āœ—
Create a Client POSTāœ“āœ—āœ—āœ—āœ—
Delete a Client DELETEāœ“āœ—āœ—āœ—āœ—

Application and Client Settings

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
View Application Settings GETāœ“āœ—āœ—āœ—āœ—
View Available Application Settings GETāœ“āœ—āœ—āœ—āœ—
Modify Application Settings PUTāœ“āœ—āœ—āœ—āœ—
View Client Settings GETāœ“āœ—āœ—āœ—āœ—
Modify Client Settings PUTāœ“āœ—āœ—āœ—āœ—

Entity types and attributes

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Entity Types GETāœ“āœ—āœ—āœ—āœ—
View an Entity Type GETāœ“āœ“āœ“āœ“āœ“
List Attributes GETāœ“āœ—āœ—āœ—āœ—
View an Attribute GETāœ“āœ—āœ—āœ—āœ—

Flows

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Flows GETāœ“āœ—āœ“āœ—āœ—
View a Flow GETāœ“āœ—āœ“āœ—āœ—
List Flow Versions GETāœ“āœ—āœ“āœ—āœ—
View a Specified Flow Version GETāœ“āœ—āœ“āœ—āœ—
Modify userData Objects or Entity Types PUTāœ“āœ—āœ—āœ—āœ—
Copy a Flow POSTāœ“āœ—āœ“āœ—āœ—
Restore a Flow POSTāœ“āœ—āœ“āœ—āœ—
Promote a Flow POSTāœ“āœ—āœ“āœ—āœ—

Fields

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Fields GETāœ“āœ—āœ“āœ—āœ—
View a Field GETāœ“āœ—āœ“āœ—āœ—
Modify a Field PUTāœ“āœ—āœ“āœ—āœ—
Create a Field POSTāœ“āœ—āœ“āœ—āœ—
Delete a Field DELETEāœ“āœ—āœ“āœ—āœ—

Forms

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Forms GETāœ“āœ—āœ“āœ—āœ—
View a Form GETāœ“āœ—āœ“āœ—āœ—
Modify a Form PUTāœ“āœ—āœ“āœ—āœ—
Create a Form POSTāœ“āœ—āœ“āœ—āœ—
Delete a Form DELETEāœ“āœ—āœ“āœ—āœ—

Locales

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Locales GETāœ“āœ—āœ“āœ—āœ—
List Localized Fields GETāœ“āœ—āœ“āœ—āœ—
Create a Localized Field POSTāœ“āœ—āœ“āœ—āœ—
View a Localized Field GETāœ“āœ—āœ“āœ—āœ—
Modify a Localized Field PUTāœ“āœ—āœ“āœ—āœ—
Modify a Localized String PUTāœ“āœ—āœ“āœ—āœ—
Delete a String from a Locale DELETEāœ“āœ—āœ“āœ—āœ—

Email Templates

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Your Email Templates GETāœ“āœ—āœ“āœ—āœ—
View an Email Template GETāœ“āœ—āœ“āœ—āœ—
View the Subject Line of an Email GETāœ“āœ—āœ“āœ—āœ—
View the Body of an Email GETāœ“āœ—āœ“āœ—āœ—
Modify an Email PUTāœ“āœ—āœ“āœ—āœ—
Modify the Subject Line of an Email PUTāœ“āœ—āœ“āœ—āœ—
Modify the Body of an Email PUTāœ“āœ—āœ“āœ—āœ—

Strings

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Your Strings GETāœ“āœ—āœ“āœ—āœ—
View String GETāœ“āœ—āœ“āœ—āœ—
List the Localized Strings for a Flow GETāœ“āœ—āœ“āœ—āœ—
View a Localized String GETāœ“āœ—āœ“āœ—āœ—
Modify a String PUTāœ“āœ—āœ“āœ—āœ—
Create a String POSTāœ“āœ—āœ“āœ—āœ—
Create a Localized String POSTāœ“āœ—āœ“āœ—āœ—
Delete a String DELETEāœ“āœ—āœ“āœ—āœ—

Screens

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Screens GETāœ“āœ—āœ“āœ—āœ—
View a Screen GETāœ“āœ—āœ“āœ—āœ—
Modify a Screen PATCHāœ“āœ—āœ“āœ—āœ—
Create a Screen POSTāœ“āœ—āœ“āœ—āœ—
Delete a Screen DELETEāœ“āœ—āœ“āœ—āœ—

Hosted Login Links

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Links GETāœ“āœ—āœ“āœ—āœ—
View a Link GETāœ“āœ—āœ“āœ—āœ—
Modify a Link PUTāœ“āœ—āœ“āœ—āœ—
Create a Link POSTāœ“āœ—āœ“āœ—āœ—
Delete a Link DELETEāœ“āœ—āœ“āœ—āœ—

Hosted Login 2FA Messages

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Your 2FA Messages GETāœ“āœ—āœ“āœ—āœ—
View a 2FA Message GETāœ“āœ—āœ“āœ—āœ—
View the Email Subject Line of a 2FA Message GETāœ“āœ—āœ“āœ—āœ—
Add the Default 2FA Messages to a Flow POSTāœ“āœ—āœ“āœ—āœ—
Modify a 2FA Message PUTāœ“āœ—āœ“āœ—āœ—

Hosted Login Migration

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
View Available Hosted Login Upgrades GETāœ“āœ—āœ“āœ—āœ—
View Requirements for Making a Flow Hosted-Login Compatible GETāœ“āœ—āœ“āœ—āœ—
Upgrade Hosted Login POSTāœ“āœ—āœ“āœ—āœ—

Translations

Endpointowneraccess_issuerdirect_accessdirect_read_accesslogin_client
List Your Translations GETāœ“āœ—āœ“āœ—āœ—
List Localized Translation GETāœ“āœ—āœ“āœ—āœ—
View a Translation GETāœ“āœ—āœ“āœ—āœ—
Modify a Translation PATCHāœ“āœ—āœ“āœ—āœ—
Modify Multiple Translations PATCHāœ“āœ—āœ“āœ—āœ—
Create a Translation POSTāœ“āœ—āœ“āœ—āœ—
Delete a Translation DELETEāœ“āœ—āœ“āœ—āœ—