org.mule.modules

mule-module-janrain

config

Namespace	http://www.mulesoft.org/schema/mule/janrain
Schema Location	http://www.mulesoft.org/schema/mule/janrain/current/mule-janrain.xsd (View Schema)
Schema Version	2.0
Minimum Mule Version	3.4

Module Overview

Janrain Cloud Connector for API V2.

Summary

Configuration
<janrain:config> Configure an instance of this module

Message Processors
<janrain:activity> Activity
<janrain:add-admin> Add Admin
<janrain:add-bp-bus> Add Bp Bus
<janrain:add-client> Add Client
<janrain:add-domain> Add Domain
<janrain:add-domain-patterns> Add Domain Patterns
<janrain:add-or-update-access-token> Add Or Update Access Token
<janrain:all-mappings> All Mappings
<janrain:analytics-access> Analytics Access
<janrain:apps> Apps
<janrain:auth-info> Auth Info
<janrain:auth-infos> Auth Infos
<janrain:auth-native> Auth Native
<janrain:auth-native-traditional> Auth Native Traditional
<janrain:broadcast> Broadcast
<janrain:clear-whitelist> Clear Whitelist
<janrain:create-app> Create App
<janrain:create-invite> Create Invite
<janrain:delete-admin> Delete Admin
<janrain:delete-app> Delete App
<janrain:delete-client> Delete Client
<janrain:delete-default> Delete Default
<janrain:delete-settings> Delete Settings
<janrain:direct> Direct
<janrain:entity-adopt> Entity Adopt
<janrain:entity-bulk-create> Entity Bulk Create
<janrain:entity-bulk-delete> Entity Bulk Delete
<janrain:entity-count> Entity Count
<janrain:entity-create> Entity Create
<janrain:entity-delete> Entity Delete
<janrain:entity-find> Entity Find
<janrain:entity-purge> Entity Purge
<janrain:entity-replace> Entity Replace
<janrain:entity-update> Entity Update
<janrain:entity-versions> Entity Versions
<janrain:forgot-password-native> Forgot Password Native
<janrain:get-access-token> Get Access Token
<janrain:get-admins> Get Admins
<janrain:get-app-settings> Get App Settings
<janrain:get-authorization-code> Get Authorization Code
<janrain:get-available-providers> Get Available Providers
<janrain:get-backplane-properties> Get Backplane Properties
<janrain:get-contacts> Get Contacts
<janrain:get-creation-token> Get Creation Token
<janrain:get-default> Get Default
<janrain:get-domain-patterns> Get Domain Patterns
<janrain:get-entity-type> Get Entity Type
<janrain:get-items> Get Items
<janrain:get-keys> Get Keys
<janrain:get-multisettings> Get MultiSettings
<janrain:get-pending-invites> Get Pending Invites
<janrain:get-properties> Get Properties
<janrain:get-provider-permissions> Get Provider Permissions
<janrain:get-settings> Get Settings
<janrain:get-share-count> Get Share Count
<janrain:get-share-providers> Get Share Providers
<janrain:get-token> Get Token
<janrain:get-user-data> Get User Data
<janrain:get-verification-code> Get Verification Code
<janrain:link-account-native> Link Account Native
<janrain:list-clients> List Clients
<janrain:lookup-rp> Lookup Rp
<janrain:map> Map
<janrain:mappings> Mappings
<janrain:providers> Providers
<janrain:register-native> Register Native
<janrain:register-native-traditional> Register Native Traditional
<janrain:reset-api-key> Reset Api Key
<janrain:retrieve-entity> Retrieve Entity
<janrain:set-app-settings> Set App Settings
<janrain:set-auth-providers> Set Auth Providers
<janrain:set-backplane-properties> Set Backplane Properties
<janrain:set-default> Set Default
<janrain:set-description> Set Description
<janrain:set-domain-patterns> Set Domain Patterns
<janrain:set-features> Set Features
<janrain:set-multisettings> Set MultiSettings
<janrain:set-properties> Set Properties
<janrain:set-provider-permissions> Set Provider Permissions
<janrain:set-settings> Set Settings
<janrain:set-share-providers> Set Share Providers
<janrain:set-status> Set Status
<janrain:set-whitelist> Set Whitelist
<janrain:unmap> Unmap
<janrain:use-verification-code> Use Verification Code
<janrain:verify-domain> Verify Domain
<janrain:verify-email-native> Verify Email Native
<janrain:webhooks-add> Webhooks Add
<janrain:webhooks-delete> Webhooks Delete
<janrain:webhooks-find> Webhooks Find
<janrain:webhooks-list> Webhooks List
<janrain:webhooks-update> Webhooks Update

Configuration

To use the this module within a flow the namespace to the module must be included. The resulting flow will look similar to the following:

