/access/getAccessToken

This API call retrieves an accessToken for signing in to an application.

This endpoint includes the following methods:

GET

Authentication

This endpoint supports both Basic authentication (recommended) and janrain-signed authentication.

How to Create an Authentication String

Base URL

The base URL for this endpoint is your Janrain Capture domain; for example:

https://educationcenter.us-dev.janraincapture.com

Your Capture domains (also known as Registration domains) can be found in the Janrain Console on the Manage Application page:

Examples

Example Request


curl -G -H "Authorization: Basic aW1fYV...NfbXk="\
    --data-urlencode uuid=78907890wxyzwxyz \
    --data-urlencode type_name=user \
    https://my-app.janraincapture.com/access/getAccessToken

Running this command in Postman

Authorized Clients

owner
access_issuer

Query Parameters

Parameter	Type	Required	Description
uuid	string		UUID of the user account. This parameter is required if you are not using either the id parameter or the key_attribute parameter.
id	string		ID of the user account. This parameter is required if you are not using either the uuid parameter or the key_attribute parameter.
key_attribute	string		Name of a unique attribute found in the user profile schema. This parameter is required if you are not using either the id parameter or the uuid parameter.
key_value	string		Value assigned to the key_attribute parameter.
type_name	string	Yes	Name of the entityType.
for_client_id	string		Client ID of the client being used to retrieve an access token.

Responses

200 OK

Response Example (application/json)


{
  "accessToken": "tc7blahblah3tmaz",
  "stat": "ok"
}

How to Create an Authentication String

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.

Before you actually try your authentication string, 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.

GET

Running this Command in Postman

How to Create an Authentication String