Add identity provider to cPanel account

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

SecurityBasicAuth

Request

query Parameters

preferred_username required	string The preferred username of the account on the identity provider. Example: preferred_username=Example
provider_id required	string The name of the identity provider. Example: provider_id=google
subject_unique_identifier required	string The unique identifier for the user at the identity provider. Example: subject_unique_identifier=123456789012345678901
username required	string <username> The account's username. Example: username=example

Responses

200

HTTP Request was successful.

Response Schema: application/json

object

get/link_user_authn_provider

Request samples

whmapi1 --output=jsonpretty \
  link_user_authn_provider \
  username='example' \
  provider_id='google' \
  subject_unique_identifier='123456789012345678901' \
  preferred_username='Example'

Response samples

application/json

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