<mule xmlns="http://www.mulesoft.org/schema/mule/core"
      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
      xmlns:janrain="http://www.mulesoft.org/schema/mule/janrain"
      xsi:schemaLocation="
               http://www.mulesoft.org/schema/mule/core
               http://www.mulesoft.org/schema/mule/core/current/mule.xsd
               http://www.mulesoft.org/schema/mule/janrain
               http://www.mulesoft.org/schema/mule/janrain/current/mule-janrain.xsd">

      <!-- here goes your flows and configuration elements -->

</mule>

Connection Pool

This connector offers automatic connection management via the use of a connection pool. The pool will act a storage mechanism for all the connections that are in-use by the user of this connector.

Prior to execution of a processor, the connector will attempt to lookup an already established connection and if one doesn't exists it will create one. That lookup mechanism is done in the connection pool via the use of connection variables declared as keys.

The user of the connector can configure the pool by adding a connection-pooling-profile to the connector configuration like this:

    <janrain:connection-pooling-profile maxActive="10" maxIdle="10"
                             exhaustedAction="WHEN_EXHAUSTED_GROW" maxWait="120" minEvictionMillis="60000" evictionCheckIntervalMillis="30000"/>

The following is a list of connection attributes, each connection attribute can be configured at the config element level or they can also be added to each processor. If they are used at the processor level they get the benefit of full expression resolution.

Connection Attributes
Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
apiKey		The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Reconnection Strategies

Reconnection Strategies specify how a connector behaves when its connection fails. You can control how Mule attempts to reconnect by specifying a number of criteria:

The type of exception
Number and frequency of reconnection attempts
The notifications generated, and more

With a reconnection strategy, you can better control the behavior of a failed connection, by configuring it, for example, to re-attempt the connection only once every 15 minutes, and to give up after 30 attempts. You can also send an automatic notification to your IT administrator whenever this reconnection strategy goes into effect. You can even define a strategy that attempts to reconnect only during business hours. Such a setting can prove useful if your server is frequently shut down for nightly maintenance.

Configuration

A reconnection strategy that allows the user to configure how many times a reconnection should be attempted and how long to wait between attempts.

    <janrain:config>
         <reconnect count="5" frequency="1000"/>
    </janrain:config>

Reconnect Attributes
Name	Default Value	Description
frequency	2000	Optional. How often (in ms) to reconnect
count	2	Optional. How many reconnection attempts to make

For more information about reconnection strategies in Mule, or even how to write your own custom reconnection strategy please check this section.

Message Processors

<janrain:activity>

Activity

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
activity		The activity structure, JSON-encoded.	String	/	UTF-8
identifier		Optional. The identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.	String	/	UTF-8
deviceToken		Optional. The identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.	String	/	UTF-8
truncate	true	Optional. If true, truncate the activity update text when posting to providers which impose length restrictions (currently Twitter).	Boolean	/
prependName	true	Optional. If true, prepend the user’s name to the action when posting to Facebook (ignored for other providers).	Boolean	/
urlShortening		Optional. A boolean indicating whether to provide the entire URL in the post or tweet, or the shortened version. (PRO)	String	/	UTF-8
source		Optional. Must be domain or URL. Defines a specific domain or URL as the source page of the sharing activity. Used by analytics to categorize posts by domain.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:add-admin>

Add Admin

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
partnerKey		You Engage partner key, which you can find on the dashboard.	String	/	UTF-8
email		The email address of the admin user to be added.	String	/	UTF-8
verify	true	Optional. Indicates whether a verification email is sent out, requiring the user to click on it before they get access to the website.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:add-bp-bus>

Add Bp Bus

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	Enter your partnerKey.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Map<String, String>	The response includes the name of the new bus, and the name of the application with which it is associated.

<janrain:add-client>

Add Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
description	A string description of the client.	String	/	UTF-8
features	Optional. A JSON array of feature names that the client has; defaults to the empty list.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
ClientInfo	the created client

<janrain:add-domain>

Add Domain

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	Engage partner key, which you can find on the dashboard.	String	/	UTF-8
engageApiKey	Engage API Key, which you can find on the dashboard.	String	/	UTF-8
domain	The domain to add.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful.

<janrain:add-domain-patterns>

Add Domain Patterns

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
domains	A comma separated list of domains that will be used as a whitelist for the website.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:add-or-update-access-token>

Add Or Update Access Token

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
token	The access_token to grant to the user. These tokens need to be requested from the individual Identity Provider according to their particular API.	String	/	UTF-8
identifier	The identifier associated with the provider. This needs to to be formatted as a URL with profile number.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:all-mappings>

All Mappings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	all of the stored mappings of an application

<janrain:analytics-access>

Analytics Access

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
start	A date formatted as MM/DD/YYYY.	String	/	UTF-8
end	A date formatted as MM/DD/YYYY.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Map<String, String>	the analytic data from your application

