We have a new documentation site for cPanel & WHM! You can find our new documentation site at docs.cpanel.net.

We will continue to maintain our API documentation on this server.

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


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


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


Notes:

  • Unless otherwise noted, 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": "unlink_user_authn_provider"
  }
}
 Output (XML)
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>unlink_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 username.example
provider_idstring

Required

The system's internal key for the identity provider.

A valid string.cpanelid
subject_unique_identifierstring

Required

The unique identifier for the user at the identity provider.

A valid string.
123456789012345678901

This function only returns metadata.