/apps

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

This endpoint accepts the following methods:

  • POST

POST

Authentication

This endpoint supports Basic authentication. To create an authentication string, combine your API client ID, a colon (:), and your client secret into a single value. For example, if your client ID is abcdefg and your client secret is hijklmnop, that value would look like this:

abcdefg:hijklmnop

Next, take the string and base64 encode it.

For example, on a Mac, you can base encode the string using this command:

echo -n "abcdefg:hijklmnop" | base64

If you’re running Microsoft Windows, you can encode the string by using a Windows PowerShell command similar to this:

[Convert]::ToBase64String([System.Text.Encoding]::UTF8.GetBytes("abcdefg:hijklmn"))

The resulting value (e.g., YWJjZGVmZzpoaWprbG1ub3A=) should be used in your authentication header.

If you are making API calls using Postman, select Basic Auth as your identification type, then use the client ID as the username and the client secret as the password.

Make sure that your API client has the all the permissions (for example, the right to read user profile information) needed to complete the API call.

Base URL

The base URL for this endpoint is your application domain followed by /partner/v2; for example:

https://educationcenter.rpxnow.com/partner/v2

You can find your application domain in the Social Login (Engage Dashboard) on the Settings page:

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
      
      Running this command in Postman

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

Parameter Type Required Description
format string The response format: either xml or json. If not specified, the response defaults to json.
 
partnerKey string Yes 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.