> For the complete documentation index, see [llms.txt](https://docs.catalyx.solutions/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional/auth0-setup-guide.md).

# Auth0 Setup Guide

## Configuring Auth0 for CatalyX

### 1. CatalyX API (Resource Server)

Navigate to **Applications → APIs → Create API** and configure:

* **Name:** CatalyX
* **Identifier (Audience):** `<audience>`

### 2. UI Client

Create a new application with type **Single Page Application** and configure:

* **Grant types:** Authorization Code, Refresh Token
* **Allowed Callback URLs:** `<UI url>`, `<UI url>/domains`, `<UI url>/participants`
* **Allowed Logout URLs:** same three URLs as above

The UI client requests the `<audience>` on login.

### 3. API Client

Create a new application with type **Regular Web Application** and configure:

* **Grant types:** Client Credentials, Authorization Code, Refresh Token

### 4. Connect Both Clients to the CatalyX API

Go to **APIs → CatalyX → Machine to Machine Applications**, enable both the UI and API clients, and grant their respective scopes.

| Client | Application Type        | Grant Types                                           | Has Client Secret |
| ------ | ----------------------- | ----------------------------------------------------- | ----------------- |
| UI     | Single Page Application | Authorization Code; Refresh Token                     | No                |
| API    | Regular Web Application | Client Credentials; Authorization Code; Refresh Token | Yes               |

### Example Helm Value Overrides

{% code title="helm-values.yaml" %}

```yaml
api:
  extraEnv:
    AUTH_ROLES: "false"
    AUTH_AUDIENCE: "<audience>" # Comes from identifier of Auth0 API

ui:
  extraEnv:
    AUTH_ROLES: "false"
    AUTH_AUDIENCE: "<audience>" # Comes from identifier of Auth0 API

auth:
  enabled: true
  keycloak:
    enabled: false
  url: "https://dev-2bsf8p5hbjadzwh4.us.auth0.com/" # Example URL
  client:
    idApiOperator: "<API Client ID>"
    idUI: "<UI client ID>"
    secret: "<API secret>"
```

{% endcode %}

{% hint style="info" %}
`AUTH_ROLES` must be set to the same value under both `api.extraEnv` and `ui.extraEnv` — see [Role-Based Access Control (RBAC)](/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/prerequisites.md#role-based-access-control-rbac) for what `canton_viewer`/`canton_writer` enforcement does when this flag is `"true"`.
{% endhint %}

## Configuring Auth0 for Validator

To configure Auth0 resources for a validator, follow the [Kubernetes Validator Deployment](https://docs.canton.network) guide. Resources should be created under the CatalyX API.

{% hint style="info" %}
Callback URLs and Logout URLs can be added after CatalyX deploys Wallet and CNS resources and generates the URLs.
{% endhint %}


---

# 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.catalyx.solutions/catalyx-blockchain-manager/canton-network/version-1.11/installation-instructions-canton/external-identity-provider-configuration-optional/auth0-setup-guide.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.