Skip to main content
LibreChat is joining ClickHouse to power the open-source Agentic Data Stack 🎉 Learn more
LibreChat

Auth0

Aprenda a configurar o LibreChat para usar o Auth0 para autenticação de usuários.

Passo 1: Criar um aplicativo SAML no Auth0

  1. Faça login no seu Auth0 Dashboard.
  2. Navegue até Applications > Applications.
  3. Clique em Create Application.
  4. Insira um Nome de Aplicativo (por exemplo, LibreChat) e selecione Regular Web Application.
  5. Clique em Create.

auth0-1

Passo 2: Configurar o Add-On SAML

  1. Abra o aplicativo recém-criado no Auth0.
  2. Vá para a aba Addons.
  3. Clique no controle deslizante para ativar o SAML2 Web App.
  4. Clique no painel SAML2 Web App.
  5. Configure as seguintes definições:
    • Application Callback URL: Defina isso como a sua URL de callback SAML do LibreChat: https://YOUR_DOMAIN/oauth/saml/callback
    • Configurações (Formato JSON): Use a seguinte configuração:
      {
          "mappings": {
              "email": "email",
              "name": "username"
          }
      }

      nota

      Se a sua aplicação exigir atributos adicionais como given_name, family_name, username ou picture, certifique-se de que esses mapeamentos estejam configurados corretamente nas configurações SAML do Auth0.

  6. Clique em Save.

auth0-2 auth0-3

Passo 3: Obtenha os metadados SAML do Auth0

  1. Assim que o SAML estiver ativado, volte para as configurações do SAML2 Web App.
  2. Vá para a aba Usage.
  3. Clique em Identity Provider Certificate: Download Atuh0 certificate.
  4. Use o Issuer para SAML_ISSUER
  5. Use a Identity Provider Login URL para SAML_ENTRY_POINT.
  6. Copie o arquivo de certificado baixado para a pasta do seu projeto

auth0-4

Passo 4: Configure o LibreChat com SAML

Abra o arquivo .env na pasta do seu projeto e adicione as seguintes variáveis:

SAML_ENTRY_POINT=https://dev-xxxxx.us.auth0.com/samlp/aaaaaa
SAML_ISSUER=urn:dev-xxxxx.us.auth0.com
SAML_CERT=dev-xxxxx.pem
SAML_CALLBACK_URL=/oauth/saml/callback
SAML_SESSION_SECRET=[JustGenerateARandomSessionSecret]

# Attribute mappings (optional)
SAML_EMAIL_CLAIM=
SAML_USERNAME_CLAIM=
SAML_GIVEN_NAME_CLAIM=
SAML_FAMILY_NAME_CLAIM=
SAML_PICTURE_CLAIM=
SAML_NAME_CLAIM=

# Logint buttion settings (optional)
SAML_BUTTON_LABEL=
SAML_IMAGE_URL=

# Whether the SAML Response should be signed.
# - If "true", the entire `SAML Response` will be signed.
# - If "false" or unset, only the `SAML Assertion` will be signed (default behavior).
# SAML_USE_AUTHN_RESPONSE_SIGNED=

Como está este guia?