public class

JanrainConnector

extends Object
java.lang.Object
   ↳ org.mule.modules.janrain.JanrainConnector
Known Direct Subclasses
Known Indirect Subclasses

Class Overview

Janrain Cloud Connector for API V2.

Summary

Fields
private String apiKey The Api Key
private String appId The App ID
private String appName The App Name
private String captureHost The capture host
private Gson gson Gson Parser
private JanrainCaptureClient janrainCaptureClient Janrain Capture Client
private JanrainEngageClient janrainEngageClient Janrain Engage Client
private JanrainPartnerClient janrainPartnerClient Janrain Partner Client
private Client jerseyClient Jersey Client
Public Constructors
JanrainConnector()
Public Methods
boolean activity(String activity, String identifier, String deviceToken, Boolean truncate, Boolean prependName, String urlShortening, String source)
Activity
boolean addAdmin(String partnerKey, String email, Boolean verify)
Add Admin
Map<String, String> addBpBus(String partnerKey)
Add Bp Bus
ClientInfo addClient(String client_id, String client_secret, String description, String features)
Add Client
boolean addDomain(String partnerKey, String engageApiKey, String domain)
Add Domain
boolean addDomainPatterns(String domains)
Add Domain Patterns
boolean addOrUpdateAccessToken(String token, String identifier)
Add Or Update Access Token
String allMappings()
All Mappings
Map<String, String> analyticsAccess(String start, String end)
Analytics Access
Apps apps(String partnerKey)
Apps
UserInfo authInfo(String token, Boolean extended, String tokenURL)
Auth Info
AuthInfos authInfos(String tokens, Boolean extended)
Auth Infos
String authNative(String client_id, String locale, String response_type, String redirect_uri, String token, String thin_registration, String merge_token, String flow_name, String flow_version)
Auth Native
String authNativeTraditional(String client_id, String locale, String response_type, String redirect_uri, String email, String password, String form, String flow_name, String flow_version)
Auth Native Traditional
Broadcast broadcast(String identifier, String deviceToken, String title, String url, String source, String message, String description, String image, String media, String actionLink, String objectId)
Broadcast
boolean clearWhitelist(String client_id, String client_secret, String for_client_id)
Clear Whitelist
void connect(String apiKey, String appName, String appId, String captureHost)
Connect
String connectionId()
Connection Id
AppInfo createApp(String partnerKey, String email, String displayName, String domain)
Create App
String createInvite(String engageApiKey, String partnerKey, String email)
Create Invite
boolean deleteAdmin(String partnerKey, String email)
Delete Admin
boolean deleteApp(String engageApiKey, String partnerKey)
Delete App
boolean deleteClient(String client_id, String client_secret, String client_id_for_deletion)
Delete Client
boolean deleteDefault(String client_id, String client_secret, String key)
Delete Default
boolean deleteSettings(String client_id, String client_secret, String key, String for_client_id)
Delete Settings
Direct direct(String identifier, String deviceToken, String title, String url, String recipients, String source, String message, String description, String image, String media, String actionLink, String recipientUrls)
Direct
void disconnect()
Disconnect
boolean entityAdopt(String client_secret, String client_id, String type_name, String id, String access_token, String attribute_name, String child_id)
Entity Adopt
BulkResponse entityBulkCreate(String client_id, String client_secret, String type_name, String all_attributes)
Entity Bulk Create
String entityBulkDelete(String client_id, String client_secret, String type_name, String filter, Boolean commit)
Entity Bulk Delete
String entityCount(String client_id, String client_secret, String type_name, String filter)
Entity Count
Map<String, String> entityCreate(String client_id, String client_secret, String type_name, String attributes, Boolean include_record)
Entity Create
boolean entityDelete(String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String attribute_name, String created, String last_updated)
Entity Delete
String entityFind(String client_secret, String client_id, String type_name, String filter, String max_results, String first_result, Boolean show_total_count, String sort_on, String attributes)
Entity Find
String entityPurge(String client_id, String client_secret, String type_name, Boolean commit)
Entity Purge
boolean entityReplace(String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String value, String attribute_name, String created, String last_updated, Boolean include_record)
Entity Replace
boolean entityUpdate(String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String value, String attribute_name, String created, String last_updated, Boolean include_record)
Entity Update
String entityVersions(String type_name, String id, String timestamp, String client_id, String client_secret)
Entity Versions
String forgotPasswordNative(String client_id, String locale, String response_type, String redirect_uri, String form, String email, String flow_name, String flow_version)
Forgot Password Native
String getAccessToken(String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String type_name, String for_client_id)
Get Access Token
Admins getAdmins(String partnerKey)
Get Admins
String getApiKey()
String getAppId()
String getAppName()
Map<String, String> getAppSettings()
Get App Settings
String getAuthorizationCode(String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String redirect_uri, String type_name, String transaction_state, String lifetime, String for_client_id)
Get Authorization Code
AvailableProviders getAvailableProviders()
Get Available Providers
Backplane getBackplaneProperties()
Get Backplane Properties
String getCaptureHost()
Contacts getContacts(String identifier, String contactType, Boolean existingUser)
Get Contacts
String getCreationToken(String client_id, String client_secret, String type_name, String lifetime, String for_client_id)
Get Creation Token
String getDefault(String client_id, String client_secret, String key)
Get Default
DomainPatterns getDomainPatterns()
Get Domain Patterns
String getEntityType(String type_name, String timestamp, String client_id, String client_secret)
Get Entity Type
String getItems(String client_id, String client_secret, String for_client_id)
Get Items
JanrainCaptureClient getJanrainCaptureClient()
JanrainEngageClient getJanrainEngageClient()
JanrainPartnerClient getJanrainPartnerClient()
Client getJerseyClient()
String getKeys(String client_id, String client_secret, String for_client_id)
Get Keys
String getMultisettings(String client_id, String client_secret, String key, String for_client_id)
Get MultiSettings
Invites getPendingInvites(String engageApiKey, String partnerKey)
Get Pending Invites
Map<String, String> getProperties(String partnerKey, String engageApiKey, String provider)
Get Properties
Permissions getProviderPermissions(String partnerKey, String engageApiKey, String provider)
Get Provider Permissions
String getSettings(String client_id, String client_secret, String key, String for_client_id)
Get Settings
String getShareCount(String url, String callback)
Get Share Count
ShareProviders getShareProviders()
Get Share Providers
String getToken(String client_id, String client_secret, String grant_type, String code, String redirect_uri, String refresh_token)
Get Token
UserInfo getUserData(String identifier, Boolean extended)
Get User Data
String getVerificationCode(String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String type_name, String attribute_name, String lifetime)
Get Verification Code
boolean isConnected()
Are we connected
String linkAccountNative(String client_id, String locale, String response_type, String redirect_uri, String token, String flow_name, String flow_version)
Link Account Native
ClientListInfo listClients(String client_id, String client_secret, String has_features)
List Clients
Plugin lookupRp(String pluginName, String pluginVersion)
Lookup Rp
boolean map(String identifier, String primaryKey, Boolean overwrite)
Map
Identifiers mappings(String primaryKey)
Mappings
WidgetProviders providers()
Providers
String registerNative(String client_id, String locale, String response_type, String redirect_uri, String token, String flow_name, String flow_version)
Register Native
String registerNativeTraditional(String client_id, String locale, String response_type, String redirect_uri, String password, String password_confirm, String email, String flow_name, String flow_version)
Register Native Traditional
String resetApiKey(String rpAppId, String partnerKey)
Reset Api Key
String retrieveEntity(String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String password_attribute, String password_value, String type_name, String attribute_name, String attributes, String created, String last_updated)
Retrieve Entity
void setApiKey(String apiKey)
void setAppId(String appId)
void setAppName(String appName)
boolean setAppSettings(String privacyPolicy, String favicon, String domainRedirect, Boolean postToTokenUrl, Boolean oneTimeUseTokens, Boolean googleProfileUrl)
Set App Settings
boolean setAuthProviders(String providers, String deviceType)
Set Auth Providers
boolean setBackplaneProperties(String server, String bus, String version, Boolean remove, String username, String password)
Set Backplane Properties
void setCaptureHost(String captureHost)
boolean setDefault(String client_id, String client_secret, String key, String value)
Set Default
boolean setDescription(String client_id, String client_secret, String for_client_id, String description)
Set Description
boolean setDomainPatterns(String domains)
Set Domain Patterns
boolean setFeatures(String client_id, String client_secret, String for_client_id, String features)
Set Features
void setJerseyClient(Client jerseyClient)
String setMultisettings(String client_id, String client_secret, String items, String for_client_id)
Set MultiSettings
boolean setProperties(String engageApiKey, String partnerKey, String provider, String fbAppID, String fbSecret, Boolean emailPerm, String uninstallURL, String consumerKey, String secret, String paypalDisplayName, String email, String liveidAppID, String liveidSecret, String liveidPrivacyPolicyUrl, String yahooAppID, Boolean activityScopesSet, Boolean contactsScopeSet)
Set Properties
boolean setProviderPermissions(String engageApiKey, String partnerKey, String provider, String permissions)
Set Provider Permissions
String setSettings(String client_id, String client_secret, String key, String value, String for_client_id)
Set Settings
boolean setShareProviders(String share, String email)
Set Share Providers
boolean setStatus(String identifier, String status, String location, Boolean truncate, String source)
Set Status
boolean setWhitelist(String client_id, String client_secret, String for_client_id, String whitelist)
Set Whitelist
boolean unmap(String identifier, Boolean allIdentifiers, String primaryKey, Boolean unlink)
Unmap
boolean useVerificationCode(String verification_code)
Use Verification Code
boolean verifyDomain(String engageApiKey, String partnerKey, String provider, String code, String filename)
Verify Domain
String verifyEmailNative(String client_id, String locale, String response_type, String redirect_uri, String form, String email, String flow_name, String flow_version)
Verify Email Native
String webhooksAdd(String client_id, String client_secret, String attributes, String callback, String event_type, String entity_type)
Webhooks Add
String webhooksDelete(String client_id, String client_secret, String uuid)
Webhooks Delete
String webhooksFind(String client_id, String client_secret, String uuid)
Webhooks Find
String webhooksList(String client_id, String client_secret)
Webhooks List
String webhooksUpdate(String client_id, String client_secret, String callback, String event_type, String entity_type, String attributes, String uuid)
Webhooks Update
[Expand]
Inherited Methods
From class java.lang.Object

