/app/get_properties

This call returns a list of the configured properties for a 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

This endpoint includes 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 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": ""
}
      

Running Code Samples Using Postman

The Janrain REST API code samples are written using Curl, but they can easily be run from within Postman. To use one of our code samples in Postman:

  1. Click the Copy to Clipboard button located directly beneath the code sample
  2. In Postman, click Import to display the Import dialog box.
  3. In the Import dialog box, click Paste Raw Text, and then paste in the copied code. The Import dialog box should look similar to this:

  4. Click Import, and the Curl command will be converted to a format that can be run from within Postman. All you need to do now is configure the command to work with your Janrain implementation.

Query Parameters

Parameter Type Required Description
apiKey string Yes 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 Yes Your Social Login partnerKey, which you can find on the Janrain Dashboard.
 
provider string Yes 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
    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
  • 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
  • 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.