customButtons Object Description Template

Skip to end of metadata
Go to start of metadata

This parameter is used to add multiple customButton objects to the Gigya Social Login widget either directly or when using Screen-Sets. You can use customButton objects to add custom login options for any combination of OpenID Connect and/or SAML providers. See Adding a Custom OpenID Provider and Adding a SAML Login Provider, respectively.

 Expand a code example
customButtons= [
    {   // customButton object #1
        "type": "saml",
        "providerName":"Gateway One",
        "idpName":"testIdp-gig01",
        "iconURL": "//developers.gigya.com/download/attachments/15795144/IDP.png",
        "logoURL": "",
        "lastLoginIconURL":"//developers.gigya.com/download/attachments/15795144/IDP.png",
        "position":"3"
    },
    {   // customButton object #2
        "type": "saml",
        "providerName":"Gateway Two",
        "idpName":"testIdp-gig02",
        "iconURL": "//developers.gigya.com/download/attachments/15795144/IDP.png",
        "logoURL": "",
        "lastLoginIconURL":"//developers.gigya.com/download/attachments/15795144/IDP.png",
        "position":"4"
    },
    {   // customButton object #3 - IMPORTANT: openID Only works in showLoginUI version 1!
        "type": "openID",
        "providerName":"Flickr",
        "iconURL": "https://s3.amazonaws.com/wikifiles.gigya.com/images/flickr.png",
        "logoURL": "https://s3.amazonaws.com/wikifiles.gigya.com/images/flickr_large.png",
        "lastLoginIconURL":"https://s3.amazonaws.com/wikifiles.gigya.com/images/flickr.png",
        "position":"5",
        "openIDURL": "https://me.yahoo.com/$USERNAME$"
    },
	{   // customButton object #4 - IMPORTANT: oidc Only works in showLoginUI version 2!
        "type": "oidc",
        "providerName":"Gateway Four",
        "opName":"testOIDC-gig04",
        "iconURL": "http://developers.gigya.com/download/attachments/15795144/IDP.png",
        "logoURL": "",
        "lastLoginIconURL":"//developers.gigya.com/download/attachments/15795144/IDP.png",
        "position":"6"
    }
];
gigya.accounts.showScreenSet({screenSet:'Default-RegistrationLogin',customButtons})

It is important to note that any unique user can only be connected to a single SAML or OIDC provider (though they may be connected to one of each). If using showLoginUI version 1 to support OpenID, you can only pass a single customButtonsobject within the customButtons array, additional objects are ignored.

When using a customButtons array with showAddConnectionsUI, you should only include a single button object in the array. If you include multiple custom button objects, only the first button defined will be displayed in the UI.

  • No labels