Fields

private String apiKey

The Api Key

private String appId

The App ID

private String appName

The App Name

private String captureHost

The capture host

private Gson gson

Gson Parser

private JanrainCaptureClient janrainCaptureClient

Janrain Capture Client

private JanrainEngageClient janrainEngageClient

Janrain Engage Client

private JanrainPartnerClient janrainPartnerClient

Janrain Partner Client

private Client jerseyClient

Jersey Client

Public Constructors

public JanrainConnector ()

Public Methods

public boolean activity (String activity, String identifier, String deviceToken, Boolean truncate, Boolean prependName, String urlShortening, String source)

Activity

Parameters
activity The activity structure, JSON-encoded.
identifier The identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
deviceToken The identifier URL or device_token of the user sharing an activity. Do not use the device_token with mobile browsers.
truncate If true, truncate the activity update text when posting to providers which impose length restrictions (currently Twitter).
prependName If true, prepend the user’s name to the action when posting to Facebook (ignored for other providers).
urlShortening A boolean indicating whether to provide the entire URL in the post or tweet, or the shortened version. (PRO)
source 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.
Returns
  • true if the operation is successful

public boolean addAdmin (String partnerKey, String email, Boolean verify)

Add Admin

Parameters
partnerKey You Engage partner key, which you can find on the dashboard.
email The email address of the admin user to be added.
verify Indicates whether a verification email is sent out, requiring the user to click on it before they get access to the website.
Returns
  • true if the operation is successful

