> For the complete documentation index, see [llms.txt](https://help.mimeeq.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://help.mimeeq.com/users-and-permissions/access-and-login/authentication.md).

# Authentication

Let customers log in to see private prices, saved configurations and their profile. Learn how to add the Mimeeq login code, login links and redirects.

This guide explains how to implement secure user authentication for your Mimeeq product configurators in the simplest way possible. By following these steps, you'll allow your customers to log in, access their private prices, saved (favourite) configurations, and manage their user profiles.

**Key benefits:**

* Secure access to your Mimeeq configurators
* Easy implementation with minimal technical knowledge
* Support for multiple languages
* Built-in password recovery functionality

***

## Getting your authentication code

The first step is to obtain your unique Mimeeq authentication code from your admin panel.

{% stepper %}
{% step %}

### Open the login code

1. Log in to your Mimeeq admin dashboard.
2. Navigate to **Settings** → **Customer settings**.
3. Click **Code** in the left sidebar.
4. Select **Login Code**.
   {% endstep %}

{% step %}

### Customise the settings (optional)

Before copying, you can:

* Select your preferred language from the dropdown.
* Choose theme options to match your website's design.
* Toggle **Use default page font** to let the login modal use your page font.
  {% endstep %}

{% step %}

### Copy the authentication code

1. You'll see an **Embed Code snippet** dialog.
2. Click **Copy Script** to copy the complete authentication code.

This code contains both your unique customer ID and the script that loads the authentication system.
{% endstep %}
{% endstepper %}

***

## Adding authentication to your website

{% stepper %}
{% step %}

### Add the authentication code to your website

1. Paste the complete authentication code (that you copied using **Copy Script**) into your website's HTML.
2. Place it in your page's HTML for best performance.
3. This code only needs to be added once per page where authentication will be used.

{% code collapsedlinecount="10" %}

```
<!-- Example of the complete authentication code -->
<mmq-auth short-code="{yourcode}" locale="en"></mmq-auth>
<script src="https://cdn.mimeeq.com/read_models/embed/app-embed.js" rel="script" type="application/javascript" async></script>
```

{% endcode %}
{% endstep %}

{% step %}

### Set up authentication URL links

The simplest way to enable login functionality is by creating links that add `?auth=mimeeq` to your website URL:

`https://your-domain.com/?auth=mimeeq`

When users click a link with this parameter, the login modal opens automatically without any additional HTML elements needed.

Create a login or **My Account** button or link on your website that adds this parameter to the URL. These links can be created from any button or element on your existing page:

`<a href="?auth=mimeeq">Login</a>`

Or for a specific page:

`<a href="https://your-domain.com/page?auth=mimeeq">My Account</a>`

**Common use cases:**

* Add a **Login** button in your navigation menu.
* Create **My Account** links in your website footer.
* Add login links on product pages.
  {% endstep %}
  {% endstepper %}

{% hint style="success" %}
Test the login process by clicking your authentication URL link and checking that the login modal appears and works correctly.
{% endhint %}

***

## Managing user authentication

One of the major benefits of the URL authentication method is that the same link handles both login and logout automatically. The table shows what users see after clicking the `?auth=mimeeq` link.

<table><thead><tr><th width="60">#</th><th>User state</th><th>What they see</th></tr></thead><tbody><tr><td>1</td><td>Not logged in</td><td>The login modal</td></tr><tr><td>2</td><td>Already logged in</td><td>A prompt with options to log out or cancel</td></tr></tbody></table>

This means you only need to implement a single **Account** or **Login** link on your website. The Mimeeq authentication system handles the user's state and shows the appropriate modal. In other words, no additional code is required to handle these different states.

***

## Language support

Mimeeq's authentication supports multiple languages:

1. The language is determined by the `locale` attribute in your authentication code (e.g. `locale="en"` for English).
2. To set or change the language, select your preferred language in the **Embed Code snippet** dialog in the admin panel before copying the code. The setting appears in the shortcode as `locale="en"`, where `en` is your selected language code.
3. The language you select affects all text in the authentication modals.

***

## Setting up the partner login redirect URL

When users sign up for the first time through the Mimeeq authentication system, you can automatically redirect them back to your website. This provides a seamless experience for your customers.

```mermaid
flowchart LR
    A[User signs up] --> B[Redirect to Partners Login Page URL] --> C["?auth=mimeeq opens login modal"]
```

1. In your Mimeeq admin panel, go to **Settings** → **Customer settings**.
2. Look for the **Partners Login Page** field.
3. Enter the URL of your website where users should be redirected after authentication.
4. Include the `?auth=mimeeq` parameter in this URL so the login modal opens automatically upon redirect.

When a user completes the authentication process, they are automatically redirected to this URL, which immediately opens the login modal thanks to the `?auth=mimeeq` parameter.

***

## Inviting users to your platform

You can invite users to register on your platform with Mimeeq authentication. For detailed instructions, see [Invite Partners](/users-and-permissions/users-and-contacts/invite-partners.md).

***

## Customising the login appearance

Before copying your authentication code, you can customise its appearance in the admin panel's **Embed Code snippet** dialog:

* **Button color override:** set the primary button colour.
* **Button text color override:** set the text colour on buttons.
* **Use default page font:** match your website's typography.

These settings are applied to all authentication-related elements on your site.

***

## Using authentication URLs effectively

The authentication URL approach (`?auth=mimeeq`) offers several advantages:

* **Simplicity:** no need for complex code or custom development.
* **Consistency:** the login experience is the same across your entire website.
* **Flexibility:** works with any website platform or content management system.
* **User experience:** a clean interface that doesn't disrupt your website design.

{% hint style="success" %}
**Best practices for authentication links**

* **Prominent placement:** add login links in your main navigation for easy access.
* **Clear labelling:** use text like "Login", "My Account" or "Sign In" for your links.
* **Consistent location:** place authentication links in the same location across your site.
* **Mobile friendly:** make sure authentication links are accessible on mobile devices.
  {% endhint %}

***

## Common questions

<details>

<summary>Where can I find my authentication code?</summary>

In your Mimeeq admin panel under **Settings** → **Customer settings** → **Code** → **Login Code**.

</details>

<details>

<summary>Do I need to add the authentication code to every page?</summary>

Yes, for the best experience you should add it to every page where users might click a login link. The code is lightweight and loads asynchronously, so it won't affect your page performance.

</details>

<details>

<summary>What happens after a user logs in?</summary>

Users can access their saved configurations and personalised features of your Mimeeq configurator.

</details>

<details>

<summary>How do I know if authentication is working properly?</summary>

Test the login process by clicking your authentication URL link and checking that the login modal appears and works correctly.

</details>

***

## For developers: programmatic authentication

If you have a developer on your team who needs more advanced implementation options, Mimeeq provides a comprehensive API for programmatic authentication:

* Custom login forms and interfaces
* Programmatic authentication flows
* User data access and management
* Custom authentication state handling
* Integration with existing user systems

For complete technical documentation on programmatic authentication methods, see <https://docs.mimeeq.com/auth-introduction>.

***

## Related articles

<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Invite Partners</strong></td><td>Invite client users to view prices and save favourites.</td><td><a href="/users-and-permissions/users-and-contacts/invite-partners.md">Invite Partners</a></td></tr><tr><td><strong>Restricted Access</strong></td><td>Limit configurators to selected company groups.</td><td><a href="/users-and-permissions/access-and-login/restricted-access.md">Restricted Access</a></td></tr></tbody></table>


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://help.mimeeq.com/users-and-permissions/access-and-login/authentication.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.