commercetools ID SSO Plugin

commercetools sso-ui-kit Gatsby plugin

It's a gatsby theme plugin offering commercetools ID SSO ui elements such as login and logout buttons or avatar (account box) component. The plugin interacts with auth0 authentication provider and therefore needs to be initialised with auth0 specific parameters.

commercetools ID logo

Configuration

gatsby-theme-sso-ui-kit plugin expects 3 parameters:

auth0Domain: the auth0 application domain url (it is defined in the auth0 management app)
auth0ClientId: the auth0 application client id (it is defined in the auth0 management app)
learnApiBaseUrl: the learn API base url. It can be omitted if the host running the site matches the api host. Often needs to be a conditional value for prod vs. preview to use the respective (sub)domain scope for cookies.

You can also add the optional hideLogin parameter if you don't want the login information to be visible in the top bar.

In order to enable the plugin, the following configuration should be added to the gatsby-config.js plugin section:

const isProd = process.env.NODE_ENV === 'production';
{
    resolve: '@commercetools-docs/gatsby-theme-sso-ui-kit',
    options: {
        auth0Domain: 'auth0domain.dummy.tld',
        auth0ClientId: 'cliendItString',
        learnApiBaseUrl: isProd ? 'https://learning-api.prod-domain.tld' : 'https://learning-api.preview-domain.tld',
        hideLogin: false,
    },
},

The plugin will be enabled only if both the above described configuration options are defined.