public Map<String, String> addBpBus (String partnerKey)

Add Bp Bus

Parameters
partnerKey Enter your partnerKey.
Returns
  • The response includes the name of the new bus, and the name of the application with which it is associated.

public ClientInfo addClient (String client_id, String client_secret, String description, String features)

Add Client

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
description A string description of the client.
features A JSON array of feature names that the client has; defaults to the empty list.
Returns
  • the created client

public boolean addDomain (String partnerKey, String engageApiKey, String domain)

Add Domain

Parameters
partnerKey Engage partner key, which you can find on the dashboard.
engageApiKey Engage API Key, which you can find on the dashboard.
domain The domain to add.
Returns
  • true if the operation is successful.

public boolean addDomainPatterns (String domains)

Add Domain Patterns

Parameters
domains A comma separated list of domains that will be used as a whitelist for the website.
Returns
  • true if the operation is successful

public boolean addOrUpdateAccessToken (String token, String identifier)

Add Or Update Access Token

Parameters
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.
identifier The identifier associated with the provider. This needs to to be formatted as a URL with profile number.
Returns
  • true if the operation is successful

public String allMappings ()

All Mappings

Returns
  • all of the stored mappings of an application

public Map<String, String> analyticsAccess (String start, String end)

Analytics Access

Parameters
start A date formatted as MM/DD/YYYY.
end A date formatted as MM/DD/YYYY.
Returns
  • the analytic data from your application

public Apps apps (String partnerKey)

Apps

Parameters
partnerKey Enter your partnerKey.
Returns
  • List of applications managed by the partner.

public UserInfo authInfo (String token, Boolean extended, String tokenURL)

Auth Info

Parameters
token The token parameter received at your token_url.
extended 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.
tokenURL Validate the specified tokenURL value against the tokenURL that was originally sent.
Returns
  • the auth info

public AuthInfos authInfos (String tokens, Boolean extended)

Auth Infos

Parameters
tokens The tokens parameter received at your token callback URL as described in Token Callback URL on the Token Callback URL page.
extended Returns the extended Simple Registration and HCard data in addition to the normalized Portable Contacts format.
Returns
  • data from more than one identity provider

public String authNative (String client_id, String locale, String response_type, String redirect_uri, String token, String thin_registration, String merge_token, String flow_name, String flow_version)

Auth Native

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
token A token for rpx.
thin_registration If true this endpoint will create nonexistent users. If it is false, you’ll need to do two-step registration using /oauth/register_native.
merge_token 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.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A standard, mobile, native authorization.

public String authNativeTraditional (String client_id, String locale, String response_type, String redirect_uri, String email, String password, String form, String flow_name, String flow_version)

Auth Native Traditional

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
email The parameter name is the traditional-registration email address field name in your flow, so this varies from application to application.
password The parameter name is the traditional-registration password field name in your flow, so this varies from application to application.
form The name of the login form in your flow.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A standard, mobile, native authorization.

public Broadcast broadcast (String identifier, String deviceToken, String title, String url, String source, String message, String description, String image, String media, String actionLink, String objectId)

Broadcast

Parameters
identifier The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.
deviceToken The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.
title The title given to the shared content.
url The URL associated to the content being shared.
source URL of the site sharing the activity.
message Message associated with the activity being shared.
description The description of the shared content. This appears in the preview of the shared object and describes what is being shared.
image An image associated with the content being shared.
media The Flash or video object associated with the content being shared.
actionLink 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.
objectId 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.
Returns
  • 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

public boolean clearWhitelist (String client_id, String client_secret, String for_client_id)

Clear Whitelist

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
for_client_id The client_id whose whitelist will be cleared.
Returns
  • true if the operation is successful

public void connect (String apiKey, String appName, String appId, String captureHost)

Connect

Parameters
apiKey The "API key (secret)" provided in the "Application Info"
appName The name of your application. In "Application Domain" -> https://[appName].rpxnow.com/
appId The "App ID" provided in the "Application Info"
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
Throws
ConnectionException

public String connectionId ()

Connection Id

public AppInfo createApp (String partnerKey, String email, String displayName, String domain)

Create App

