Validate login token

This function validates a login token to a cPanel Market provider and returns an access token.

SecurityBasicAuth
Request
query Parameters
login_token
required
string

The login token for the cPanel Market provider.

Example: login_token=8675309
provider
required
string

The name of the cPanel Market provider.

Example: provider=cPStore
url_after_login
required
string <url>

The url_after_login value that you sent to UAPI's Market::get_login_url function.

Example: url_after_login=http://hostname.example.com/redirectionlocation.cgi?state
Responses
200

HTTP Request was successful.

Response Schema: application/json
apiversion
integer

The version of the API.

func
string

The name of the method called.

module
string

The name of the module called.

object
get/Market/validate_login_token
Request samples
uapi --output=jsonpretty \
  --user=username \
  Market \
  validate_login_token \
  provider='cPStore' \
  login_token='8675309' \
  url_after_login='http://hostname.example.com/redirectionlocation.cgi?state'
Response samples
application/json
{
  • "apiversion": 3,
  • "func": "validate_login_token",
  • "module": "Market",
  • "result": {
    • "data": {
      • "access_token": "8675309"
      },
    • "errors": null,
    • "messages": null,
    • "metadata": {
      • "transformed": 1
      },
    • "status": 1,
    • "warnings": null
    }
}