<janrain:apps>

Apps

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	Enter your partnerKey.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Apps	List of applications managed by the partner.

<janrain:auth-info>

Auth Info

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
token	The token parameter received at your token_url.	String	/	UTF-8
extended	Optional. Returns the extended Simple Registration and HCard data in addition to the normalized Portable Contacts format. Ignored unless the application has a Pro or Enterprise service level.	Boolean	/
tokenURL	Optional. Validate the specified tokenURL value against the tokenURL that was originally sent.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
UserInfo	the auth info

<janrain:auth-infos>

Auth Infos

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
tokens		The tokens parameter received at your token callback URL as described in Token Callback URL on the Token Callback URL page.	String	/	UTF-8
extended	false	Optional. Returns the extended Simple Registration and HCard data in addition to the normalized Portable Contacts format.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
AuthInfos	data from more than one identity provider

<janrain:auth-native>

Auth Native

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
token	A token for rpx.	String	/	UTF-8
thin_registration	Optional. If true this endpoint will create nonexistent users. If it is false, you’ll need to do two-step registration using /oauth/register_native.	String	/	UTF-8
merge_token	Optional. If you have had a previous call to /oauth/auth_native fail with code 380 email_address_in_use, you can merge the two accounts by passing a merge_token parameter while authorizing as the existing user.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A standard, mobile, native authorization.

<janrain:auth-native-traditional>

Auth Native Traditional

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
email	The parameter name is the traditional-registration email address field name in your flow, so this varies from application to application.	String	/	UTF-8
password	The parameter name is the traditional-registration password field name in your flow, so this varies from application to application.	String	/	UTF-8
form	The name of the login form in your flow.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A standard, mobile, native authorization.

<janrain:broadcast>

Broadcast

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
identifier	Optional. The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.	String	/	UTF-8
deviceToken	Optional. The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.	String	/	UTF-8
title	Optional. The title given to the shared content.	String	/	UTF-8
url	Optional. The URL associated to the content being shared.	String	/	UTF-8
source	Optional. URL of the site sharing the activity.	String	/	UTF-8
message	Optional. Message associated with the activity being shared.	String	/	UTF-8
description	Optional. The description of the shared content. This appears in the preview of the shared object and describes what is being shared.	String	/	UTF-8
image	Optional. An image associated with the content being shared.	String	/	UTF-8
media	Optional. The Flash or video object associated with the content being shared.	String	/	UTF-8
actionLink	Optional. The link that appears below the user-generated message and content fields. In the case of Facebook, this link appears next to the Like and Comment links.	String	/	UTF-8
objectId	Optional. Facebook only. Use this parameter to share to a Facebook fan page instead of the User’s wall. The value is the Object ID assigned to the fan page.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Broadcast	The response includes a share element which returns fields that were actually passed to the provider. If the provider does not support a parameter, it will not be included in the result

<janrain:clear-whitelist>

Clear Whitelist

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	Optional. The client_id whose whitelist will be cleared.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:create-app>

Create App

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	Engage partner key, which you can find on the dashboard.	String	/	UTF-8
email	The administrative email address to be associated with your new Engage application.	String	/	UTF-8
displayName	The display name for your new Engage application.	String	/	UTF-8
domain	The fully-qualified domain for your new Engage application.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
AppInfo	This call creates a new Engage application.

<janrain:create-invite>

Create Invite

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	Engage API Key, which you can find on the dashboard.	String	/	UTF-8
partnerKey	Engage partner key, which you can find on the dashboard.	String	/	UTF-8
email	The administrative email address to be associated with your new Engage application.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	This call generates an email invitation for administrative access to an existing application.

<janrain:delete-admin>

Delete Admin

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	You Engage partner key, which you can find on the dashboard.	String	/	UTF-8
email	The email address of the admin user to be added.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:delete-app>

Delete App

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	The Engage apiKey for the application to be deleted.	String	/	UTF-8
partnerKey	The Engage partnerKey for the application that created the app referenced by apiKey.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful.

<janrain:delete-client>

Delete Client

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
client_id_for_deletion	The client_id to delete.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:delete-default>

Delete Default

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:delete-settings>

Delete Settings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:direct>