Parameters
partnerKey Engage partner key, which you can find on the dashboard.
email The administrative email address to be associated with your new Engage application.
displayName The display name for your new Engage application.
domain The fully-qualified domain for your new Engage application.
Returns
  • This call creates a new Engage application.

public String createInvite (String engageApiKey, String partnerKey, String email)

Create Invite

Parameters
engageApiKey Engage API Key, which you can find on the dashboard.
partnerKey Engage partner key, which you can find on the dashboard.
email The administrative email address to be associated with your new Engage application.
Returns
  • This call generates an email invitation for administrative access to an existing application.

public boolean deleteAdmin (String partnerKey, String email)

Delete Admin

Parameters
partnerKey You Engage partner key, which you can find on the dashboard.
email The email address of the admin user to be added.
Returns
  • true if the operation is successful

public boolean deleteApp (String engageApiKey, String partnerKey)

Delete App

Parameters
engageApiKey The Engage apiKey for the application to be deleted.
partnerKey The Engage partnerKey for the application that created the app referenced by apiKey.
Returns
  • true if the operation is successful.

public boolean deleteClient (String client_id, String client_secret, String client_id_for_deletion)

Delete Client

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
client_id_for_deletion The client_id to delete.
Returns
  • true if the operation is successful

public boolean deleteDefault (String client_id, String client_secret, String key)

Delete Default

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
Returns
  • true if the operation is successful

public boolean deleteSettings (String client_id, String client_secret, String key, String for_client_id)

Delete Settings

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
for_client_id The client identifier whose key will be deleted.
Returns
  • true if the operation is successful

public Direct direct (String identifier, String deviceToken, String title, String url, String recipients, String source, String message, String description, String image, String media, String actionLink, String recipientUrls)

Direct

Parameters
identifier The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.
deviceToken The identifier URL or deviceToken of the user sharing an activity. Do not use the deviceToken with mobile browsers.
title The title given to the shared content.
url The URL associated to the content being shared.
recipients A list of identifiers in JSON associated with the recipients being contacted.
source URL of the site sharing the activity.
message Message associated with the activity being shared.
description The description of the shared content. This appears in the preview of the shared object and describes what is being shared.
image An image associated with the content being shared.
media The Flash or video object associated with the content being shared.
actionLink 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.
recipientUrls Allows for sharing multiple urls to multiple recipients. The value is a JSON object of recipients and shared urls.
Returns
  • 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

public void disconnect ()

Disconnect

public boolean entityAdopt (String client_secret, String client_id, String type_name, String id, String access_token, String attribute_name, String child_id)

Entity Adopt

Parameters
client_secret The shared secret paired with the client_id.
client_id The client identifier of the owner client.
type_name The entityType of the entity.
id The identifier of the entity.
access_token Required when authenticating with an OAuth access_token.
attribute_name The value path to the plural that is to adopt the orphan.
child_id The id of the orphaned plural element to be adopted.
Returns
  • true if the operation is successful

public BulkResponse entityBulkCreate (String client_id, String client_secret, String type_name, String all_attributes)

Entity Bulk Create

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
type_name The entityType of the entity.
all_attributes The attribute names and values (as JSON) for the entity.
Returns
  • the bulk response

public String entityBulkDelete (String client_id, String client_secret, String type_name, String filter, Boolean commit)

Entity Bulk Delete

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
type_name The entityType of the entity.
filter The expression used to filter the results.
commit When the parameter is present, will not delete any records unless the value is true.
Returns
  • the count of the deleted entities

public String entityCount (String client_id, String client_secret, String type_name, String filter)

Entity Count

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
type_name The entityType of the entity.
filter The expression to use to filter the results.
Returns
  • the entity count

public Map<String, String> entityCreate (String client_id, String client_secret, String type_name, String attributes, Boolean include_record)

Entity Create

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
type_name The entityType of the entity.
attributes The attribute names and values (as JSON) for the entity.
include_record When true, a result field is added to the response containing the data of the newly created entity record.
Returns
  • the entity created

public boolean entityDelete (String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String attribute_name, String created, String last_updated)

Entity Delete

Parameters
client_secret Required when authenticating with client settings.
client_id Required when authenticating with client settings.
access_token Required when authenticating with an OAuth access_token.
uuid Required when not using id or key_attribute paramaters.
id Required when not using key_attribute or uuid parameters.
key_attribute Required when not using id or uuid.
key_value Required when using key_attribute.
type_name The entityType of the entity.
attribute_name This is a schema path to an individual attribute.
created Timestamps are generated when an entity is created.
last_updated Timestamps are generated when an entity is updated.
Returns
  • true if the operation is successful

public String entityFind (String client_secret, String client_id, String type_name, String filter, String max_results, String first_result, Boolean show_total_count, String sort_on, String attributes)

Entity Find

Parameters
client_secret Required when authenticating with client settings.
client_id Required when authenticating with client settings.
type_name The entityType of the entity.
filter The expression used to filter the results. The default is to match all records.
max_results The maximum number of results to be returned.
first_result Changes the first result displayed by the list to the next number specified.
show_total_count This includes a total_count in the result that shows the total number of records that matched the filter.
sort_on A JSON array of attributes to sort by.
attributes A JSON array of attributes to return in the result set.
Returns
  • the results

public String entityPurge (String client_id, String client_secret, String type_name, Boolean commit)

Entity Purge

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
type_name The entityType of the entity.
commit When the parameter is present, will not delete any records unless the value is true.
Returns
  • the resulted state of the action

