Child pages
  • WHM API 1 Functions - link_user_authn_provider

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
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
Expand
titleXML API
Code Block
languagexml
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
Expand
titleCommand Line
Code Block
languagebash
whmapi1 link_user_authn_provider username=example provider_id=google subject_unique_identifier=123456789012345678901 preferred_username=Example

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagexml
linenumberstrue
{
   "metadata":{  
      "version":1,
      "reason":"OK",
      "result":"1",
      "command":"link_user_authn_provider"
   }
}
Expand
titleOutput (XML)
Code Block
languagexml
linenumberstrue
<result>
  <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>link_user_authn_provider</command>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

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.