Direct

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
identifier	Optional. The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.	String	/	UTF-8
deviceToken	Optional. The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.	String	/	UTF-8
title	Optional. The title given to the shared content.	String	/	UTF-8
url	Optional. The URL associated to the content being shared.	String	/	UTF-8
recipients	A list of identifiers in JSON associated with the recipients being contacted.	String	/	UTF-8
source	Optional. URL of the site sharing the activity.	String	/	UTF-8
message	Optional. Message associated with the activity being shared.	String	/	UTF-8
description	Optional. The description of the shared content. This appears in the preview of the shared object and describes what is being shared.	String	/	UTF-8
image	Optional. An image associated with the content being shared.	String	/	UTF-8
media	Optional. The Flash or video object associated with the content being shared.	String	/	UTF-8
actionLink	Optional. The link that appears below the user-generated message and content fields. In the case of Facebook, this link appears next to the Like and Comment links.	String	/	UTF-8
recipientUrls	Optional. Allows for sharing multiple urls to multiple recipients. The value is a JSON object of recipients and shared urls.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Direct	The response includes a share element which returns fields that were actually passed to the provider. If the provider does not support a parameter, it will not be included in the result

<janrain:entity-adopt>

Entity Adopt

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Optional. The shared secret paired with the client_id.	String	/	UTF-8
client_id	Optional. The client identifier of the owner client.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
id	The identifier of the entity.	String	/	UTF-8
access_token	Optional. Required when authenticating with an OAuth access_token.	String	/	UTF-8
attribute_name	The value path to the plural that is to adopt the orphan.	String	/	UTF-8
child_id	The id of the orphaned plural element to be adopted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:entity-bulk-create>

Entity Bulk Create

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
all_attributes	The attribute names and values (as JSON) for the entity.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
BulkResponse	the bulk response

<janrain:entity-bulk-delete>

Entity Bulk Delete

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
filter	The expression used to filter the results.	String	/	UTF-8
commit	Optional. When the parameter is present, will not delete any records unless the value is true.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the count of the deleted entities

<janrain:entity-count>

Entity Count

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
filter	Optional. The expression to use to filter the results.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the entity count

<janrain:entity-create>

Entity Create

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	Optional. The entityType of the entity.	String	/	UTF-8
attributes	The attribute names and values (as JSON) for the entity.	String	/	UTF-8
include_record	Optional. When true, a result field is added to the response containing the data of the newly created entity record.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Map<String, String>	the entity created

<janrain:entity-delete>

Entity Delete

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Optional. Required when authenticating with client settings.	String	/	UTF-8
client_id	Optional. Required when authenticating with client settings.	String	/	UTF-8
access_token	Optional. Required when authenticating with an OAuth access_token.	String	/	UTF-8
uuid	Optional. Required when not using id or key_attribute paramaters.	String	/	UTF-8
id	Optional. Required when not using key_attribute or uuid parameters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
attribute_name	Optional. This is a schema path to an individual attribute.	String	/	UTF-8
created	Optional. Timestamps are generated when an entity is created.	String	/	UTF-8
last_updated	Optional. Timestamps are generated when an entity is updated.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:entity-find>

Entity Find

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Required when authenticating with client settings.	String	/	UTF-8
client_id	Required when authenticating with client settings.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
filter	Optional. The expression used to filter the results. The default is to match all records.	String	/	UTF-8
max_results	Optional. The maximum number of results to be returned.	String	/	UTF-8
first_result	Optional. Changes the first result displayed by the list to the next number specified.	String	/	UTF-8
show_total_count	Optional. This includes a total_count in the result that shows the total number of records that matched the filter.	Boolean	/
sort_on	Optional. A JSON array of attributes to sort by.	String	/	UTF-8
attributes	Optional. A JSON array of attributes to return in the result set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the results

<janrain:entity-purge>

Entity Purge

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
commit	When the parameter is present, will not delete any records unless the value is true.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the resulted state of the action

<janrain:entity-replace>

Entity Replace

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Optional. Required when authenticating with client settings.	String	/	UTF-8
client_id	Optional. Required when authenticating with client settings.	String	/	UTF-8
access_token	Optional. Required when authenticating with an OAuth access_token.	String	/	UTF-8
uuid	Optional. Required when not using id or key_attribute paramaters.	String	/	UTF-8
id	Optional. Required when not using key_attribute or uuid parameters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
value	The JSON value to assign by attribute_name.	String	/	UTF-8
attribute_name	Optional. This is a schema path to an individual attribute.	String	/	UTF-8
created	Optional. Timestamps are generated when an entity is created.	String	/	UTF-8
last_updated	Optional. Timestamps are generated when an entity is updated.	String	/	UTF-8
include_record	Optional. When true, a result field is added to the response, containing the data of the newly updated entity record.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:entity-update>

Entity Update

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Optional. Required when authenticating with client settings.	String	/	UTF-8
client_id	Optional. Required when authenticating with client settings.	String	/	UTF-8
access_token	Optional. Required when authenticating with an OAuth access_token.	String	/	UTF-8
uuid	Optional. Required when not using id or key_attribute paramaters.	String	/	UTF-8
id	Optional. Required when not using key_attribute or uuid parameters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
value	The JSON value to assign by attribute_name.	String	/	UTF-8
attribute_name	Optional. This is a schema path to an individual attribute.	String	/	UTF-8
created	Optional. Timestamps are generated when an entity is created.	String	/	UTF-8
last_updated	Optional. Timestamps are generated when an entity is updated.	String	/	UTF-8
include_record	Optional. When true, a result field is added to the response, containing the data of the newly updated entity record.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:entity-versions>