public boolean entityReplace (String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String value, String attribute_name, String created, String last_updated, Boolean include_record)

Entity Replace

Parameters
client_secret Required when authenticating with client settings.
client_id Required when authenticating with client settings.
access_token Required when authenticating with an OAuth access_token.
uuid Required when not using id or key_attribute paramaters.
id Required when not using key_attribute or uuid parameters.
key_attribute Required when not using id or uuid.
key_value Required when using key_attribute.
type_name The entityType of the entity.
value The JSON value to assign by attribute_name.
attribute_name This is a schema path to an individual attribute.
created Timestamps are generated when an entity is created.
last_updated Timestamps are generated when an entity is updated.
include_record When true, a result field is added to the response, containing the data of the newly updated entity record.
Returns
  • true if the operation is successful

public boolean entityUpdate (String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String type_name, String value, String attribute_name, String created, String last_updated, Boolean include_record)

Entity Update

Parameters
client_secret Required when authenticating with client settings.
client_id Required when authenticating with client settings.
access_token Required when authenticating with an OAuth access_token.
uuid Required when not using id or key_attribute paramaters.
id Required when not using key_attribute or uuid parameters.
key_attribute Required when not using id or uuid.
key_value Required when using key_attribute.
type_name The entityType of the entity.
value The JSON value to assign by attribute_name.
attribute_name This is a schema path to an individual attribute.
created Timestamps are generated when an entity is created.
last_updated Timestamps are generated when an entity is updated.
include_record When true, a result field is added to the response, containing the data of the newly updated entity record.
Returns
  • true if the operation is successful

public String entityVersions (String type_name, String id, String timestamp, String client_id, String client_secret)

Entity Versions

Parameters
type_name The entityType of the entity.
id The primary key of the parent object.
timestamp The date and time to search for. Capture retrieves the value of the record as it existed at that timestamp.
client_id The client identifier.
client_secret The shared secret paired with the client_id.
Returns
  • the versions

public String forgotPasswordNative (String client_id, String locale, String response_type, String redirect_uri, String form, String email, String flow_name, String flow_version)

Forgot Password Native

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
form The name of the form in your flow where you store the recover password logic..
email The email address for which you want to recover the password.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • the forgotten password

public String getAccessToken (String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String type_name, String for_client_id)

Get Access Token

Parameters
uuid Required when not using the id or key_attribute and key_value paramaters.
id Required when not using the uuid or key_attribute and key_value paramaters.
key_attribute Required when not using id or uuid parameters.
key_value Required when using key_attribute.
client_id The client identifier, which you can find on your dashboard.
client_secret The shared secret paired with the client_id.
type_name The name of the entityType.
for_client_id The client_id for which to retrieve an accessToken.
Returns
  • Access Token

public Admins getAdmins (String partnerKey)

Get Admins

Parameters
partnerKey You Engage partner key, which you can find on the dashboard.
Returns
  • This call returns all admin users currently assigned to the RP.

public String getApiKey ()

public String getAppId ()

public String getAppName ()

public Map<String, String> getAppSettings ()

Get App Settings

Returns
  • the app settings

public String getAuthorizationCode (String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String redirect_uri, String type_name, String transaction_state, String lifetime, String for_client_id)

Get Authorization Code

Parameters
uuid Required when not using the id or key_attribute and key_value paramaters.
id Required when not using the uuid or key_attribute and key_value paramaters.
key_attribute Required when not using id or uuid parameters.
key_value Required when using key_attribute.
client_id The client identifier, which you can find on your dashboard.
client_secret The shared secret paired with the client_id.
redirect_uri The redirect URI. This is the address used by CaptureUI to make the redirect.
type_name The name of the entityType.
transaction_state 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.
lifetime The number of seconds for which the code is valid. The default value is 30 seconds.
for_client_id The client_id for which to retrieve an accessToken.
Returns
  • Authorization Code

public AvailableProviders getAvailableProviders ()

Get Available Providers

Returns
  • a list of configured providers for an application

public Backplane getBackplaneProperties ()

Get Backplane Properties

Returns
  • the backplane properties.

public String getCaptureHost ()

public Contacts getContacts (String identifier, String contactType, Boolean existingUser)

Get Contacts

Parameters
identifier The identifier returned from the auth_info API call. The application must be configured to request this information in the Provider Configuration screen.
contactType Specify friends to return identifiers for every friend of the user. If you do not specify a value, friends will be returned if available.
existingUser If true returns a value that identifies if a user has previously authenticated with the Janrain application before.
Returns
  • a list of all the contacts related to the user

public String getCreationToken (String client_id, String client_secret, String type_name, String lifetime, String for_client_id)

Get Creation Token

Parameters
client_id The client identifier, which you can find on your dashboard.
client_secret The shared secret paired with the client_id.
type_name The name of the entityType.
lifetime The number of seconds for which the code is valid. The default value is 30 seconds.
for_client_id The client_id for which to retrieve an accessToken.
Returns
  • Creation Token

public String getDefault (String client_id, String client_secret, String key)

Get Default

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
Returns
  • the default setting

public DomainPatterns getDomainPatterns ()

Get Domain Patterns

Returns
  • the domain patterns.

public String getEntityType (String type_name, String timestamp, String client_id, String client_secret)

Get Entity Type

Parameters
type_name The entityType of the entity.
timestamp The date and time to search for. Capture retrieves the value of the record as it existed at that timestamp.
client_id The client identifier.
client_secret The shared secret paired with the client_id.
Returns
  • the versions

