Sign in

v1

latestOpenAPI 3.0.2cPanel License2026-08-06657427.1 MB
ExternalAuthentication
External Authentication

Add external authentication link

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

get/ExternalAuthentication/add_authn_link

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 username.

Response

HTTP Request was successful.

apiversioninteger

The version of the API.

funcstring

The name of the method called.

modulestring

The name of the module called.

Example response

{
  "apiversion": 3,
  "func": "add_authn_link",
  "module": "ExternalAuthentication",
  "result": {
    "status": 1
  }
}