Entity Versions

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
type_name	The entityType of the entity.	String	/	UTF-8
id	The primary key of the parent object.	String	/	UTF-8
timestamp	The date and time to search for. Capture retrieves the value of the record as it existed at that timestamp.	String	/	UTF-8
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the versions

<janrain:forgot-password-native>

Forgot Password Native

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
form	The name of the form in your flow where you store the recover password logic..	String	/	UTF-8
email	The email address for which you want to recover the password.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the forgotten password

<janrain:get-access-token>

Get Access Token

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
uuid	Optional. Required when not using the id or key_attribute and key_value paramaters.	String	/	UTF-8
id	Optional. Required when not using the uuid or key_attribute and key_value paramaters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid parameters.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
client_id	The client identifier, which you can find on your dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The name of the entityType.	String	/	UTF-8
for_client_id	Optional. The client_id for which to retrieve an accessToken.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	Access Token

<janrain:get-admins>

Get Admins

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	You Engage partner key, which you can find on the dashboard.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Admins	This call returns all admin users currently assigned to the RP.

<janrain:get-app-settings>

Get App Settings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Map<String, String>	the app settings

<janrain:get-authorization-code>

Get Authorization Code

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
uuid	Optional. Required when not using the id or key_attribute and key_value paramaters.	String	/	UTF-8
id	Optional. Required when not using the uuid or key_attribute and key_value paramaters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid parameters.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
client_id	The client identifier, which you can find on your dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
redirect_uri	The redirect URI. This is the address used by CaptureUI to make the redirect.	String	/	UTF-8
type_name	The name of the entityType.	String	/	UTF-8
transaction_state	Optional. A JSON object that will be associated with the authorization code and returned when it is exchanged for an access_token and a refresh token.	String	/	UTF-8
lifetime	Optional. The number of seconds for which the code is valid. The default value is 30 seconds.	String	/	UTF-8
for_client_id	Optional. The client_id for which to retrieve an accessToken.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	Authorization Code

<janrain:get-available-providers>

Get Available Providers

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
AvailableProviders	a list of configured providers for an application

<janrain:get-backplane-properties>

Get Backplane Properties

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Backplane	the backplane properties.

<janrain:get-contacts>

Get Contacts

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
identifier	The identifier returned from the auth_info API call. The application must be configured to request this information in the Provider Configuration screen.	String	/	UTF-8
contactType	Optional. Specify friends to return identifiers for every friend of the user. If you do not specify a value, friends will be returned if available.	String	/	UTF-8
existingUser	Optional. If true returns a value that identifies if a user has previously authenticated with the Janrain application before.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Contacts	a list of all the contacts related to the user

<janrain:get-creation-token>

Get Creation Token

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier, which you can find on your dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The name of the entityType.	String	/	UTF-8
lifetime	The number of seconds for which the code is valid. The default value is 30 seconds.	String	/	UTF-8
for_client_id	The client_id for which to retrieve an accessToken.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	Creation Token

<janrain:get-default>

Get Default

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the default setting

<janrain:get-domain-patterns>

Get Domain Patterns

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
DomainPatterns	the domain patterns.

<janrain:get-entity-type>

Get Entity Type

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
type_name	The entityType of the entity.	String	/	UTF-8
timestamp	The date and time to search for. Capture retrieves the value of the record as it existed at that timestamp.	String	/	UTF-8
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the versions

<janrain:get-items>

Get Items

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the items

<janrain:get-keys>

Get Keys

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the keys

<janrain:get-multisettings>

Get MultiSettings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the settings

<janrain:get-pending-invites>

Get Pending Invites

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	Engage API key for the application for which to return pending invites.	String	/	UTF-8
partnerKey	The Engage partner key for the application that created the app referenced by the apiKey parameter.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Invites	the pending invites.

<janrain:get-properties>

Get Properties

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	The Engage partner key for the application that created the app referenced by the apiKey parameter.	String	/	UTF-8
engageApiKey	Engage API key for the application for which to return pending invites.	String	/	UTF-8
provider	The name of the provider whose properties you want to return.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Map<String, String>	the app properties.

<janrain:get-provider-permissions>

Get Provider Permissions

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
partnerKey	The Engage partner key for the application that created the app referenced by the apiKey parameter.	String	/	UTF-8
engageApiKey	Engage API key for the application for which to return pending invites.	String	/	UTF-8
provider	The name of the provider whose properties you want to return.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Permissions	the provider permission.