public String getItems (String client_id, String client_secret, String for_client_id)

Get Items

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
for_client_id The client identifier whose key will be deleted.
Returns
  • the items

public JanrainCaptureClient getJanrainCaptureClient ()

public JanrainEngageClient getJanrainEngageClient ()

public JanrainPartnerClient getJanrainPartnerClient ()

public Client getJerseyClient ()

public String getKeys (String client_id, String client_secret, String for_client_id)

Get Keys

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
for_client_id The client identifier whose key will be deleted.
Returns
  • the keys

public String getMultisettings (String client_id, String client_secret, String key, String for_client_id)

Get MultiSettings

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
for_client_id The client identifier whose key will be deleted.
Returns
  • the settings

public Invites getPendingInvites (String engageApiKey, String partnerKey)

Get Pending Invites

Parameters
engageApiKey Engage API key for the application for which to return pending invites.
partnerKey The Engage partner key for the application that created the app referenced by the apiKey parameter.
Returns
  • the pending invites.

public Map<String, String> getProperties (String partnerKey, String engageApiKey, String provider)

Get Properties

Parameters
partnerKey The Engage partner key for the application that created the app referenced by the apiKey parameter.
engageApiKey Engage API key for the application for which to return pending invites.
provider The name of the provider whose properties you want to return.
Returns
  • the app properties.

public Permissions getProviderPermissions (String partnerKey, String engageApiKey, String provider)

Get Provider Permissions

Parameters
partnerKey The Engage partner key for the application that created the app referenced by the apiKey parameter.
engageApiKey Engage API key for the application for which to return pending invites.
provider The name of the provider whose properties you want to return.
Returns
  • the provider permission.

public String getSettings (String client_id, String client_secret, String key, String for_client_id)

Get Settings

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
for_client_id The client identifier whose key will be deleted.
Returns
  • the settings

public String getShareCount (String url, String callback)

Get Share Count

Parameters
url The URL that was shared.
callback When a value is added, returns data in JSONP format.
Returns
  • he number of a times a given URL has been shared.

public ShareProviders getShareProviders ()

Get Share Providers

Returns
  • a list of email and sharing providers configured for the widget.

public String getToken (String client_id, String client_secret, String grant_type, String code, String redirect_uri, String refresh_token)

Get Token

Parameters
client_id The client identifier for your application
client_secret The shared secret paired with the client_id.
grant_type The access grant type included in the request. Available values are authorization_code and refresh_token.
code The authorization code received from the authorization server.
redirect_uri The redirection URI used in the initial request. CaptureUI uses this address to implement the redirect.
refresh_token The token for refreshing the
Returns
  • A token

public UserInfo getUserData (String identifier, Boolean extended)

Get User Data

Parameters
identifier The identifier returned from the auth_info API call. The application must be configured to request this information in the Provider Configuration screen.
extended Returns the extended Simple Registration and HCard data in addition to the normalized Portable Contacts format.
Returns
  • up-to-date copy of a user’s profile

public String getVerificationCode (String uuid, String id, String key_attribute, String key_value, String client_id, String client_secret, String type_name, String attribute_name, String lifetime)

Get Verification Code

Parameters
uuid Required when not using id or the key_attribute and key_value parameters.
id The id number associated with the user record.
key_attribute Required when not using the id or uuid parameters.
key_value Required when using the key_attribute
client_id The client identifier, which you can find on your dashboard.
client_secret The shared secret paired with the client_id.
type_name The name of the entityType.
attribute_name The name of the attribute to update when using the verification code.
lifetime The number of seconds for which the code is valid. The default value is 30 seconds.
Returns
  • Verification Code

public boolean isConnected ()

Are we connected

public String linkAccountNative (String client_id, String locale, String response_type, String redirect_uri, String token, String flow_name, String flow_version)

Link Account Native

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
token The access token from a previous call to /oauth/auth_native or oauth/auth_native_traditional.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A linked account

public ClientListInfo listClients (String client_id, String client_secret, String has_features)

List Clients

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
has_features A JSON array features names; only clients which have at least one of the features in the array will be displayed.
Returns
  • the clients

public Plugin lookupRp (String pluginName, String pluginVersion)

Lookup Rp

Parameters
pluginName The name of your plugin.
pluginVersion The version number of your plugin.
Returns
  • the plugin response.

public boolean map (String identifier, String primaryKey, Boolean overwrite)

Map

Parameters
identifier The identifier returned from the auth_info API call.
primaryKey The primary key from your users table, as a string.
overwrite If false, only create the mapping if one does not already exist for the specified identifier.
Returns
  • true if the operation is successful

public Identifiers mappings (String primaryKey)

Mappings

Parameters
primaryKey The primary key from your users table, as a string.
Returns
  • all the stored Identity Providers associated with a particular user’s primary key

public WidgetProviders providers ()

Providers

Returns
  • configured sign-in or social providers configured for a widget

public String registerNative (String client_id, String locale, String response_type, String redirect_uri, String token, String flow_name, String flow_version)

Register Native

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
token The access token from a previous call to /oauth/auth_native or oauth/auth_native_traditional.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A linked account

public String registerNativeTraditional (String client_id, String locale, String response_type, String redirect_uri, String password, String password_confirm, String email, String flow_name, String flow_version)

Register Native Traditional

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
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.
password_confirm The confirmation for the user’s password and must match the password parameter.
email The email address you want to verify.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A linked account

