Child pages
  • WHM API 1 Functions - unlink_user_authn_provider

Versions Compared

Key

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

Excerpt

This function unlinks a cPanel account from an external authentication identity provider.

Panel
bgColor#F2F2F2
borderStylenone

Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
/json-api/unlink_user_authn_provider?api.version=1&username=example&provider_id=facebook&service_name=cpaneld&subject_unique_identifier=123456789012345678901
Expand
titleXML API
Code Block
languagexml
/xml-api/unlink_user_authn_provider?api.version=1&username=example&provider_id=facebook&service_name=cpaneld&subject_unique_identifier=123456789012345678901
Expand
titleCommand Line
Code Block
languagebash
whmapi1 unlink_user_authn_provider username=example provider_id=facebook service_name=cpaneld subject_unique_identifier=123456789012345678901

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

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

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

ParameterTypeDescriptionPossible valuesExample
usernamestring

Required

The account's username.

A valid username.example
service_namestring

Required

The account's cPanel & WHM service.

  • cpaneld
  • webmaild
  • whostmgrd
cpaneld
provider_idstring

Required

The system's internal key for the identity provider.

A valid string.facebook
subject_unique_identifierstring

Required

The unique identifier for the user at the identity provider.

A valid string.
123456789012345678901

 

This function only returns metadata.