> For the complete documentation index, see [llms.txt](https://docs.flosum.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.flosum.com/global-settings/security/identity-providers-sso/oidc-identity-providers/auth0-oidc-configuration.md).

# Auth0 - OIDC - Configuration

{% hint style="success" %}

#### Required User Credentials

\[**Flosum User**] - **SystemAdministrator** Role
{% endhint %}

{% hint style="success" %}

#### Important Note

The instructions in this article cover a third-party app and may not reflect the latest version. Please use these instructions as a guide to complete the task, but be aware that some screens, field names, and steps may have changed.
{% endhint %}

## ![](https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2FSxcnKlaJKPzDqONWoDNv%2FSummary2-Small-Icon.svg?alt=media\&token=5e3253d0-a069-4ba5-9c06-83c70bd0b21d) Overview

This guide explains how to integrate Auth0 using OpenID Connect (OIDC) with Flosum Cloud Apps to enable Single Sign-On (SSO) for seamless login.

{% hint style="info" %}
For more general instructions about adding an Identity Provider, see the following article.

* [Adding an Identity Provider (SSO)](/global-settings/security/identity-providers-sso/adding-an-identity-provider-sso.md)
  {% endhint %}

{% hint style="warning" %}

#### Customer-Hosted

Customers who host Flosum Apps on their own infrastructure will have a custom URL for logging into their apps. When using this documentation, replace any **Flosum Hosted URLs** with your own URLs.
{% endhint %}

### Outline Of Steps Involved

* **Configure Auth0 App**
* **Add Callback URLs**
* **Create an Identity Provider with Flosum Global Settings**
* **Test the SSO**

## Configuring Auth0 for Flosum Cloud Apps

This section shows you how to configure an Auth0 Application to work with Flosum Cloud Apps for SSO.

{% hint style="warning" %}
Please note that the instructions for Auth0 Applications may not reflect the latest version. Some screens, field names, and steps might have changed.
{% endhint %}

{% stepper %}
{% step %}

### Configure Application in Auth0

1. Log in to your Auth0 account.
2. Click **Applications** in the left sidebar, then click **Applications**.

   <div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2FomnigYvY4E4F48xh3wxC%2FAuth0Setup-S01-01.png?alt=media&amp;token=b0027c85-595b-4fa5-8d08-52ce8d319c95" alt=""><figcaption></figcaption></figure></div>
3. Click **Default App** to open the Default App screen.

   <div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2F1MaPpR3sugGZcgddLZuh%2FAuth0Setup-S01-02.png?alt=media&amp;token=108cb236-47a9-47e9-ada0-fccdbc08c37b" alt="" width="545"><figcaption></figcaption></figure></div>
4. Copy the **Domain**, **Client ID**, and **Client Secret** values for creating an Identity Provider in Flosum Global Settings.
   {% endstep %}

{% step %}

### Add Callback URLs

1. Click the **Settings** tab.
2. In the **Allowed Callback URLs** field, add the URL of your region for each Flosum Cloud App you want to use with SSO. See the table below for the URLs for your region.

   <div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2FlUTgoT5hR3slZeLNU6LR%2FAuth0Setup-S01-03.png?alt=media&amp;token=b3abf8b5-c3f5-46ce-ba00-0734151f1c2b" alt=""><figcaption></figcaption></figure></div>

{% tabs %}
{% tab title="United States URLs" %}

<table><thead><tr><th width="180">Flosum Cloud App</th><th>Callback URL</th></tr></thead><tbody><tr><td>Global Settings</td><td>https://global-us.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>Backup &#x26; Archive</td><td>https://backup-us.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>DevOps</td><td>https://devops-us.flosum.app/api/v1/auth/login/open-id</td></tr></tbody></table>
{% endtab %}

{% tab title="Germany URLs" %}

<table><thead><tr><th width="180">Flosum Cloud App</th><th>Callback URL</th></tr></thead><tbody><tr><td>Global Settings</td><td>https://global-de.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>Backup &#x26; Archive</td><td>https://backup-de.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>DevOps</td><td>https://devops-de.flosum.app/api/v1/auth/login/open-id</td></tr></tbody></table>
{% endtab %}

{% tab title="Japan URLs" %}

<table><thead><tr><th width="180">Flosum Cloud App</th><th>Callback URL</th></tr></thead><tbody><tr><td>Global Settings</td><td>https://global-jp.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>Backup &#x26; Archive</td><td>https://backup-jp.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>DevOps</td><td>https://devops-jp.flosum.app/api/v1/auth/login/open-id</td></tr></tbody></table>
{% endtab %}

{% tab title="Australia URLs" %}

<table><thead><tr><th width="180">Flosum Cloud App</th><th>Callback URL</th></tr></thead><tbody><tr><td>Global Settings</td><td>https://global-au.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>Backup &#x26; Archive</td><td>https://backup-au.flosum.app/api/v1/auth/login/open-id</td></tr><tr><td>DevOps</td><td>https://devops-au.flosum.app/api/v1/auth/login/open-id</td></tr></tbody></table>
{% endtab %}
{% endtabs %}
{% endstep %}
{% endstepper %}

## Create Identity Provider In Global Settings

{% stepper %}
{% step %}

### Create Identity Provider in Global Settings

Follow the general instructions in the article below to get started creating an OIDC Identity Provider.

1. [Adding an Identity Provider (SSO)](/global-settings/security/identity-providers-sso/adding-an-identity-provider-sso.md)
2. Complete the **Basic information** section.
   1. Select **OPEN\_ID** for the identity provider **Type**.
3. Complete the **Button information** section.
4. (Optional) Complete the **Group information** section.

#### **Complete OpenId Information Fields**

Copy the information from your Auth0 application into the OpenId Information section. The table explains which Auth0 fields to enter into which Flosum Fields. The final screenshot shows a completed identity provider for an Auth0 OIDC application.

The Auth0 fields are found at: **Auth0 -> Default App -> Settings -> Basic Information**

| Flosum Field      | Auth0 Field             |
| ----------------- | ----------------------- |
| **Client ID**     | **Client ID**           |
| **Client Secret** | **Client Secret**       |
| **Issuer**        | `https://` + **Domain** |

<div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2FrmX0ZPRXgUouMlH6G1eR%2FAuth0Setup-CreateIdentityProvider-01.png?alt=media&amp;token=536005e8-3a36-4414-9e93-9d397c06278d" alt="" width="563"><figcaption></figcaption></figure></div>
{% endstep %}

{% step %}

### Save and Test

{% hint style="info" %}
For instructions on logging in with SSO, see the following article.

* [Logging In With SSO](/global-settings/security/identity-providers-sso/logging-in-with-sso.md)
  {% endhint %}

1. Click **Save** to save the identity provider.
2. To test, open an incognito window.
3. Start logging in to Global Settings with your tenant name.
4. If the identity provider was configured successfully, you should see the SSO button you created.&#x20;

<div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2Fy19T52NShfgsh5O0sKcn%2FAuth0Setup-CreateIdentityProvider-02.png?alt=media&amp;token=7c54c63e-6928-496e-96ed-7dd4704fa33c" alt="" width="375"><figcaption></figcaption></figure></div>

<div align="left"><figure><img src="https://579543750-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FsEk2hU5IMh3HEY5dJZjR%2Fuploads%2FToj56imIEMIUdhQZkJMB%2FAuth0Setup-S03-03.png?alt=media&amp;token=0b2c641c-fb7d-4147-9b72-53f25894bfb9" alt="" width="269"><figcaption></figcaption></figure></div>

{% hint style="info" %}
If, after entering your credentials, you encounter the error “**IdP attribute given\_name is undefined**”, add the following attributes to the user in your Auth0 account.

* `given_name`
* `family_name`
  {% endhint %}
  {% endstep %}
  {% endstepper %}

## Auth0 - Create User and Add Attributes

If you are receiving an error when attempting to log into Backup & Archive with your Auth0 credentials, you need to create a user and add the `given_name` and `family_name` attributes to that user.

{% stepper %}
{% step %}

### Create User and Add Attributes

{% hint style="info" %}
If you are an existing user, you can add attributes by skipping steps 1 and 2 in this section.
{% endhint %}

1. From your Auth0 account, click **User Management** in the left sidebar, then click **Users**.

   <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/jGieDyPNFSHI5mTiWUkx/rtaImage" alt=""><figcaption></figcaption></figure>
2. Click **Create User** and fill out the required fields.
3. Open your user and click the **Raw JSON** tab.&#x20;
4. Make a note of your **user\_id**, because you need it later in the process.

   <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/733VcyIwresF2GlGG5Ht/rtaImage" alt=""><figcaption></figcaption></figure>
5. Click **Application** in the left sidebar, then click **APIs**.

   <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/zudbVc7VcNN28LlnrcG8/rtaImage" alt=""><figcaption></figcaption></figure>
6. Click **Auth0 Management API**.
7. Click the **Test** tab.

   <div align="left"><figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/MqRFhBx8tw4NcsfDMs2D/rtaImage" alt="" width="563"><figcaption></figcaption></figure></div>
8. Click **Create & Authorize Test Application**.
9. Click the **API Explorer** tab and click **Create & Authorize Test Application**.
10. Make note of the **Token**, as you'll need it later in the process.

    <div align="left"><figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/vitukU0KDNwKgugdEdqs/rtaImage" alt="" width="563"><figcaption></figcaption></figure></div>
11. Click **Documentation** at the top-right of your screen to open [Auth0 Docs](https://auth0.com/docs).

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/WkNSHVe9dZGqDcGxgRKv/rtaImage" alt=""><figcaption></figcaption></figure>
12. Click **Auth0 APIs**.
13. Click **Management API Explorer** in the left sidebar.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/METFuADxEhqPQZY6rvs2/rtaImage" alt=""><figcaption></figcaption></figure>
14. Click **Users** in the left sidebar, then click **Update a user**.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/htpHtJF88mbqRNU90MtG/rtaImage" alt=""><figcaption></figcaption></figure>
15. Click **Set API Token** in the upper right of your screen, then paste the value of the previously saved token into the modal window for authorization.&#x20;
16. The Set API Token button should now read **Authorized**.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/Aujhq6QaCcZqLAKYHTFa/rtaImage" alt=""><figcaption></figcaption></figure>
17. Insert into **path: id** the user ID value you saved earlier, and delete all lines except **given\_name** and **family\_name**. Fill in the meaning of these lines as necessary.&#x20;
18. Click **Test Endpoint**.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/TQ9lbBsxdWVvT3hfuiy9/rtaImage" alt=""><figcaption></figcaption></figure>
19. You must receive a Response code **200**. If you do not receive a 200 response code, a message appears identifying the problem. Typical problems might be an incorrect token or user ID.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/e2vy1dwDF8gdq0zItUls/rtaImage" alt=""><figcaption></figcaption></figure>
20. Click **Users** in the left sidebar and click the **Raw JSON** tab. “**given\_name**” and “**family\_name**” should be added.

    <figure><img src="https://content.gitbook.com/content/sEk2hU5IMh3HEY5dJZjR/blobs/Pcr2053LShUl0OhKzAlf/rtaImage" alt=""><figcaption></figcaption></figure>
21. Return to Flosum Backup & Archive and log in.
    {% endstep %}
    {% endstepper %}


---

# 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 by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.flosum.com/global-settings/security/identity-providers-sso/oidc-identity-providers/auth0-oidc-configuration.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.