/add_or_update_access_token

Adds or updates an OAuth access_token for a user outside the usual login flow.

When a user logs in with an OAuth1 or OAuth2 Identity Provider, Janrain will request an OAuth token from the provider. This OAuth token is used when making subsequent API calls to the provider. The add_or_update_access_token call adds a token retrieved using a different method to Janrain.

Possible Use Cases:

  • If you are migrating an existing application to Social Login or have otherwise acquired an OAuth token for a user outside of Janrain, you may wish to pass that token to in in order to make Janrain RESTful API calls for that user.
  • Data is needed for a user that has never registered using Social Login before. The user's ID and access token are recorded, making it possible to use the get_user_data endpoint.

Only these identity providers support this call:

  • Facebook
  • RenRen
  • Soundcloud
  • Foursquare

Accepted Content-types

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

This endpoint includes the following methods:

  • POST


POST

Example Request


curl -X POST \
    --data-urlencode apiKey=1234567891234567891234567891234567891234\
    --data-urlencode token=123456789123456789\
    --data-urlencode identifier=http://www.facebook.com/profile.php?id=123456789123456789123\
    https://janrain-docs.rpxnow.com/api/v2/add_or_update_access_token
      

Example Response


{
  "stat": "ok"
}
   

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.

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 /api/v2; for example:

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

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

Query Parameters

Parameter Type Required Description
apiKey string Yes Social Login API key. This key can be found on the Janrain Dashboard.
 
identifier string Yes Identifier associated with the social login identity provider. This value must be formatted as part of a URL; for example
 
http://www.facebook.com/profile.php?id=123456789123456789123
token string Yes Access token for the user. Tokens must be requested from identity providers based on their API requirements.