Child pages
  • WHM API 1 Functions - set_provider_client_configurations

Versions Compared

Key

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

 

Description

Excerpt

This function sets the values of configuration fields for an external authentication identity provider.

Panel
bgColor#F2F2F2
borderStylenone

Examples 


Panel
bgColor#FFFFFF
borderStylenone
Expand
titleJSON API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/json-api/set_provider_client_configurations?api.version=1&provider_id=cpanelid&service_name=cpaneld&configurations=%7B%22client_id%22%3A%22victoria%22%2C%22client_secret%22%3A%22secret%22%7D
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/set_provider_client_configurations?api.version=1&provider_id=cpanelid&service_name=cpaneld&configurations=%7B%22client_id%22%3A%22victoria%22%2C%22client_secret%22%3A%22secret%22%7D
Expand
titleCommand Line
Code Block
languagebash
whmapi1 set_provider_client_configurations provider_id=cpanelid service_name=cpaneld configurations=%7B%22client_id%22%3A%22victoria%22%2C%22client_secret%22%3A%22secret%22%7D

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{
 "metadata": {
    "version": 1,
    "reason": "OK",
    "result": 1,
    "command": "set_provider_client_configurations"
  }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data/>
    <metadata>
        <version>1</version>
        <reason>OK</reason>
        <result>1</result>
        <command>set_provider_client_configurations</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
configurationshash

Required

The configuration values to set for the identity provider.

A JSON-formatted set of values.

Note
titleNote:

The items within the configurations hashes depend on the fields that the provider implements through OpenID.

Expand
titleClick to view...

{"client_id":"victoria","client_secret":"secret"}


Returns

This function only returns metadata.