Child pages
  • WHM API 1 Functions - link_user_authn_provider
Skip to end of metadata
Go to start of metadata

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


 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/link_user_authn_provider?api.version=1&username=example&provider_id=google&subject_unique_identifier=123456789012345678901&preferred_username=Example
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/link_user_authn_provider?api.version=1&username=example&provider_id=google&subject_unique_identifier=123456789012345678901&preferred_username=Example
 Command Line
whmapi1 link_user_authn_provider username=example provider_id=google subject_unique_identifier=123456789012345678901 preferred_username=Example


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":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"link_user_authn_provider"
   }
}
 Output (XML)
<result>
  <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>link_user_authn_provider</command>
    </metadata>
</result>


Note:

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

ParameterTypeDescriptionPossible ValuesExample
usernamestring

Required

The account's username.

A valid cPanel username on the server.example
provider_idstring

Required

The name of the identity provider.

A valid string.google
subject_unique_identifierstring

Required

The unique identifier for the user at the identity provider.

A valid string.
123456789012345678901
preferred_usernamestring

Required

The preferred username of the account on the identity provider.

A valid string.Example

 

This function only returns metadata.