The Legacy Clients and Settings API can be used to manage API clients and applications. As the word "legacy" implies, however, this API no longer represents the preferred way to programmatically manage API clients and applications. Instead, we recommend you use the Clients and Settings API for those purposes. The legacy API is still supported and the endpoints still work. However, the new API is easier to use, and adheres better to the standard REST API syntax and approach.
If you decide (perhaps for backwards compatibility reasons) to use the Legacy Clients and Settings API, that API offers the following endpoints:
Clients Endpoints
The /clients/* endpoints are used for creating, deleting, and editing Registration clients. A client has access to the API (and, if applicable) the UI. Default clients have no permissions, so you need to configure them in the Console unless you add permissions using the features parameter. The client_id and client_secret are generated by Akamai and included in the API response. A /clients/* call may only be made by the owner client, denoted by the owner icon in the Dashboard. These endpoints are also used to reset client secrets.
- /clients/add
- /clients/clear_whitelist
- /clients/delete
- /clients/list
- /clients/reset_secret
- /clients/set_description
- /clients/set_features
- /clients/set_whitelist
Settings Endpoints
The /settings/* endpoints are used to make changes to your Registration Dashboard settings. You can change your own settings or use the from_client_id parameter to change another user's settings. You need to have owner permission to make changes to any account that is not your own. See individual endpoints for call examples and different use cases.
- /settings/delete
- /settings/delete_default
- /settings/get
- /settings/get_default
- /settings/get_multi
- /settings/items
- /settings/keys
- /settings/set
- /settings/set_default
- /settings/set_multi
- /settings/widget/delete
- /settings/widget/get
- /settings/widget/list
- /settings/widget/publish
Accessing the Legacy Clients and Settings Endpoints
The legacy Clients and Settings API uses the following endpoint syntax:
To access your client and setting endpoints, replace {appId} with the name of your Identity Cloud Capture domain, and replace {endpoint} with the name of the endpoint you want to use. For example:
https://educationcenter.us-dev.janraincapture.com/clients/list
Authentication
The Legacy Clients and Settings API supports basic HTTP authentication using Capture login_client credentials. To create the authorization code, combine your client ID and secret like this clientId + ":" + secret, then base64 encode the result.
Authorization string
Used to send the authorization code.
Example: