WHM API 1 Functions - ticket_validate_oauth2_code

This function validates the OAuth2 code from the cPanel Customer Portal. After the function validates the token, the system stores it on the current session.

Examples

JSON API

https://hostname.example.com:2087/cpsess##########/json-api/ticket_validate_oauth2_code?api.version=1&code=84b1a729-63e3-11e6-a0fb-bfcf357fd76d&redirect_uri=https%3A%2F%2Fhostname.example.com%2F

XML API

https://hostname.example.com:2087/cpsess##########/xml-api/ticket_validate_oauth2_code?api.version=1&code=84b1a729-63e3-11e6-a0fb-bfcf357fd76d&redirect_uri=https%3A%2F%2Fhostname.example.com%2F

Command Line

whmapi1 ticket_validate_oauth2_code code=84b1a729-63e3-11e6-a0fb-bfcf357fd76d redirect_uri=https://hostname.example.com:2087/

Notes:

You must URI-encode values.
For more information and additional output options, read our Guide to WHM API 1 documentation or run the whmapi1 --help command.
If you run CloudLinux™, you must use the full path of the whmapi1 command:
```
/usr/local/cpanel/bin/whmapi1
```

Output (JSON)

 {
	"metadata": {
		"reason": "OK",
		"version": 1,
		"command": "ticket_validate_oauth2_code",
		"result": 1
	}
}

Output (XML)

<result>
	<metadata>
		<reason>OK</reason>
		<version>1</version>
		<command>ticket_validate_oauth2_code</command>
		<result>1</result>
	</metadata>
</result>

Note:

Use WHM's API Shell interface (WHM >> Home >> Development >> API Shell) to directly test WHM API calls.

Parameters

Parameter Type Description Possible values Example

code

string

Required

The code from the OAuth2 redirect. The system validates this code and exchanges it for a token.

An OAuth2 code.

84b1a729-63e3-11e6-a0fb-bfcf357fd76d

redirect_uri

integer

Required

The redirect URI query argument that the system sent to the initial OAuth2 authentication endpoint.

A valid URL.

https://hostname.example.com:2087/

Returns

This function only returns metadata.

Function information

API Version:

WHM API 1

Available in:

WHM 60+

Methods:

GET, POST

Required Parameters:

code, redirect_uri

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

Some functions and parameters may require that you authenticate as the root user.
You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.

Find a function

Related functions

Page:

WHM API 1 Functions - ticket_ssh_test — This function verifies the connection from the cPanel Customer Portal to the server.
Page:

WHM API 1 Functions - ticket_revoke — This function removes a cPanel Customer Portal SSH key from the server.
Page:

WHM API 1 Functions - ticket_get_support_agreement — This function retrieves the Technical Support Agreement text and metadata about the user's agreement status from the cPanel Customer Portal.
Page:

WHM API 1 Functions - ticket_update_service_agreement_approval — This function records a user's acceptance of the Technical Support Agreement (TSA).
Page:

WHM API 1 Functions - ticket_validate_oauth2_code — This function validates the OAuth2 code from the cPanel Customer Portal.

Child pages