Get the authentication token for an Account Owner

The Get User's auth by token method returns a one-time token for accessing the platform. With the token, a third-party user can authenticate in the Customer Control Panel as an Account Owner (see Access levels of users). The token is requested for an Account of the current Reseller or any of its downstream Resellers.

In case of authentication with a token, the Customer Control Panel is available at {installation_url}/?user_email={owner's_email}&user_token={owner's_token}

An API token of a Manager is required for authorization. To get an API token via the Operator Control Panel, see Viewing and updating manager's information. 

The Manager's API token specified in an API request determines the current Reseller and downstream Resellers accessible within a method.

GET {base_url}/api/v3/resellers/{reseller_id}/user_authentication/token

Arguments

Name

Parameter Type

Data type

Required/ Optional

Description

X-Api-TokenheaderstringRequiredAPI token of a Manager that performs the operation (see Viewing and updating manager's information)
Content-TypeheaderstringRequiredMedia type of the request. Specify the following: application/vnd.api+json
AcceptheaderstringRequired

Supported media types of the answer. Specify the following: application/vnd.api+json

base_urlpathstringRequiredActivePlatform URL
reseller_idpathnumberRequiredID of the current Reseller or any of its downstream Resellers (see Viewing and updating reseller general information)
account_idpathnumberRequiredID of the required Account

Response model

Name

Data type

Description

owner_emailstringEmail of the Account Owner that is used for authentication
owner_tokenstringOne-time token that is used for authentication

Request example

GET /api/v3/resellers/1/user_authentication/token?account_id=505
Host: test.activeplatform.com
Content-Type: application/vnd.api+json
X-Api-Token: vY5fwetestK3gJXZH5uHCw
Accept: application/vnd.api+json

Response example

{
    "owner_email": "example@activeplatform.com",
    "owner_token": "Sg1DZLtoken7PH4sVsAeh"
}