public String resetApiKey (String rpAppId, String partnerKey)

Reset Api Key

Parameters
rpAppId The application identifier of the RP application for which you want to reset the API key.
partnerKey The Engage partner key for the application that created the app referenced by the apiKey parameter.
Returns
  • the new api key.

public String retrieveEntity (String client_secret, String client_id, String access_token, String uuid, String id, String key_attribute, String key_value, String password_attribute, String password_value, String type_name, String attribute_name, String attributes, String created, String last_updated)

Retrieve Entity

Parameters
client_secret Required when authenticating with client settings.
client_id Required when authenticating with client settings.
access_token Required when authenticating with an OAuth access_token.
uuid Required when not using id or key_attribute paramaters.
id Required when not using key_attribute or uuid parameters.
key_attribute Required when not using id or uuid.
key_value Required when using key_attribute.
password_attribute Entity can be used to validate user passwords.
password_value A plaintext value that will be matched against the password attribute specified in the password_attribute parameter.
type_name The entityType of the entity.
attribute_name This is a schema path to an individual attribute.
attributes This is a JSON array of attributes.
created Timestamps are generated when an entity is created.
last_updated Timestamps are generated when an entity is updated.
Returns
  • Retrieve an entity of entityType user by id.

public void setApiKey (String apiKey)

Parameters
apiKey

public void setAppId (String appId)

Parameters
appId

public void setAppName (String appName)

Parameters
appName

public boolean setAppSettings (String privacyPolicy, String favicon, String domainRedirect, Boolean postToTokenUrl, Boolean oneTimeUseTokens, Boolean googleProfileUrl)

Set App Settings

Parameters
privacyPolicy Full URL to the location of your privacy policy.
favicon URL of your favicon.
domainRedirect The URL for the redirect.
postToTokenUrl A boolean, true or false.
oneTimeUseTokens A boolean, true or false.
googleProfileUrl A boolean, true or false.
Returns
  • true if the operation is successful

public boolean setAuthProviders (String providers, String deviceType)

Set Auth Providers

Parameters
providers A comma separated string of provider specifiers.
deviceType Web, iphone, android.
Returns
  • true if the operation is successful

public boolean setBackplaneProperties (String server, String bus, String version, Boolean remove, String username, String password)

Set Backplane Properties

Parameters
server The Backplane server’s domain name, such as, example.com.
bus The Backplane bus name.
version The Backplane server version, for example, v1.1. The default value is v1.
remove False is the default. If false, add a new Backplane configuration; otherwise, remove the Backplane configuration for the specified server or bus.
username Only required when you do not use remove. The user name for the Backplane credential.
password Only required when you do not use remove. The user name for the Backplane credential.
Returns
  • true if the operation is successful

public void setCaptureHost (String captureHost)

Parameters
captureHost

public boolean setDefault (String client_id, String client_secret, String key, String value)

Set Default

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
value The value to assign to the key.
Returns
  • true if the operation is successful

public boolean setDescription (String client_id, String client_secret, String for_client_id, String description)

Set Description

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
for_client_id The client id of the client having it’s description changed.
description The new description for the target client.
Returns
  • true if the operation is successful

public boolean setDomainPatterns (String domains)

Set Domain Patterns

Parameters
domains A comma separated list of domains used as a whitelist for the website.
Returns
  • true if the operation is successful

public boolean setFeatures (String client_id, String client_secret, String for_client_id, String features)

Set Features

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
for_client_id The client id of the client having it’s description changed.
features A JSON array of feature names to assign to the client.
Returns
  • true if the operation is successful

public void setJerseyClient (Client jerseyClient)

Parameters
jerseyClient

public String setMultisettings (String client_id, String client_secret, String items, String for_client_id)

Set MultiSettings

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
items A JSON object containing the key-value pairs to set for the client identifier.
for_client_id The client identifier whose key will be deleted.
Returns
  • the settings

public boolean setProperties (String engageApiKey, String partnerKey, String provider, String fbAppID, String fbSecret, Boolean emailPerm, String uninstallURL, String consumerKey, String secret, String paypalDisplayName, String email, String liveidAppID, String liveidSecret, String liveidPrivacyPolicyUrl, String yahooAppID, Boolean activityScopesSet, Boolean contactsScopeSet)

Set Properties

Parameters
engageApiKey The Engage API Key of the application to configure.
partnerKey Your Engage partner key, which you can find on the dashboard.
provider The name of the provider to configure.
fbAppID Facebook only: The Application Id for the user’s Facebook application.
fbSecret Facebook Only: The Application Secret for the user’s Facebook application.
emailPerm Facebook only: Set to true if this application needs email to receive end-user email addresses.
uninstallURL Facebook only: This is the URL that is invoked when the user uninstalls the Facebook application.
consumerKey This is the Consumer Key for the user’s application.
secret The consumer secret the user’s application.
paypalDisplayName PayPal only: The display name for the user’s Paypal application.
email PayPal only: enter a valid email address that is already registered with a PayPal account.
liveidAppID Windows Live only: The Application ID for the user’s Windows Live application.
liveidSecret Windows Live only: The Secret Key for the user’s Windows Live application.
liveidPrivacyPolicyUrl Windows Live only: The URL for the Windows Live application’s privacy policy.
yahooAppID Yahoo only: The Application ID for the user’s Yahoo application.
activityScopesSet Yahoo only: Set to true if the user’s Yahoo application has read and write permissions for “Status” and “Updates.”
contactsScopeSet Yahoo only: Set to true if the user’s Yahoo application has read permission for “Contacts.”
Returns
  • true if the operation is successful.

