An array of JSON objects containing at least one unique Custom Button object (below).
|||customButtons||JSON array||A JSON array of Custom Button objects (defined below). This array must include at least a single button object.|
Custom Button Object
A JSON-encoded object representing a single unique custom button.
Any unique user account can only be connected to a single custom SAML IdP or OIDC OP. Once connected, the user will not be able to use a different SAML/OIDC provider if they exist. However, a user can be associated with both a SAML IdP and an OIDC OP concurrently.
|||providerName||string||The provider name to display in the login popup window (button title) and to remember as the last login name.|
|||iconURL||string||The URL of the icon to display on the button (the icon will be re-sized to fit the selected size).|
The name of the IdP or OP as defined within the Gigya console SAML Login or OIDC Login configuration.
In this SAML example:
The idpName is:
In this OIDC example:
The opName is:
When using SAML this must be idpName and when using OIDC this must be opName.
|||lastLoginIconURL||string||The URL of the icon to display on the button when this provider was the last one used for login.|
|||type||string||Can be either openID, oidc, saml or eventOnly. The default value is eventOnly, which means that only an onButtonClicked Event will be fired. When using a SAML Login or OTP IdP, type must be saml. When using OIDC Login, type must be oidc.|
|||position||integer||The index of the button within the Social Login widget. The regular provider buttons should be organized to fill the gaps between custom buttons. The default is 1 (top-left position) for the first button, and remaining buttons will appear in the order they are defined within the array, unless otherwise specified.|
|||logoURL||string||The URL of the icon to display in the login dialog.|
|||openIDURL||string||A URL template representing an OpenID user where $USERNAME$ represents the placeholder for the username. For example:. When this parameter is provided it should be passed on to the server login call. Required if type='openID'.|
Related Plugin Events
onButtonClicked Event Data
In the event that a user clicks a customButton, the button field is returned as a field of the onButtonClicked event.
|eventName||string||The name of the event.|
|source||string||The source plugin that generated this event. The value of this field is the name of the plugin's API method, e.g., 'showLoginUI', 'showCommentsUI', etc.|
|context||object||The context object passed by the application as parameter to the API method, or null if no context object has been passed.|
|button||customButton object||An object representing the custom button that has been clicked within the UI. If the clicked button is not a custom button, no customButton object will be returned.|