Jump to Content

API

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

Get a specific field

get https://{hostname}/config/{app_id}/flows/{flow}/fields/{field}

Returns information about a field.

Language

URL

Click Try It! to start a request and see the response here!

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