/access/getAccessToken

Returns an access token for the specified user.

This endpoint includes the following methods:

  • POST


POST


API Client Permissions

The following table indicates the API clients that can (and the API clients that can't) be used to call this endpoint:

owner
access_issuer
direct_access
direct_read_access
login_client
Yes
Yes
Yes
No
No


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 Identity Cloud Capture domain; for example:

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

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

Examples

Example Request

This command returns an access token for the user with the UUID 02b0c68d-7d7a-49d8-a88d-022585b0f877.


curl -X POST \
  -H "Authorization: Basic dXQ0YmdycmE3dzI4MmpjZm15cGZxeDlwemhxaGpqMmI6dW5qemU5bndrZnV5NmpwdzgzOHFwYTdhZDNoZG55YTY="\
  --data-urlencode uuid=02b0c68d-7d7a-49d8-a88d-022585b0f877 \
  --data-urlencode type_name=user \
  https://my-app.janraincapture.com/access/getAccessToken
                                   

      Running this command in Postman


Query Parameters

ParameterTypeRequiredDescription
uuidstring
UUID of the user account. This parameter is required if you are not using either the id parameter or the key_attribute parameter.
 
idstring
ID of the user account. This parameter is required if you are not using either the uuid parameter or the key_attribute parameter.
 
key_attributestring
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_valuestring
Value assigned to the key_attribute parameter.
 
type_namestringYesName of the entityType.
 
for_client_idstring
Client ID of the client being used to retrieve an access token.
 


Responses

200 OK

Response Example (application/json)


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