Child pages
  • WHM API 1 Functions - get_provider_display_configurations

Versions Compared

Key

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

 

Description

Excerpt

This function retrieves the display configuration for the login button of 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/get_provider_display_configurations?api.version=1&provider_id=google
Expand
titleXML API
Code Block
languagexml
https://hostname.example.com:2087/cpsess##########/xml-api/get_provider_display_configurations?api.version=1&provider_id=google
Expand
titleCommand Line
Code Block
languagebash
whmapi1 get_provider_display_configurations provider_id=google

Include Page
LIB:_WHMAPI1CLINote
LIB:_WHMAPI1CLINote

Expand
titleOutput (JSON)
Code Block
languagetext
linenumberstrue
{  
   "metadata":{  
      "reason":"OK",
      "version":1,
      "result":1,
      "command":"get_provider_display_configurations"
   },
   "data":{  
      "configurations":[  
         {  
            "documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect",
            "service":"cpaneld",
            "provider_name":"google",
            "icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=",
            "icon_type":"image/svg+xml",
            "display_name":"Gooble",
            "color":"dd4b39",
            "textcolor":"FF0000",
            "link":"https://hostname.example.com:2083/openid_connect/google",
            "label":"Log in via Google"
         },
         {  
            "color":"dd4b39",
            "link":"https://hostname.example.com:2096/openid_connect/google",
            "textcolor":"FFFFFF",
            "label":"Log in via Google",
            "display_name":"Google",
            "icon_type":"image/svg+xml",
            "icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=",
            "documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect",
            "service":"webmaild",
            "provider_name":"google"
         },
         {  
            "documentation_url":"https://developers.google.com/identity/protocols/OpenIDConnect",
            "provider_name":"google",
            "service":"whostmgrd",
            "icon":"PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=",
            "icon_type":"image/svg+xml",
            "display_name":"Google",
            "color":"dd4b39",
            "link":"https://hostname.example.com:2087/openid_connect/google",
            "label":"Log in via Google",
            "textcolor":"FFFFFF"
         }
      ]
   }
}
Expand
titleOutput (XML)
Code Block
languagetext
linenumberstrue
<result>
    <data>
        <configurations>
            <color>dd4b39</color>
            <display_name>gooble</display_name>
            <documentation_url>https://developers.google.com/identity/protocols/OpenIDConnect</documentation_url>
            <icon>PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=</icon>
            <icon_type>image/svg+xml</icon_type>
            <label>Log in via Google</label>
            <link>https://hostname.example.com:2083/openid_connect/google</link>
            <provider_name>google</provider_name>
            <textcolor>FF0000</textcolor>
        </configurations>
        <configurations>
            <color>dd4b39</color>
            <display_name>Google</display_name>
            <documentation_url>https://developers.google.com/identity/protocols/OpenIDConnect</documentation_url>
            <icon>PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=</icon>
            <icon_type>image/svg+xml</icon_type>
            <label>Log in via Google</label>
            <link>https://hostname.example.com:2096/openid_connect/google</link>
            <provider_name>google</provider_name>
            <textcolor>FFFFFF</textcolor>
        </configurations>
        <configurations>
            <color>dd4b39</color>
            <display_name>Google</display_name>
            <documentation_url>https://developers.google.com/identity/protocols/OpenIDConnect</documentation_url>
            <icon>PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyMiIgaGVpZ2h0PSIxNCIgdmlld0JveD0iMCAwIDIyIDE0Ij48ZyBmaWxsPSIjZmZmIiBmaWxsLXJ1bGU9ImV2ZW5vZGQiPjxwYXRoIGQ9Ik03IDZ2Mi40aDMuOTdjLS4xNiAxLjAzLTEuMiAzLjAyLTMuOTcgMy4wMi0yLjM5IDAtNC4zNC0xLjk4LTQuMzQtNC40MlM0LjYxIDIuNTggNyAyLjU4YzEuMzYgMCAyLjI3LjU4IDIuNzkgMS4wOGwxLjktMS44M0MxMC40Ny42OSA4Ljg5IDAgNyAwIDMuMTMgMCAwIDMuMTMgMCA3czMuMTMgNyA3IDdjNC4wNCAwIDYuNzItMi44NCA2LjcyLTYuODQgMC0uNDYtLjA1LS44MS0uMTEtMS4xNkg3ek0yMiA2aC0yVjRoLTJ2MmgtMnYyaDJ2MmgyVjhoMiIvPjwvZz48L3N2Zz4=</icon>
            <icon_type>image/svg+xml</icon_type>
            <label>Log in via Google</label>
            <link>https://hostname.example.com:2087/openid_connect/google</link>
            <provider_name>google</provider_name>
            <textcolor>FFFFFF</textcolor>
        </configurations>
    </data>
    <metadata>
        <command>get_provider_display_configurations</command>
        <reason>OK</reason>
        <result>1</result>
        <version>1</version>
    </metadata>
