/app/create

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

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


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"
  }
}
          

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
email string Yes Email address of the administrator for the new Social Login application.
 
domain string Yes Name of the domain being added.
 
format string API response data format. Allowed values are:
  • ​xml
  • json (the default value)
partnerKey string Yes Social Login partner key. This key can be found 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.