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

 

Description

This function enables an external authentication identity provider for a specified service.

Examples 


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


Notes:

  • 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. 

 Output (JSON)
{
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "enable_authentication_provider"
  }
}
 Output (XML)
<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>enable_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.