<janrain:get-settings>

Get Settings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the settings

<janrain:get-share-count>

Get Share Count

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
url	The URL that was shared.	String	/	UTF-8
callback	Optional. When a value is added, returns data in JSONP format.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	he number of a times a given URL has been shared.

<janrain:get-share-providers>

Get Share Providers

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
ShareProviders	a list of email and sharing providers configured for the widget.

<janrain:get-token>

Get Token

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
grant_type	The access grant type included in the request. Available values are authorization_code and refresh_token.	String	/	UTF-8
code	The authorization code received from the authorization server.	String	/	UTF-8
redirect_uri	The redirection URI used in the initial request. CaptureUI uses this address to implement the redirect.	String	/	UTF-8
refresh_token	Optional. The token for refreshing the	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A token

<janrain:get-user-data>

Get User Data

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
identifier	The identifier returned from the auth_info API call. The application must be configured to request this information in the Provider Configuration screen.	String	/	UTF-8
extended	Optional. Returns the extended Simple Registration and HCard data in addition to the normalized Portable Contacts format.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
UserInfo	up-to-date copy of a user’s profile

<janrain:get-verification-code>

Get Verification Code

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
uuid	Optional. Required when not using id or the key_attribute and key_value parameters.	String	/	UTF-8
id	Optional. The id number associated with the user record.	String	/	UTF-8
key_attribute	Optional. Required when not using the id or uuid parameters.	String	/	UTF-8
key_value	Optional. Required when using the key_attribute	String	/	UTF-8
client_id	The client identifier, which you can find on your dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
type_name	The name of the entityType.	String	/	UTF-8
attribute_name	The name of the attribute to update when using the verification code.	String	/	UTF-8
lifetime	The number of seconds for which the code is valid. The default value is 30 seconds.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	Verification Code

<janrain:link-account-native>

Link Account Native

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
token	The access token from a previous call to /oauth/auth_native or oauth/auth_native_traditional.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A linked account

<janrain:list-clients>

List Clients

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
has_features	Optional. A JSON array features names; only clients which have at least one of the features in the array will be displayed.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
ClientListInfo	the clients

<janrain:lookup-rp>

Lookup Rp

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
pluginName	Optional. The name of your plugin.	String	/	UTF-8
pluginVersion	Optional. The version number of your plugin.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Plugin	the plugin response.

<janrain:map>

Map

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
identifier	The identifier returned from the auth_info API call.	String	/	UTF-8
primaryKey	The primary key from your users table, as a string.	String	/	UTF-8
overwrite	Optional. If false, only create the mapping if one does not already exist for the specified identifier.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:mappings>

Mappings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
primaryKey	The primary key from your users table, as a string.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
Identifiers	all the stored Identity Providers associated with a particular user’s primary key

<janrain:providers>

Providers

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
WidgetProviders	configured sign-in or social providers configured for a widget

<janrain:register-native>

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
token	The access token from a previous call to /oauth/auth_native or oauth/auth_native_traditional.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A linked account

<janrain:register-native-traditional>

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
password	The password of the person who is registering. Note: The actual name of this parameter is defined by your flow file. password is the default, but you might choose to change it.	String	/	UTF-8
password_confirm	The confirmation for the user’s password and must match the password parameter.	String	/	UTF-8
email	The email address you want to verify.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A linked account

<janrain:reset-api-key>

Reset Api Key

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
rpAppId	The application identifier of the RP application for which you want to reset the API key.	String	/	UTF-8
partnerKey	The Engage partner key for the application that created the app referenced by the apiKey parameter.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the new api key.

<janrain:retrieve-entity>

Retrieve Entity

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_secret	Optional. Required when authenticating with client settings.	String	/	UTF-8
client_id	Optional. Required when authenticating with client settings.	String	/	UTF-8
access_token	Optional. Required when authenticating with an OAuth access_token.	String	/	UTF-8
uuid	Optional. Required when not using id or key_attribute paramaters.	String	/	UTF-8
id	Optional. Required when not using key_attribute or uuid parameters.	String	/	UTF-8
key_attribute	Optional. Required when not using id or uuid.	String	/	UTF-8
key_value	Optional. Required when using key_attribute.	String	/	UTF-8
password_attribute	Optional. Entity can be used to validate user passwords.	String	/	UTF-8
password_value	Optional. A plaintext value that will be matched against the password attribute specified in the password_attribute parameter.	String	/	UTF-8
type_name	The entityType of the entity.	String	/	UTF-8
attribute_name	Optional. This is a schema path to an individual attribute.	String	/	UTF-8
attributes	Optional. This is a JSON array of attributes.	String	/	UTF-8
created	Optional. Timestamps are generated when an entity is created.	String	/	UTF-8
last_updated	Optional. Timestamps are generated when an entity is updated.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	Retrieve an entity of entityType user by id.

