/app/set_properties

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

Authentication

This endpoint supports Basic authentication. 

How to Create an Authentication String

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


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

Example Response


{
  "stat": "ok"
}
      

Query Parameters

Parameter Type Required Description
activtiyScopesString 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 Yes Your Social Login apiKey, which you can find on the Janrain Dashboard.
 
consumerKey string Yes 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
  • Yahoo!
contactScopeSet 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 Facebook only: Set to true if this application needs email to receive end-user email addresses.
 
fbAppId string Yes Facebook only: The Application Id for the user's Facebook application.
 
fbSecret string Yes 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 Yes Microsoft Account only: The Application ID for the user's Microsoft Account application.
 
liveidSecret Microsoft Account only: The Secret Key for the user's Microsoft Account application.
 
liveidPrivacyPolicyUrl string Yes Microsoft Account only: The URL for the Microsoft Account application's privacy policy.
 
partnerKey string Yes Your Social Login partnerKey, which you can find on the Janrain Dashboard.
 
paypalDisplayName string Yes PayPal only: The display name for the user's Paypal application.
 
provider string Yes 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
  • foursquare.
Provider specific parameters are listed below.
 
secret string Yes 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
  • yahoo
uninstallURL string Facebook only: This is the URL that is invoked when the user uninstalls the Facebook application.
 
yahooAppID string Yes Yahoo only: The Application ID for the user's Yahoo application.