latestOpenAPI 3.0.2cPanel License2026-08-106251554.3 MB

3da41671c02c

Authentication
External Authentication

Add identity provider to cPanel account

This function adds an External Authentication authorization link to an account.

get/link_user_authn_provider

Query parameters

preferred_usernamestring required
Example:Example

The preferred username of the account on the identity provider.

provider_idstring required
Example:google

The name of the identity provider.

subject_unique_identifierstring required
Example:123456789012345678901

The unique identifier for the user at the identity provider.

usernamestring username required
Example:example

The account's username.

Response

HTTP Request was successful.

Example response

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