Janrain provides access to advanced features through a RESTful web API that requires only the ability to post HTTP requests and parse XML or JSON responses. You can use these requests to retrieve contact data, map an identity to multiple accounts, gain access to analytics, and more. The RESTful format allows you to communicate with your application, and relay the results to your own site.
Janrain also uses RESTful APIs for user authentication.
Note: Our RESTful API supports both POST and GET methods, but for security reasons, POST should be used.
|POST/clients/add||Add a new client to Capture. Once created, your new client will have access to the Capture API, an...|
|POST/clients/clear_whitelist||Clear the IP whitelist for a target client, resetting it to the default value that allows all IP add...|
|POST/clients/delete||Delete a client from Capture. Only the 'owner' client may make this API call....|
|POST/clients/list||Get a list of the clients in your Capture application, optionally filtered by client feature. Only t...|
|POST/clients/set_description||Change the description of a client. This can also be thought of as the "name" of the client.
|POST/clients/set_features||Change the features that a target client has by overwriting the old feature list. This API call may ...|
|POST/clients/set_whitelist||Change the IP whitelist for a target client, overwriting the previous whitelist. Only the 'owner' cl...|
|POST/entity||Retrieve a single entity (and any nested objects).
Validating User Passwords
|POST/entity.adopt||This call adopts an orphaned plural element into a parent plural. Orphaned plural elements do not be...|
|POST/entity.bulkCreate||Create multiple new data records of a specific entityType in a single API call. If the requ...|
|POST/entity.count||Count the number of records in an entityType....|
|POST/entity.create||Create a new data record for an entityType. Once created, Capture returns the new id...|
|POST/entity.delete||Delete a single entity (and any nested objects) from an application, or delete an element of a plura...|
|POST/entity.bulkDelete||Used to select, and delete a range of records. A set of operators are used to build a query which is...|
|POST/entity.find||Retrieve user information from an application. These data entities are returned in JSON format. This...|
|POST/entity.purge||Use entity.purge to both permanently delete all entities in the specified entityType...|
|POST/entity.replace||Replace part of an entity with a value. Any object attributes that you do not spec...|
|POST/entity.update||Updates part of an existing entity by appending attributes with data. This data is provided in a JSO...|
|POST/oauth/auth_native||Use this call for standard, mobile, native authorization. This call necessarily refers to a flow. If...|
|POST/oauth/auth_native_traditional||Use this call to create a traditional username and password-type, sign-in process for mobile applica...|
|POST/oauth/forgot_password_native||This call's behavior is determined primarily by your flow and the form parameter you pass i...|
|POST/oauth/link_account_native||Use this call to link user accounts.
Flow Name and Flow Version
The locale, ...|
|POST/oauth/register_native||This is the second step in two-step registration. You must have previously called auth_native...|
|POST/oauth/register_native_traditional||This call creates a new user. This call necessarily refers to a flow. If you do not use the optional...|
|POST/oauth/token||Exchange an authorization code for an access_token.
There are two ways to authenticate C...|
|POST/oauth/verify_email_native||This call's behavior is determined primarily by your flow and the form parameter you pass i...|
|POST/settings/delete||Delete a key from the settings for a particular client. Returns a Boolean indicating whether the key...|
|POST/settings/delete_default||Delete a key from the application-wide default settings. Returns a Boolean indicating whether the ke...|
|POST/settings/get||Get the value associated with a key for a particular client_id. If the key has no value for...|
|POST/settings/get_multi||Look up multiple keys. Each value is retrieved, as in the settings/get command, by first lo...|
|POST/settings/items||Get all settings for a particular client, including those from the application-wide default settings...|
|POST/settings/keys||Get all keys for a particular client, including those from the application-wide default settings. Re...|
|POST/settings/set||Assign a key-value pair for a particular client_id. If the key does not exist, it will be c...|
|POST/settings/get_default||Get the default value of a key for the current application. Returns the value of the key, or null if...|
|POST/settings/set_default||Set the application-wide default value for a key. This will create a new key with a default value, ...|
|POST/settings/set_multi||Assign multiple settings for a particular client_id. Returns a JSON object in which each ke...|
|POST/versions/entity||Retrieve a past value of single entity by primary key and timestamp.
The example below s...|
|POST/versions/entityType||Retrieve a past schema of an entityType by timestamp.
Formatting the 'timesta...|
|POST/webhooks/add||This is used to add and configure a webhook. Once this RESTful call is successfully made, the attrib...|
|POST/webhooks/delete||This deletes a webhook. ...|
|POST/webhooks/find||This returns the configuration of a specific webhook....|
|POST/webhooks/list||Returns a list of all the configured webhooks associated with an installation of Capture....|
|POST/webhooks/update||This updates an existing webhook. Values passed in the parameters overwrite the current configuratio...|
|POST/entityType||Return a JSON representation of an existing entityType....|
|POST/entityType.addAttribute||Adds an attribute to an existing entityType. This adds that attribute to all objects of tha...|
|POST/entityType.addRule||This call creates rules for user data validation on specific attributes in your schema.
|POST/entityType.create||Create a new entityType with the specified set of attributes.
EntityType JSON Struct...|
|POST/entityType.getAccessSchema||Retrieve the access schema for a particular client. An access schema defines the subset of attribut...|
|POST/entityType.list||Return a JSON representation of all entityTypes....|
|POST/entityType.removeAttribute||Remove an existing attribute from an entityType.
Warning: All data asso...|
|POST/entityType.removeRule||This removes any data validation currently configured for a specific attribute in a schema.
|POST/entityType.rules||This lists the data validation rules that are currently set on a specific entityType. Each ...|
|POST/entityType.setAccessSchema||Set the access schema for a particular client. An access schema defines the subset of attributes to ...|
|POST/entityType.setAttributeConstraints||Set the list of constraints for an attribute.
Warning: This is not an additive o...|
|POST/add_or_update_access_token||Adds or updates an OAuth access_token for a user outside the usual Engage sign-in flow.
|POST/analytics_access||The analytics_access call returns the analytic data from your application. This can be auto...|
|POST/auth_info||This call is used to authenticate users for Engage. You must use https to make thi...|
|POST/get_app_settings||Enables you to make API calls to get the following application properties (from the application sett...|
|POST/get_available_providers||Returns a list of configured providers for an application. The ...|
|POST/get_contacts||The get_contacts call uses the apiKey and identifier to return a list of ...|
|POST/get_user_data||Use the get_user_data call to obtain an up-to-date copy of a user's profile as previously r...|
|POST/providers||This call returns a list of configured sign-in or social providers configured for a widget. ...|
|POST/set_app_settings||Enables you to make API calls to set the following application properties (from the application sett...|
|POST/set_auth_providers||Use set_auth_providers to define the list of identity providers provided by the Engage serv...|
|POST/all_mappings||The all_mappings call returns all of the stored mappings of an application, which is identi...|
|POST/map||Use the map to associate a primary key with a user's social identity.
|POST/mappings||The mappings call returns all the stored Identity Providers associated with a particular user's prim...|
|POST/unmap||Unmapping removes an Identity Provider from a primary key as well as allowing you to optionally unli...|
|POST/sharing/broadcast||The broadcast call shares activity information directly with a provider. The information pr...|
|POST/sharing/direct||This API shares activity information directly with the specified recipients on a provider's networ...|
|POST/get_share_count||Returns the number of a times a given URL has been shared....|
|POST/get_share_providers||Note: This API call works only with the current Sharing widget.
It returns a lis...|
|POST/set_share_providers||Use set_share_providers to define the providers offered by the new ...|
|POST/add_domain_patterns||Use the add_domain_patterns call to append domains to the current whitelist for an applicat...|
|POST/get_backplane_properties||Use this call for Backplane Protocol enabled widgets only. For more information on updating widgets ...|
|POST/get_domain_patterns||Use this call to return a list of all domains currently whitelisted for an application....|
|POST/lookup_rp||We provide the lookup_rp call to help developers integrate Janrain Engage into your plugin....|
|POST/set_backplane_properties||The set_backplane_properties call configures the Backplane server used to communicate with ...|
|POST/set_domain_patterns||Use the set_domain_patterns call to replace the current whitelist for an application....|
|POST/activity||This is a legacy call, and should only be used with existing ...|
|POST/auth_infos||This is a legacy call, and should only be used with existing ...|
|POST/set_status||This is a legacy call, and should only be used with existing ...|
|POST/app/add_bp_bus||This call creates a bus owner and password, and a new Backplane bus with the new owner the owner of ...|
|POST/apps||This call lists all applications managed by a partner. This constitutes one "parent" RP and some num...|
|POST/admin/add||This call adds an administrator user to the RP.
Note: Multiple user entities can...|
|POST/admin/delete||This call deletes an admin user on an RP.
Note: The API call will not delete an ...|
|POST/admin/get||This call returns all admin users currently assigned to the RP. It also lists the email associated w...|
|POST/app/add_domain||This call adds a domain to an existing Engage application....|
|POST/app/create||This call creates a new Engage application. You can use the new application immediately for authenti...|
|POST/app/create_invite||This call generates an email invitation for administrative access to an existing application....|
|POST/app/delete||This call deletes an existing Engage application. This operation completely destroys the Engage appl...|
|POST/app/get_pending_invites||This API call is deprecated. Please use the ...|
|POST/app/get_properties||This call returns a list of the configured properties for an Engage application. You can use this in...|
|POST/app/get_provider_permissions||This call returns an Engage application’s permissions for a provider, as set with the set_prov...|
|POST/app/reset_api_key||This call resets the API key for a given partner RP application....|
|POST/app/set_properties||This call configures Engage application properties for a given application. Use this function to bin...|
|POST/app/set_provider_permissions||This call sets an Engage application’s permissions for a provider. The permissions that you can se...|
|POST/app/verify_domain||This function automates the server-side component of the provider-specific domain verification mecha...|
Help Us Improve!
Give us your feedback