Child pages
  • WHM API 1 Functions - enable_authentication_provider

Versions Compared

Key

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

 

Description

Excerpt

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

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/enable_authentication_provider?api.version=1&provider_id=cpanelid&service_name=cpaneld
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/enable_authentication_provider?api.version=1&provider_key=cpanelid&service_name=cpaneld
Expand
titleCommand Line
Code Block
languagebash
whmapi1 enable_authentication_provider provider_id=cpanelid service_name=cpaneld

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

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

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

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.