<janrain:set-app-settings>

Set App Settings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
privacyPolicy	Optional. Full URL to the location of your privacy policy.	String	/	UTF-8
favicon	Optional. URL of your favicon.	String	/	UTF-8
domainRedirect	Optional. The URL for the redirect.	String	/	UTF-8
postToTokenUrl	Optional. A boolean, true or false.	Boolean	/
oneTimeUseTokens	Optional. A boolean, true or false.	Boolean	/
googleProfileUrl	Optional. A boolean, true or false.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-auth-providers>

Set Auth Providers

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
providers	A comma separated string of provider specifiers.	String	/	UTF-8
deviceType	Optional. Web, iphone, android.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-backplane-properties>

Set Backplane Properties

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
server		The Backplane server’s domain name, such as, example.com.	String	/	UTF-8
bus		The Backplane bus name.	String	/	UTF-8
version	v1	Optional. The Backplane server version, for example, v1.1. The default value is v1.	String	/	UTF-8
remove		Optional. False is the default. If false, add a new Backplane configuration; otherwise, remove the Backplane configuration for the specified server or bus.	Boolean	/
username		Only required when you do not use remove. The user name for the Backplane credential.	String	/	UTF-8
password		Only required when you do not use remove. The user name for the Backplane credential.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-default>

Set Default

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
value	The value to assign to the key.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-description>

Set Description

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	Optional. The client id of the client having it’s description changed.	String	/	UTF-8
description	The new description for the target client.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-domain-patterns>

Set Domain Patterns

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
domains	A comma separated list of domains used as a whitelist for the website.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-features>

Set Features

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	Optional. The client id of the client having it’s description changed.	String	/	UTF-8
features	A JSON array of feature names to assign to the client.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-multisettings>

Set MultiSettings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
items	A JSON object containing the key-value pairs to set for the client identifier.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the settings

<janrain:set-properties>

Set Properties

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	The Engage API Key of the application to configure.	String	/	UTF-8
partnerKey	Your Engage partner key, which you can find on the dashboard.	String	/	UTF-8
provider	The name of the provider to configure.	String	/	UTF-8
fbAppID	Optional. Facebook only: The Application Id for the user’s Facebook application.	String	/	UTF-8
fbSecret	Optional. Facebook Only: The Application Secret for the user’s Facebook application.	String	/	UTF-8
emailPerm	Optional. Facebook only: Set to true if this application needs email to receive end-user email addresses.	Boolean	/
uninstallURL	Optional. Facebook only: This is the URL that is invoked when the user uninstalls the Facebook application.	String	/	UTF-8
consumerKey	This is the Consumer Key for the user’s application.	String	/	UTF-8
secret	The consumer secret the user’s application.	String	/	UTF-8
paypalDisplayName	Optional. PayPal only: The display name for the user’s Paypal application.	String	/	UTF-8
email	Optional. PayPal only: enter a valid email address that is already registered with a PayPal account.	String	/	UTF-8
liveidAppID	Optional. Windows Live only: The Application ID for the user’s Windows Live application.	String	/	UTF-8
liveidSecret	Optional. Windows Live only: The Secret Key for the user’s Windows Live application.	String	/	UTF-8
liveidPrivacyPolicyUrl	Optional. Windows Live only: The URL for the Windows Live application’s privacy policy.	String	/	UTF-8
yahooAppID	Optional. Yahoo only: The Application ID for the user’s Yahoo application.	String	/	UTF-8
activityScopesSet	Optional. Yahoo only: Set to true if the user’s Yahoo application has read and write permissions for “Status” and “Updates.”	Boolean	/
contactsScopeSet	Optional. Yahoo only: Set to true if the user’s Yahoo application has read permission for “Contacts.”	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful.

<janrain:set-provider-permissions>

Set Provider Permissions

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	The Engage API Key of the application to configure.	String	/	UTF-8
partnerKey	Your Engage partner key, which you can find on the dashboard.	String	/	UTF-8
provider	The name of the provider to configure.	String	/	UTF-8
permissions	A comma-separated list of permissions to set.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful.

<janrain:set-settings>

Set Settings

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
key	The key to delete from the client settings.	String	/	UTF-8
value	The value to assign to the key.	String	/	UTF-8
for_client_id	The client identifier whose key will be deleted.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the settings

<janrain:set-share-providers>

Set Share Providers

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
share	Sharing providers to add to the widget. This may be left empty, in which case the widget will have no sharing providers.	String	/	UTF-8
email	Optional. Email providers to add to the widget. You can leave this empty, in which case the widget will have no email providers.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-status>

