Jump to Content

API

All

Guide

Recipes

API

Release notes

Pages

Start typing to search…

API

Identity Cloud Configuration API
API summary
Get started
API concepts
Other Identity Cloud APIs
Errors
- 400
- 401
- 403
- 404
- 409
- 500

Clients

/config/{app_id}/clients
- Get permissions for all clientsget
- Create a clientpost
/config/{app_id}/clients/{client_id}
/config/{app_id}/clients/{client_id}/secret
- Reset a client secretput
/config/{app_id}/clients/{client_id}/settings
- View API client settingsget
- Modify API client settingsput

Entity Types

/config/{app_id}/entityTypes
- Get information about all your entity typesget
/config/{app_id}/entityTypes/{entity_type}
- Get information about a specific entity typeget
/config/{app_id}/entityTypes/{entity_type}/attributes
- Get information about an entity type's attributesget
/config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}
- Get information about the specified entity type attributeget

Flows

/config/{app_id}/flows
- List flowsget
/config/{app_id}/flows/{flow}
- View a flowget
- Modify a flowput
/config/{app_id}/flows/{flow}/copy
- Copy a flowpost
/config/{app_id}/flows/{flow}/fields
- List flow fieldsget
- Add a fieldpost
/config/{app_id}/flows/{flow}/fields/{field}
/config/{app_id}/flows/{flow}/forms
- List formsget
- Create a formpost
/config/{app_id}/flows/{flow}/forms/{form}
/config/{app_id}/flows/{flow}/links
- List your Hosted Login linksget
- Create a Hosted Login linkpost
/config/{app_id}/flows/{flow}/links/{linkId}
/config/{app_id}/flows/{flow}/locales/{locale}
- Get translation valuesget
/config/{app_id}/flows/{flow}/locales/{locale}/2faMessages
- List your 2FA messagesget
- Add the default 2FA messages to a flowpost
/config/{app_id}/flows/{flow}/locales/{locale}/2faMessages/{messageId}
- View a 2FA messageget
- Modify a 2FA messageput
/config/{app_id}/flows/{flow}/locales/{locale}/fields
- Get information about the fields available for the specified flowget
- Add a translatable fieldpost
/config/{app_id}/flows/{flow}/locales/{locale}/fields/{field}
- Get a translated fieldget
- Modify a translatable fieldput
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates
- List email templatesget
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}
- View an email templateget
- Modify an email templateput
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
- View the body of an email templateget
- Modify the body of an email templateput
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
- Get the subject of an email templateget
- Modify the subject of an email templateput
/config/{app_id}/flows/{flow}/locales/{locale}/strings
- List available strings per localeget
- Create a localized stringpost
/config/{app_id}/flows/{flow}/locales/{locale}/strings/{string}
/config/{app_id}/flows/{flow}/promote
- Promote a flowpost
/config/{app_id}/flows/{flow}/screens
- List available screensget
- Create screenpost
/config/{app_id}/flows/{flow}/screens/{screen}
/config/{app_id}/flows/{flow}/strings
- List available stringsget
- Create a stringpost
/config/{app_id}/flows/{flow}/strings/{string}
/config/{app_id}/flows/{flow}/translations
/config/{app_id}/flows/{flow}/translations/{key}
- Delete a translation keydelete
- Get translations for a translation keyget
/config/{app_id}/flows/{flow}/upgrades
- View available Hosted Login upgradesget
/config/{app_id}/flows/{flow}/upgrades/{upgradeId}
- View Login upgrade requirementsget
- Upgrade Hosted Loginpost
/config/{app_id}/flows/{flow}/versions
- List all versions of a flowget
/config/{app_id}/flows/{flow}/versions/{version}
- View a flow versionget
- Restore a flowpost

Settings

/config/{app_id}/settings
- List API client settingsget
- Modify global settingsput
/config/{app_id}/settings/options
- List application settingsget

Additional operations

/config/{app_id}/flows/{flow}/locales

Other Identity Cloud APIs

In addition to the Configuration API, Identity Cloud also includes the following API collections:

Identity Cloud Authentication API
Identity Cloud Custom Providers API
Identity Cloud Entity and EntityType API
Identity Cloud Hosted Login API
Identity Cloud Legacy Clients and Settings API
Identity Cloud SIEM Event Delivery API
Identity Cloud Social Login API
Identity Cloud Webhooks v3 API

Updated over 2 years ago

Did this page help you?

Updated over 2 years ago

Did this page help you?