</result>

Include Page
LIB:_WHMAPIShellNote
LIB:_WHMAPIShellNote

   

Parameters

ParameterTypeDescriptionPossible valuesExample
provider_idstring

Required

The identity provider's key.

A valid identity provider's key.

google


Returns

ReturnTypeDescriptionPossible valuesExample
configurationsarray of hashesThis array of hashes contains information about each service's external authentication display information.This array of hashes includes the link, label, documentation_url, icon, provider_name, color, display_name, service, icon_type, and textcolor returns. 

icon_type

string

The icon file's MIME type.

The function returns this value in the configurations name hash.

A valid image format's MIME type.image/svg+xml

label

string

The text label in the button that the cPanel login interface displays.

The function returns this value in the configurations name hash.

A valid string.Log in via Google

icon

string

The icon file in the button that the cPanel login interface displays.

The function returns this value in the configurations name hash.

A valid Base64-encoded, JPG or PNG-formatted image file.
Expand
titleClick to view...

iVBORw0KGgoAAAANSUhEUgAAACEAAAAhCAYAAABX5MJvAAAAGXRFWHRTb2Z0d2FyZQBBZG9iZSBJbWFnZVJlYWR5ccllPAAAAV1JREFUeNrsVtGNwjAMJegGYIRucBmhtwEjdAMyQjYoG2SEG6HcBGUDugFskHOQg1zTlFaN\/\/KkqMh2yYvt53S3KygomIZaE+y9P8BDJ9xXpdSDxT9jwX7dxDJsDMvCuvl33GF1sBwS5O8GX7eVgCabGyRkGJF25v0sJHrcyDH7iMhWEl9zWSD1\/xs1klJn8J\/gZ4WxNdgu8KyiDXGIfmJ7LO6R8CI5rJnwO+Kv0Wb9Z7xlZr+wMt8f\/ANmyCoCMF3CUmP8rOmHip1AM\/8tdbLcjfnL5NigYmIp+ilp5iYRJNkmajtLIBuJiUZ1S+aDKGDjI8tGk+N\/9yuy0ODcGIjL8UEmcXKLDelRDQ5tHcuIkSLQE1WYhIRfMRIEmiV1Z7NES5Rh9nIisRGVWGOyyyflC5fSkDsTmk1KnVBMbForqQw+IVtUCP3KEpdojffHnRGKcq3LZ3pBgST+BRgANXt+WPKE7tYAAAAASUVORK5CYII=

color

string

The background color of the button in the cPanel interface.

The function returns this value in the configurations name hash.

A valid RGB hexadecimal color value.dd4b39

provider_name

string

The name of the identity provider.

The function returns this value in the configurations name hash.

A valid string.google

display_name

string

The display name of the identity provider.

The function returns this value in the configurations name hash.

A valid string.Google

service

string

The service's name.

The function returns this value in the configurations name hash.

A valid service name:

  • cpaneld
  • whostmgrd
  • webmail
cpaneld

textcolor

string

The color of the text label in the button that the cPanel login interface displays.

The function returns this value in the configurations name hash.

A valid RGB hexadecimal color value.FF9999

documentation_url

string

The URL to the identity provider's documentation.

The function returns this value in the configurations name hash.

A valid URL.
https://developers.google.com/identity/protocols/OpenIDConnect

link

string

A link to the identity provider's configuration for the system.

The function returns this value in the configurations name hash.

A valid URL.https://hostname.example.com:2083/openid_connect/google