Developer Documentation
Child pages
  • WHM API 1 Functions - disable_authentication_provider
Skip to end of metadata
Go to start of metadata

 

Guide to WHM API 1

Return Data

Filter Output

Sort Output

Paginate Output

Output Columns

Call cPanel API 2 and UAPI

 

 

Description

This function disables a external authentication identity provider for a specified service.

Examples 

 JSON API
https://hostname.example.com:2087/cpsess##########/json-api/disable_authentication_provider?api.version=1&provider_id=cpanelid&service_name=cpaneld
 XML API
https://hostname.example.com:2087/cpsess##########/xml-api/disable_authentication_provider?api.version=1&provider_id=cpanelid&service_name=cpaneld
 Command Line
whmapi1 disable_authentication_provider provider_id=cpanelid service_name=cpaneld


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


Note:

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

   

Parameters

ParameterTypeDescriptionPossible valuesExample
service_namestring

Required

The cPanel & WHM service's name.

A valid service name:

    • cpaneld
    • whostmgrd
    • webmaild
cpaneld
provider_idstring

Required

The identity provider's key.

A valid identity provider's key.

cpanelid


Returns

This function only returns metadata.

 

 

Function information

API Version:

WHM API 1

Available in:

WHM 54+

Methods:

GET, POST

Required Parameters:

provider_id, service_name

Return Formats:

JSON, XML

Important:

cPanel & WHM version 66 deprecated XML output.

About WHM API 1

WHM API 1 performs functions and accesses data in WHM.

Notes:

  • Some functions and parameters may require that you authenticate as the root user.
  • You must use the appropriate WHM ports (2086 or 2087) to call WHM API functions.
  

Find a function

Related functions