API
Identity Cloud Configuration API
API summary
Get started
API concepts
Other Identity Cloud APIs
Errors
500
409
404
403
401
400

Clients
/config/{app_id}/clients
Create a clientpost
Get permissions for all clientsget
/config/{app_id}/clients/{client_id}
Modify an API clientput
View an API clientget
Delete a clientdelete
/config/{app_id}/clients/{client_id}/secret
Reset a client secretput
/config/{app_id}/clients/{client_id}/settings
Modify API client settingsput
View API client settingsget

Entity Types
/config/{app_id}/entityTypes
Get information about all your entity typesget
/config/{app_id}/entityTypes/{entity_type}
Get information about a specific entity typeget
/config/{app_id}/entityTypes/{entity_type}/attributes
Get information about an entity type's attributesget
/config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}
Get information about the specified entity type attributeget

Flows
/config/{app_id}/flows
List flowsget
/config/{app_id}/flows/{flow}
Modify a flowput
View a flowget
/config/{app_id}/flows/{flow}/copy
Copy a flowpost
/config/{app_id}/flows/{flow}/fields
Add a fieldpost
List flow fieldsget
/config/{app_id}/flows/{flow}/fields/{field}
Modify a fieldput
Get a specific fieldget
Remove a field from a flowdelete
/config/{app_id}/flows/{flow}/forms
Create a formpost
List formsget
/config/{app_id}/flows/{flow}/forms/{form}
Modify a formput
View a formget
Delete a formdelete
/config/{app_id}/flows/{flow}/links
Create a Hosted Login linkpost
List your Hosted Login linksget
/config/{app_id}/flows/{flow}/links/{linkId}
Delete a Hosted Login linkdelete
Modify a Hosted Login linkput
View a Hosted Login linkget
/config/{app_id}/flows/{flow}/locales/{locale}
Get translation valuesget
/config/{app_id}/flows/{flow}/locales/{locale}/2faMessages
Add the default 2FA messages to a flowpost
List your 2FA messagesget
/config/{app_id}/flows/{flow}/locales/{locale}/2faMessages/{messageId}
Modify a 2FA messageput
View a 2FA messageget
/config/{app_id}/flows/{flow}/locales/{locale}/fields
Add a translatable fieldpost
Get information about the fields available for the specified flowget
/config/{app_id}/flows/{flow}/locales/{locale}/fields/{field}
Modify a translatable fieldput
Get a translated fieldget
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates
List email templatesget
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}
Modify an email templateput
View an email templateget
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
Modify the body of an email templateput
View the body of an email templateget
/config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
Modify the subject of an email templateput
Get the subject of an email templateget
/config/{app_id}/flows/{flow}/locales/{locale}/strings
Create a localized stringpost
List available strings per localeget
/config/{app_id}/flows/{flow}/locales/{locale}/strings/{string}
Modify a localized stringput
View a localized stringget
Delete a string per localedelete
/config/{app_id}/flows/{flow}/promote
Promote a flowpost
/config/{app_id}/flows/{flow}/screens
Create screenpost
List available screensget
/config/{app_id}/flows/{flow}/screens/{screen}
Modify a screenput
View a screenget
Delete a screendelete
/config/{app_id}/flows/{flow}/strings
Create a stringpost
List available stringsget
/config/{app_id}/flows/{flow}/strings/{string}
Modify a stringput
View a string definitionget
Delete a stringdelete
/config/{app_id}/flows/{flow}/translations
Create a translationpost
Update a Translationpatch
Get available translationsget
/config/{app_id}/flows/{flow}/translations/{key}
Get translations for a translation keyget
Delete a translation keydelete
/config/{app_id}/flows/{flow}/upgrades
View available Hosted Login upgradesget
/config/{app_id}/flows/{flow}/upgrades/{upgradeId}
Upgrade Hosted Loginpost
View Login upgrade requirementsget
/config/{app_id}/flows/{flow}/versions
List all versions of a flowget
/config/{app_id}/flows/{flow}/versions/{version}
Restore a flowpost
View a flow versionget

Settings
/config/{app_id}/settings
Modify global settingsput
List API client settingsget
/config/{app_id}/settings/options
List application settingsget

Additional operations
/config/{app_id}/flows/{flow}/locales

Akamai.com

Linode.com

Akamai support Linode support Share feedback

Log out

Try Akamai

Akamai.com

Linode.com

Contact us Akamai support Linode support Share feedback

Log out

Legal & privacy Cookie settings Akamai Status

Community Training Control Center Cloud Manager

© 2025 Akamai Technologies