Jump to Content
Identity Cloud Configuration API
RecipesAPI
Identity Cloud Configuration API
API
RecipesAPI
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}
    • Delete a clientdelete
    • View an API clientget
    • Modify an API clientput
  • /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}
    • Remove a field from a flowdelete
    • Get a specific fieldget
    • Modify a fieldput
  • /config/{app_id}/flows/{flow}/forms
    • List formsget
    • Create a formpost
  • /config/{app_id}/flows/{flow}/forms/{form}
    • Delete a formdelete
    • View a formget
    • Modify a formput
  • /config/{app_id}/flows/{flow}/links
    • List your Hosted Login linksget
    • Create a Hosted Login linkpost
  • /config/{app_id}/flows/{flow}/links/{linkId}
    • View a Hosted Login linkget
    • Modify a Hosted Login linkput
    • Delete a Hosted Login linkdelete
  • /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}
    • Delete a string per localedelete
    • View a localized stringget
    • Modify a localized stringput
  • /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}
    • Delete a screendelete
    • View a screenget
    • Modify a screenput
  • /config/{app_id}/flows/{flow}/strings
    • List available stringsget
    • Create a stringpost
  • /config/{app_id}/flows/{flow}/strings/{string}
    • Delete a stringdelete
    • View a string definitionget
    • Modify a stringput
  • /config/{app_id}/flows/{flow}/translations
    • Get available translationsget
    • Update a Translationpatch
    • Create a translationpost
  • /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


API concepts
Errors
Did this page help you?

Updated over 2 years ago


API concepts
Errors
Did this page help you?
  1. API
  2. Identity Cloud Configuration API
  3. API summary
  4. Get started
  5. API concepts
  6. Other Identity Cloud APIs
  7. Errors
  8. 500
  9. 409
  10. 404
  11. 403
  12. 401
  13. 400
  1. Clients
  2. /config/{app_id}/clients
  3. Create a clientpost
  4. Get permissions for all clientsget
  5. /config/{app_id}/clients/{client_id}
  6. Modify an API clientput
  7. View an API clientget
  8. Delete a clientdelete
  9. /config/{app_id}/clients/{client_id}/secret
  10. Reset a client secretput
  11. /config/{app_id}/clients/{client_id}/settings
  12. Modify API client settingsput
  13. View API client settingsget
  1. Entity Types
  2. /config/{app_id}/entityTypes
  3. Get information about all your entity typesget
  4. /config/{app_id}/entityTypes/{entity_type}
  5. Get information about a specific entity typeget
  6. /config/{app_id}/entityTypes/{entity_type}/attributes
  7. Get information about an entity type's attributesget
  8. /config/{app_id}/entityTypes/{entity_type}/attributes/{attribute_name}
  9. Get information about the specified entity type attributeget
  1. Flows
  2. /config/{app_id}/flows
  3. List flowsget
  4. /config/{app_id}/flows/{flow}
  5. Modify a flowput
  6. View a flowget
  7. /config/{app_id}/flows/{flow}/copy
  8. Copy a flowpost
  9. /config/{app_id}/flows/{flow}/fields
  10. Add a fieldpost
  11. List flow fieldsget
  12. /config/{app_id}/flows/{flow}/fields/{field}
  13. Modify a fieldput
  14. Get a specific fieldget
  15. Remove a field from a flowdelete
  16. /config/{app_id}/flows/{flow}/forms
  17. Create a formpost
  18. List formsget
  19. /config/{app_id}/flows/{flow}/forms/{form}
  20. Modify a formput
  21. View a formget
  22. Delete a formdelete
  23. /config/{app_id}/flows/{flow}/links
  24. Create a Hosted Login linkpost
  25. List your Hosted Login linksget
  26. /config/{app_id}/flows/{flow}/links/{linkId}
  27. Delete a Hosted Login linkdelete
  28. Modify a Hosted Login linkput
  29. View a Hosted Login linkget
  30. /config/{app_id}/flows/{flow}/locales/{locale}
  31. Get translation valuesget
  32. /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages
  33. Add the default 2FA messages to a flowpost
  34. List your 2FA messagesget
  35. /config/{app_id}/flows/{flow}/locales/{locale}/2faMessages/{messageId}
  36. Modify a 2FA messageput
  37. View a 2FA messageget
  38. /config/{app_id}/flows/{flow}/locales/{locale}/fields
  39. Add a translatable fieldpost
  40. Get information about the fields available for the specified flowget
  41. /config/{app_id}/flows/{flow}/locales/{locale}/fields/{field}
  42. Modify a translatable fieldput
  43. Get a translated fieldget
  44. /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates
  45. List email templatesget
  46. /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}
  47. Modify an email templateput
  48. View an email templateget
  49. /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/body
  50. Modify the body of an email templateput
  51. View the body of an email templateget
  52. /config/{app_id}/flows/{flow}/locales/{locale}/mailTemplates/{template}/subject
  53. Modify the subject of an email templateput
  54. Get the subject of an email templateget
  55. /config/{app_id}/flows/{flow}/locales/{locale}/strings
  56. Create a localized stringpost
  57. List available strings per localeget
  58. /config/{app_id}/flows/{flow}/locales/{locale}/strings/{string}
  59. Modify a localized stringput
  60. View a localized stringget
  61. Delete a string per localedelete
  62. /config/{app_id}/flows/{flow}/promote
  63. Promote a flowpost
  64. /config/{app_id}/flows/{flow}/screens
  65. Create screenpost
  66. List available screensget
  67. /config/{app_id}/flows/{flow}/screens/{screen}
  68. Modify a screenput
  69. View a screenget
  70. Delete a screendelete
  71. /config/{app_id}/flows/{flow}/strings
  72. Create a stringpost
  73. List available stringsget
  74. /config/{app_id}/flows/{flow}/strings/{string}
  75. Modify a stringput
  76. View a string definitionget
  77. Delete a stringdelete
  78. /config/{app_id}/flows/{flow}/translations
  79. Create a translationpost
  80. Update a Translationpatch
  81. Get available translationsget
  82. /config/{app_id}/flows/{flow}/translations/{key}
  83. Get translations for a translation keyget
  84. Delete a translation keydelete
  85. /config/{app_id}/flows/{flow}/upgrades
  86. View available Hosted Login upgradesget
  87. /config/{app_id}/flows/{flow}/upgrades/{upgradeId}
  88. Upgrade Hosted Loginpost
  89. View Login upgrade requirementsget
  90. /config/{app_id}/flows/{flow}/versions
  91. List all versions of a flowget
  92. /config/{app_id}/flows/{flow}/versions/{version}
  93. Restore a flowpost
  94. View a flow versionget
  1. Settings
  2. /config/{app_id}/settings
  3. Modify global settingsput
  4. List API client settingsget
  5. /config/{app_id}/settings/options
  6. List application settingsget
  1. Additional operations
  2. /config/{app_id}/flows/{flow}/locales
Akamai TechDocs
Akamai.com
Linode.com
Contact us
Akamai support Linode support Share feedback
Try Akamai
Log in
Log out
Try Akamai

Akamai.com

Linode.com

Contact us Akamai support Linode support Share feedback

Log in
Log out
Legal & privacy Cookie settings Akamai Status
Community Training Control Center Cloud Manager

© 2025 Akamai Technologies