Description

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

Examples


/json-api/unlink_user_authn_provider?api.version=1&username=example&provider_id=facebook&service_name=cpaneld&subject_unique_identifier=123456789012345678901
/xml-api/unlink_user_authn_provider?api.version=1&username=example&provider_id=facebook&service_name=cpaneld&subject_unique_identifier=123456789012345678901
whmapi1 unlink_user_authn_provider username=example provider_id=facebook service_name=cpaneld subject_unique_identifier=123456789012345678901

{
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": "1",
    "command": "unlink_user_authn_provider"
  }
}
<result>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>unlink_user_authn_provider</command>
    </metadata>
</result>

   

Parameters

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

 

Returns

This function only returns metadata.