latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Support Tickets
Ticket Management

Validate Customer Portal 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.

Note:

This function is not available through the command line. You must call it as a request body.

get/ticket_validate_oauth2_code

Query parameters

codestring required
Example:84b1a729-63e3-11e6-a0fb-bfcf357fd76d

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

redirect_uristring required
Example:https://hostname.example.com:2087/

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

Response

HTTP Request was successful.

Example response

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