Janrain Partner API Documentation

Partner Endpoints Overview

Admin Endpoints

These endpoints focus on discovery and manipulation of admin users that have access to a Social Login app.

Application Endpoints

These endpoints control the creation, deletion, querying, and configuration of a Social Login app.

Partner API Error Codes

If an irrecoverable error occurs during the API call, Janrain will return an error response with a code and a message.

Error Code Description
-1 Service Temporarily Unavailable.
0 Missing parameter. Required parameter was not provided.
1 Invalid parameter. Provided parameter was in the wrong format.
1 Could not determine CNAME for custom domain. CNAME for the custom domain is not set in the Engage DB.
1 Supplied domain not found in partner domain whitelist. Custom domain is not in the Engage DB.
1 Invalid realm. This can mean several things: name is too long or too short, realm is too long or contains invalid characters, or the realm or custom domain is already taken by another application.
1 Invalid parameter: {parameter}. The provided parameter is the wrong format.
1 Invalid provider: {provider name}. One of the providers in the provided list is not valid.
1 {provider name} not configured. This provider must be configured before use.
1 Setting permissions not supported for this provider. Provider is invalid or does not have permissions that can be set.
1 Permission does not exist: {permission name}. One of the permissions in the provided list is not valid.
1 Permission not supported for this provider: {permission name}. One of the permissions in the provided list does not exist for this provider.
1 Permission can not be set: {permission name}. One of the permissions in the provided list cannot be set because of the application’s tier (basic, pro, and so on).
2 Data not found.
3 Authentication error.
3 Invalid partnerKey. Provided partner key does not exist.
3 Invalid apiKey. Provided API key does not exist.
4 Facebook error.
5 Mapping exists.
6 Error interacting with a previously-operational provider.
7 Engage account upgrade needed to access this API.
8 Missing third-party credentials for this identifier.
9 Third-party credentials have been revoked.
10 Your application is not properly configured.
11 The provider or identifier does not support this feature.
12 Google error.
13 Twitter error.
14 LinkedIn error.
15 LiveId error.
16 MySpace error.
17 Yahoo error.
18 Domain already exists.
19 App ID not found.

Endpoints

https://{domain}/partner/v2

URI Parameters

domain string required

The social application domain name.

Example: rpxnow.com

/admin/add

Description

This call adds an administrator user to the RP.

Note: Multiple user entities can be associated to the same email address. When you set verify to false, attempting to add an admin user with such an ambiguous email returns an error.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode email=example@example.com \
    https://rpxnow.com/partner/v2/admin/add
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

email string required

The email address of the admin user to be added.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

verify string

Indicates whether a verification email is sent out, requiring the user to click on it before they get access to the website. Must be true (the default), or false. If true, the user can enter any email address. If false, the user must already be an admin user on one or more of the existing partner RPs.

/admin/delete

Description

This call deletes an admin user on an RP.

Note: The API call will not delete an admin if they are the only (non-pending) admin for that RP. The call will respond with an error in this case. In the dashboard, choosing to delete the last admin of an RP will cause the RP to be deleted. The delete API call should be used for that purpose when using the API.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode email=example@example.com  \
    https://rpxnow.com/partner/v2/admin/delete
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

email string required

The email associated with the admin user.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

/admin/get

Description