public boolean setProviderPermissions (String engageApiKey, String partnerKey, String provider, String permissions)

Set Provider Permissions

Parameters
engageApiKey The Engage API Key of the application to configure.
partnerKey Your Engage partner key, which you can find on the dashboard.
provider The name of the provider to configure.
permissions A comma-separated list of permissions to set.
Returns
  • true if the operation is successful.

public String setSettings (String client_id, String client_secret, String key, String value, String for_client_id)

Set Settings

Parameters
client_id The client identifier.
client_secret The shared secret paired with the client_id.
key The key to delete from the client settings.
value The value to assign to the key.
for_client_id The client identifier whose key will be deleted.
Returns
  • the settings

public boolean setShareProviders (String share, String email)

Set Share Providers

Parameters
share Sharing providers to add to the widget. This may be left empty, in which case the widget will have no sharing providers.
email Email providers to add to the widget. You can leave this empty, in which case the widget will have no email providers.
Returns
  • true if the operation is successful

public boolean setStatus (String identifier, String status, String location, Boolean truncate, String source)

Set Status

Parameters
identifier The identifier returned from the auth_info API call.
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.
location This is a string containing location data associated with the content being published.
truncate If true, truncate status when posting to providers that impose status length restrictions (currently Twitter, Yahoo, and LinkedIn).
source 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.
Returns
  • true if the operation is successful

public boolean setWhitelist (String client_id, String client_secret, String for_client_id, String whitelist)

Set Whitelist

Parameters
client_id The client identifier of the owner client.
client_secret The shared secret paired with the client_id.
for_client_id The client id of the client having it’s description changed.
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.
Returns
  • true if the operation is successful

public boolean unmap (String identifier, Boolean allIdentifiers, String primaryKey, Boolean unlink)

Unmap

Parameters
identifier The identifier currently mapped to the primaryKey.
allIdentifiers False is the default. If true, all identifiers mapped to the primaryKey are removed.
primaryKey The primary key from your users table, as a string.
unlink False is the default. If true, unlinks your application from the user’s account with the provider.
Returns
  • true if the operation is successful

public boolean useVerificationCode (String verification_code)

Use Verification Code

Parameters
verification_code The verification code obtained in a previous call to access/getVerificationCode.
Returns
  • true if the operation is successful

public boolean verifyDomain (String engageApiKey, String partnerKey, String provider, String code, String filename)

Verify Domain

Parameters
engageApiKey The Engage API Key of the application to configure.
partnerKey Your Engage partner key, which you can find on the dashboard.
provider The name of the provider to configure.
code This is the Google-supplied META tag value that will be created on the domain.
filename This is the Yahoo-supplied filename that will be created on the domain.
Returns
  • true if the operation is successful.

public String verifyEmailNative (String client_id, String locale, String response_type, String redirect_uri, String form, String email, String flow_name, String flow_version)

Verify Email Native

Parameters
client_id The client identifier for your application.
locale The user’s flow locale for your application.
response_type You must enter one of code, token, or code_and_token.
redirect_uri The value of the redirect_uri that was passed in to provision the authorization code, which Capture matches for security.
form The name of the form in your flow where you store the verify email logic.
email The email address you want to verify.
flow_name The name of the flow you want to use for this user. If you do not enter a value, Capture uses default_flow_name.
flow_version 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.
Returns
  • A linked account

public String webhooksAdd (String client_id, String client_secret, String attributes, String callback, String event_type, String entity_type)

Webhooks Add

Parameters
client_id The client identifier of the target Capture application, available in the dashboard.
client_secret The shared secret paired with the client_id.
attributes This is only applicable when event_type is update.
callback The URL address where the webhook message is to be delivered and processed.
event_type The type of change that triggers the webhook.
entity_type The schema where the attribute is defined. Most of the time, this will be the default schema user.
Returns
  • the created webhook

public String webhooksDelete (String client_id, String client_secret, String uuid)

Webhooks Delete

Parameters
client_id The client identifier of the target Capture application, available in the dashboard.
client_secret The shared secret paired with the client_id.
uuid This is the uuid of the webhook.
Returns
  • the deleted webhook

public String webhooksFind (String client_id, String client_secret, String uuid)

Webhooks Find

Parameters
client_id The client identifier of the target Capture application, available in the dashboard.
client_secret The shared secret paired with the client_id.
uuid This is the uuid of the webhook.
Returns
  • the found webhook

public String webhooksList (String client_id, String client_secret)

Webhooks List

Parameters
client_id The client identifier of the target Capture application, available in the dashboard.
client_secret The shared secret paired with the client_id.
Returns
  • the list of webhooks

public String webhooksUpdate (String client_id, String client_secret, String callback, String event_type, String entity_type, String attributes, String uuid)

Webhooks Update

Parameters
client_id The client identifier of the target Capture application, available in the dashboard.
client_secret The shared secret paired with the client_id.
callback The URL address where the webhook message is to be delivered and processed.
event_type The type of change that triggers the webhook.
entity_type The schema where the attribute is defined. Most of the time, this will be the default schema user.
attributes This is applicable only when event_type is update.
uuid This is the uuid of the webhook.
Returns
  • the updated webhook