Set Status

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
identifier		The identifier returned from the auth_info API call.	String	/	UTF-8
status		The status message to set. Engage does not set a length restriction on this message, however Twitter and LinkedIn limit status length to 140 characters.	String	/	UTF-8
location		Optional. This is a string containing location data associated with the content being published.	String	/	UTF-8
truncate	true	Optional. If true, truncate status when posting to providers that impose status length restrictions (currently Twitter, Yahoo, and LinkedIn).	Boolean	/
source		Optional. Must be domain or URL. Defines a specific domain or URL as the source page of the sharing activity. Used by analytics to categorize posts by domain.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:set-whitelist>

Set Whitelist

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the owner client.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
for_client_id	Optional. The client id of the client having it’s description changed.	String	/	UTF-8
whitelist	A JSON array of CIDR addresses that make up the new whitelist for the client, each one in the x.x.x.x/x format.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:unmap>

Unmap

XML Sample

INCLUDE_ERROR

Attributes

Name	Default Value	Description	Java Type	MIME Type	Encoding
config-ref		Optional. Specify which configuration to use.
identifier		The identifier currently mapped to the primaryKey.	String	/	UTF-8
allIdentifiers	false	Optional. False is the default. If true, all identifiers mapped to the primaryKey are removed.	Boolean	/
primaryKey		The primary key from your users table, as a string.	String	/	UTF-8
unlink		False is the default. If true, unlinks your application from the user’s account with the provider.	Boolean	/
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey		Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName		Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId		Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost		Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:use-verification-code>

Use Verification Code

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
verification_code	The verification code obtained in a previous call to access/getVerificationCode.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful

<janrain:verify-domain>

Verify Domain

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
engageApiKey	The Engage API Key of the application to configure.	String	/	UTF-8
partnerKey	Your Engage partner key, which you can find on the dashboard.	String	/	UTF-8
provider	The name of the provider to configure.	String	/	UTF-8
code	Optional. This is the Google-supplied META tag value that will be created on the domain.	String	/	UTF-8
filename	Optional. This is the Yahoo-supplied filename that will be created on the domain.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
boolean	true if the operation is successful.

<janrain:verify-email-native>

Verify Email Native

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier for your application.	String	/	UTF-8
locale	The user’s flow locale for your application.	String	/	UTF-8
response_type	You must enter one of code, token, or code_and_token.	String	/	UTF-8
redirect_uri	The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.	String	/	UTF-8
form	The name of the form in your flow where you store the verify email logic.	String	/	UTF-8
email	The email address you want to verify.	String	/	UTF-8
flow_name	Optional. The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.	String	/	UTF-8
flow_version	Optional. The version number of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_version.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	A linked account

<janrain:webhooks-add>

Webhooks Add

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the target Capture application, available in the dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
attributes	Optional. This is only applicable when event_type is update.	String	/	UTF-8
callback	The URL address where the webhook message is to be delivered and processed.	String	/	UTF-8
event_type	The type of change that triggers the webhook.	String	/	UTF-8
entity_type	The schema where the attribute is defined. Most of the time, this will be the default schema user.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the created webhook

<janrain:webhooks-delete>

Webhooks Delete

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the target Capture application, available in the dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
uuid	This is the uuid of the webhook.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the deleted webhook

<janrain:webhooks-find>

Webhooks Find

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the target Capture application, available in the dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
uuid	This is the uuid of the webhook.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the found webhook

<janrain:webhooks-list>

Webhooks List

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the target Capture application, available in the dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the list of webhooks

<janrain:webhooks-update>

Webhooks Update

XML Sample

INCLUDE_ERROR

Attributes

Name	Description	Java Type	MIME Type	Encoding
config-ref	Optional. Specify which configuration to use.
client_id	The client identifier of the target Capture application, available in the dashboard.	String	/	UTF-8
client_secret	The shared secret paired with the client_id.	String	/	UTF-8
callback	Optional. The URL address where the webhook message is to be delivered and processed.	String	/	UTF-8
event_type	Optional. The type of change that triggers the webhook.	String	/	UTF-8
entity_type	Optional. The schema where the attribute is defined. Most of the time, this will be the default schema user.	String	/	UTF-8
attributes	Optional. This is applicable only when event_type is update.	String	/	UTF-8
uuid	This is the uuid of the webhook.	String	/	UTF-8
Connection Parameters This are only required if you didn't specified them at the configuration element. They are also useful for overriding the values of the configurations or even if you need to extract them from the Mule message since they support expression evaluation.
apiKey	Optional. The "API key (secret)" provided in the "Application Info"	String	/	UTF-8
appName	Optional. The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/	String	/	UTF-8
appId	Optional. The "App ID" provided in the "Application Info"	String	/	UTF-8
captureHost	Optional. The host that you will using for your capture API. It might be the same as "Application Domain" or you can personalize this one	String	/	UTF-8

Returns

Return Type	Description
String	the updated webhook