This call returns all admin users currently assigned to the RP. It also lists the email associated with each admin user, and if they are subscribed to notifications.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    https://rpxnow.com/v2/admin/get
Example Response
{
  "stat": "ok",
  "admins": [
    {
      "email": "somebody@somewhere.com",
      "notify": true
    },
    {
      "email": "somebody2@somewhere.com",
      "notify": false
    }
  ]
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

Responses

200 OK

Response Fields

Field Type Description
admins array A list of all admins for the RP.
email dictionary The admin's email address.
notify dictionary Indicates whether the admin receives email notifications. Defaults to true.
invite dictionary The invitation link for the admin user, if present.

/app/add_domain

Description

This call adds a domain to an existing Social Login application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode domain=www.example.com \
    https://rpxnow.com/partner/v2/app/add_domain
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

domain string required

The domain to add.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

/app/create

Description

This call creates a new Social Login application. You can use the new application immediately for authenticating with OpenID-enabled providers (Google, AOL, and so on), but non-OpenID providers, such as Facebook, require additional configuration. After calling this function, use set_properties to enable these additional features.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode email=test@example.com \
    --data-urlencode name=example_app \
    --data-urlencode domain=www.example.com \
    https://rpxnow.com/partner/v2/app/create
Example Response
{
  "partnerresponse": {
    "stat": "ok",
    "apikey": "12345678912234567891234567891234567891234",
    "adminurl": "https://rpxnow.com/relying_parties/example",
    "inviteurl": "https://rpxnow.com/invite?code=0123645678901234567890123456789012345678901",
    "realm": "example.rpxnow.com",
    "appid": "01234567890123456789"
  }
}

Query Parameters

email string required

The administrative email address to be associated with your new Social Login application.

domain string required

The domain to add.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

Responses

200 OK

Response Fields

Field Type Description
stat dictionary

This response is either ok or fail. If it's fail, it includes information on what went wrong. Otherwise, the remainder of these fields will be present.

apiKey dictionary

The new application's apiKey.

adminUrl dictionary

Your new application's administration URL. All administrators that have access to the parent app will have access to the new application.

inviteUrl dictionary

Your new application's invite URL. The URL to use to invite new users to the application.

realm dictionary

The fully qualified domain for your newly created application.

appId dictionary

The application id for your new application.

/app/create_invite

Description

This call generates an email invitation for administrative access to an existing application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode email=testing@example.com \
    https://rpxnow.com/partner/v2/app/create_invite
Example Response
{
  "PartnerResponse": {
    "stat": "ok",
    "inviteUrl": "https://rpxtesting.com/invite?code=12345678912234567891234567891234567891234"
  }
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

email string required

The administrative email address to be associated with your new Social Login application.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

Responses

200 OK

Response Fields

Field Type Description
stat dictionary

The response is either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the remainder of these fields will be present.

inviteUrl dictionary

The new application's invite URL. This URL can be used to invite new users to the application.

/app/delete

Description

This call deletes an existing application. This operation completely destroys the Social Login application and is irreversible.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

The response will be either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the application is deleted.

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    https://rpxnow.com/partner/v2/app/delete
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

/app/get_pending_invites

Description

This API call is deprecated. Please use the admin/get call instead.

This call gets a list of all pending invitations for an Social Login application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    https://rpxnow.com/partner/v2/app/get_pending_invites
Example Response
{
  "stat": "ok",
  "invites": [
    {
      "email": "alice@janrain.com",
      "url": "http://rpxnow.com/invite?code=12345678912234567891234567891234567891234"
    },
    {
      "email": "bob@janrain.com",
      "url": "http://rpxnow.com/invite?code=9876543210987654321098765432109876543210"
    },
    {
      "email": "bob@janrain.com",
      "url": "http://rpxnow.com/invite?code=0123456789012345678901234567890123456789"
    }
  ]
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

/app/get_properties

Description

This call returns a list of the configured properties for an Social Login application. You can use this in conjunction with /partner/v2/app/set_properties, which can be called after /partner/v2/app/create to configure the application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

The following is an example of retrieving the configured properties for Facebook for a given Social Login application.

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode provider=facebook \
    https://rpxnow.com/partner/v2/app/get_properties
Example Response
{
  "stat": "ok",
  "fbAppID": "123456789123456",
  "fbSecret": "1234567891234567891234567891234",
  "emailPerm": false,
  "uninstallURL": ""
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

provider string required

The name of the provider whose properties you want to return. This call supports these providers: google, facebook, linkedin, live_id, mixi, myspace, paypal, twitter, tumblr, salesforce, yahoo, orkut, and foursquare.

Parameters returned differ by provider. These are listed in the Response section.

Responses

200 OK

Response Fields

Field Type Description
fbAppID dictionary

Facebook only: The Application Id for the user's Facebook application.

fbSecret dictionary

Facebook only: The Application Secret for the user's Facebook application.

emailPerm dictionary

Facebook only: Must be true or false. Set to true if this application needs email to receive end-user email addresses, otherwise set to false.

uninstallURL dictionary

Facebook only: This is the URL that will be invoked when the user uninstalls the Facebook application. If this has not been configured for this application, it will be an empty string.

consumerKey dictionary

The Consumer Key for the user's application. Use the consumerKey for each of: Foursquare, Google, LinkedIn, Mixi, MySpace, Orkut, Renren, Salesforce, Sina Weibo, SoundCloud, Twitter, and Yahoo!.

secret dictionary

The Consumer Secret for the user's application. Use the secret for each of: Foursquare, Google, LinkedIn, Mixi, MySpace, Orkut, renren, Salesforce, Sina Weibo, SoundCloud, Twitter, and Yahoo!.

paypalDisplayName dictionary

PayPal only: The display name for the user's Paypal application.

liveidAppID dictionary

Microsoft Account only: The Application ID for the user's Windows Live application.

liveidSecret dictionary

Microsoft Account only: The Secret Key for the user's Windows Live application.

liveidPrivacyPolicyUrl dictionary

Microsoft Account only: The Secret Key for the user's Windows Live application.

yahooAppId dictionary

Yahoo only: The Application ID for the user's Yahoo application.

activityScopesSet dictionary

Yahoo only: Returns true if read/write access has been enabled for Yahoo Status Updates. Otherwise, returns false.

contactsScopeSet dictionary

Yahoo only: Returns true if read access has been enabled for Yahoo Contacts. Otherwise, returns false.

/app/get_provider_permissions

Description

This call returns an Social Login application’s permissions for a provider, as set with the set_provider_permissions call.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode provider=google \
    https://rpxnow.com/partner/v2/app/get_properties
Example Response
{
  "stat": "ok",
  "permissions": [
    "readContactsCheckins",
    "manageNotifications",
    "publishCheckins",
    "readCheckins",
    "sendSms",
    "chatLogin",
    "managePages",
    "manageAds",
    "readRequests",
    "readMailbox",
    "rsvpEvent",
    "offlineAccess",
    "onlinePresence",
    "readContactLists",
    "contactsOnlinePresence",
    "createEvent"
  ]
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

provider string required

The name of the provider about which you want information.

Responses

200 OK

Response Fields

Field Type Description
stat dictionary

This response is either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the remainder of these fields will be present.

permissions dictionary

A list of all the permissions that have been configured for the specified provider with the set_provider_permissions call. See the documentation on set_provider_permissions for a list of all available permissions for each provider.

/app/reset_api_key

Description

This call resets the API key for a given partner RP application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode appID=sample_app \
    https://rpxnow.com/partner/v2/app/reset_api_key
Example Response
{
  "stat": "ok",
  "apiKey": "1234567891234567891234567891234567891234"
}

Query Parameters

appId string required

The application identifier of the RP application for which you want to reset the API key.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

Responses

200 OK

Response Fields

Field Type Description
stat dictionary

This will be either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the remainder of these fields will be present.

apiKey dictionary

The application's new API key.

/app/set_properties

Description

This call configures Social Login application properties for a given application. Use this function to bind a given application to a given provider. For example, after calling create, use this function to set up a binding to a Facebook application.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode provider=google \
    --data-urlencode consumerKey=12345678912345 \
    --data-urlencode secret=98765432198765 \
    https://rpxnow.com/partner/v2/app/set_properties
Example Response
{
  "stat": "ok"
}

Query Parameters

activityScopesSet string

Yahoo only: Set to true if the user's Yahoo application has read and write permissions for "Status" and "Updates." This enables use of Yahoo! with the Sharing solution and the associated activity and set_status API calls. Configuring the permission in the Yahoo! developer portal requires that the application's consumer key and secret be regenerated.

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

consumerKey string required

This is the Consumer Key for the user's application. Each provider may implement their consumerKey a little differently, but the parameter name is the same for this API call. This parameter applies to Foursquare, Google, LinkedIn, Mixi, MySpace, Orkut, renren, Salesforce, Sina Weibo, Sound Cloud, Twitter, and Yahoo!.

contactsScopeSet string

Yahoo only: Set to true if the user's Yahoo application has read permission for "Contacts." This enables the get_contacts API call for signed-in Yahoo! users. Configuring the permission in the Yahoo! developer portal requires that the application's consumer key and secret be regenerated.

email string

PayPal only: enter a valid email address that is already registered with a PayPal account.

emailPerm string

Facebook only: Set to true if this application needs email to receive end-user email addresses.

fbAppID string required

Facebook only: The Application Id for the user's Facebook application.

fbSecret string required

Facebook Only: The Application Secret for the user's Facebook application.

format string

The response format: either xml or json. If not specified, the response defaults to json.

liveidAppID string required

Microsoft Account only: The Application ID for the user's Microsoft Account application.

liveidSecret string required

Microsoft Account only: The Secret Key for the user's Microsoft Account application.

liveidPrivacyPolicyUrl string required

Microsoft Account only: The URL for the Microsoft Account application's privacy policy.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

paypalDisplayName string required

PayPal only: The display name for the user's Paypal application.

provider string required

The name of the provider to configure. This call supports these providers: google, facebook, linkedin, live_id, mixi, myspace, paypal, twitter, renren, salesforce, sinaweibo, soundcloud, yahoo, orkut, and foursquare. Provider specific parameters are listed below.

secret string required

The consumer secret the user's application. Each provider may implement the secret a little differently. The parameter name is the same for every provider for this call. The supported providers are: foursquare, google, linkedin, mixi, myspace, orkut, renren, salesforce, sinaweibo, soundcloud, twitter, and yahoo.

uninstallURL string

Facebook only: This is the URL that is invoked when the user uninstalls the Facebook application.

yahooAppID string required

Yahoo only: The Application ID for the user's Yahoo application.

/app/set_provider_permissions

Description

This call sets an Social Login application's permissions for a provider. The permissions that you can set depend on the provider, service level, and whether the provider has been configured or not. You can set permissions if, and only if, you pass them in the permissions parameter. Each request replaces the existing set of permissions. The old ones are cleared and the new ones set.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    --data-urlencode provider=facebook \
    --data-urlencode permissions='address, emails, interests, organizations, photos, status' \
    https://rpxnow.com/partner/v2/app/set_provider_permissions
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

permissions string required

Facebook only: A comma-separated list of permissions to set. This call supports these permissions for Facebook:

  • address
  • addresses
  • birthday
  • chatLogin
  • contactsOnlinePresence
  • contactsReligionPolitics
  • createEvent
  • educationHistory
  • emails
  • events
  • groups
  • interestedInMeeting
  • interests
  • likes
  • manageAds
  • manageNotifications
  • managePages
  • musicActions
  • notes
  • offlineAccess
  • onlinePresence
  • organizations
  • photos
  • publishActions
  • publishCheckins
  • questions
  • readCheckins
  • readContactLists
  • readContactsCheckins
  • readMailbox
  • readRequests
  • relationshipStatus
  • religionPolitics
  • rsvpEvent
  • sendSms
  • socialSharing
  • status
  • urls
  • videos

Google only: A comma-separated list of permissions to set. This call supports these permissions for Google:

  • analytics
  • blog
  • bookSearch
  • calendar
  • contacts
  • database
  • documents
  • finance
  • maps
  • notebook
  • readMailbox
  • sites
  • socialNetworkReadOnly
  • socialNetwork
  • spreadsheets
  • video
  • webAlbums
  • webAnnotations
  • webmasterTools

PayPal only: A comma-separated list of permissions to set. This call supports these permissions for PayPal:

  • accessCredentials
  • addresses
  • birthday
  • languagesSpoken
  • phoneNumbers
  • utcOffset
  • verifiedAccount

LinkedIn only: A comma-separated list of permissions to set. This call supports these permissions for LinkedIn:

  • email

Mixi only: A comma-separated list of permissions to set. This call supports these permissions for Mixi:

  • profileAboutMe
  • profileBirthday
  • profileBloodType
  • profileFavoriteThings
  • profileGender
  • profileHometown
  • profileInterests
  • profileLastLogin
  • profileLocation
  • profileName
  • profileOccupation
  • profileOrganizations
  • profileStatus
  • readCalendar
  • readCheckin
  • readDiary
  • readMessage
  • readPageFollow
  • readPage
  • readPhoto
  • readShare
  • readUpdates
  • readVoice
  • writeCalendar
  • writeCheckin
  • writeDiary
  • writeMessage
  • writePageFeed
  • writePhoto
  • writeProfile
  • writeShare
  • writeVoice
provider string required

The name of the provider. This call supports only:

  • facebook
  • google
  • linkedin
  • mixi
  • paypal

For each provider listed here, see the provider-specific permissions listed below.

/app/verify_domain

Description

This function automates the server-side component of the provider-specific domain verification mechanism. This function should be called before /partner/v2/app/set_properties to complete the domain verification process.

Only Google and Yahoo! support this feature.

Accepted Content-types

  • application/x-www-form-urlencoded
  • multipart/form-data

post

Description

Example Request

curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234 \
    --data-urlencode provider=google \
    --data-urlencode code=rCLLGGTVdEiGe+DXLHKLCD670B8f99LfK/Ax6sS \
    https://rpxnow.com/partner/v2/app/verify_domain
Example Response
{
  "stat": "ok"
}

Query Parameters

apiKey string required

Your Social Login apiKey, which you can find on the Janrain Dashboard.

code string required

This is the Google-supplied META tag value that will be created on the domain. Use this parameter only when the provider value is google.

filename string required

This is the Yahoo-supplied filename that will be created on the domain. Use this parameter only when the provider value is yahoo.

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

provider string required

Name of the provider. Must be one of google or yahoo.

/apps

Description

This call lists all applications managed by a partner. This constitutes one parent RP and some number (possibly zero) of child applications, created with create.

post

Description

Example Request

The following is an example of retrieving all applications associated with a partnerKey.

curl -X POST \
    --data-urlencode partnerKey=9876543219876543219876543219876 \
    https://rpxnow.com/partner/v2/apps
Example Response
{
   "stat":"ok",
   "apps":[
      {
         "appId":"12345678912345678912",
         "applicationDomain":"example.janrain.com",
         "apiKey":"12345678912234567891234567891234567891234"
      },
      {
         "appId":"98765432109876543210",
         "applicationDomain":"example2.janrain.com",
         "apiKey":"9876543210987654321098765432109876543210"
      },
      {
         "appId":"01234567890123456789",
         "applicationDomain":"example3.janrain.com",
         "apiKey":"0123456789012345678901234567890123456789"
      }
   ]
}

Query Parameters

format string

The response format: either xml or json. If not specified, the response defaults to json.

partnerKey string required

Your Social Login partnerKey, which you can find on the Janrain Dashboard.

Responses

200 OK

Response Fields

Field Type Description
stat dictionary This will be either ok or fail. If it fails, it includes information on what went wrong. Otherwise, the remainder of these fields will be present.
apps array List of applications managed by the partner. Each application is specified by three values: application ID, application domain, and API key.