Legacy Clients and Settings API
"Legacy" APIs used for managing applications and API clients
Important. For backwards compatibility reasons, the Legacy Clients and Settings API is still supported and still works. However, we strongly recommend that you use the new Clients and Settings API instead.
The Client endpoints are used for creating, deleting, and editing Registration clients, while Settings endpoints are used to make changes to your Registration Dashboard settings.
An introduction to the Legacy Clients and Settings API can be found here:
The actual API endpoints are shown below.
| /clients/add Creates a new API client (property). API clients are used to manage access to the Janrain APIs. |
POST |
| /clients/clear_whitelist Clears the IP whitelist for an API client. When a whitelist is cleared, any device, regardless of IP address, can use the client to make API calls. |
POST |
| /clients/delete Deletes an API client. |
POST |
| /clients/list Returns a list of all the API clients associated with an application. |
GET |
| /clients/reset_secret Resets an API client secret. Resetting a client secret is equivalent to chaging the client password. |
POST |
| /clients/set_description Renames an API client. |
POST |
| /clients/set_features Assigns the features for an API client. Features specify the access permissions for a client; for example, a client with the access_issuer feature is allowed to issue access tokens for other clients. |
POST |
| /clients/set_whitelist Configures the IP whitelist for an API client. When the whitelist is configured, only devices with an IP address included on the whitelist can use the client to make API calls. |
POST |
| /settings/delete Removes the specified setting from a specific API client. |
POST |
| /settings/delete_default Removes the specified key from a specific application. This endpoint removes global keys without affecting local keys configured on individual API clients. |
POST |
| /settings/get Returns the value of the specified setting from an API client. |
GET |
| /settings/get_default Returns the value of the specified global setting from an application. |
GET |
| /settings/get_multi Returns multiple setting values from an API client. |
GET |
| /settings/items Returns all the setting values for an API client. |
GET |
| /settings/keys Returns the names of all the settings (but not the values configured for those settings) for an API client. |
GET |
| /settings/set Configures the specified setting for an API client. |
POST |
| /settings/set_default Configures an application setting. |
POST |
| /settings/set_default_multi Configures multiple application settings. |
POST |
| /settings/set_multi Configures multiple API client settings. |
POST |
| /settings/widget/delete Deletes all the published settings for an API client. |
POST |
| /settings/widget/get Returns the published settings for an API client. |
POST |
| /settings/widget/list Returns the published settings for an application. |
POST |
| /settings/widget/publish Publishes API client settings to a JSON file, making these settings available for client-side use with the Registration UI. This enables these settings to be loaded prior to any server-side calls. |
POST |