{
  "schema_version": 2,
  "id": "operate/rc/security/access-control/saml-sso/saml-integration-auth0",
  "title": "Auth0 SAML integration guide",
  "url": "https://redis.io/docs/latest/operate/rc/security/access-control/saml-sso/saml-integration-auth0/",
  "summary": "This integration guide shows how to configure Auth0 as a SAML single sign on provider for your Redis Cloud account.",
  "tags": [
    "docs",
    "operate",
    "rc"
  ],
  "last_updated": "2026-10-01T14:41:30+01:00",
  "page_type": "content",
  "content_hash": "a04bad58e239f27a3b59df4e3efda3d09b7557b2f626b0ce1bff76d5d8912167",
  "sections": [
    {
      "id": "overview",
      "title": "Overview",
      "role": "overview",
      "text": "This guide shows how to configure [Auth0](https://auth0.com/docs) as a SAML single sign-on identity provider (IdP) for your Redis Cloud account.\n\nTo learn more about Redis Cloud support for SAML, see [SAML single sign-on](https://redis.io/docs/latest/operate/rc/security/access-control/saml-sso).\n\nBefore completing this guide, you must [verify ownership of any domains](https://redis.io/docs/latest/operate/rc/security/access-control/saml-sso#verify-domain) you want to associate with your SAML setup."
    },
    {
      "id": "step-1-set-up-your-identity-provider-idp",
      "title": "Step 1: Set up your identity provider (IdP)",
      "role": "content",
      "text": ""
    },
    {
      "id": "specify-the-saml-owner",
      "title": "Specify the SAML owner",
      "role": "content",
      "text": "1. Sign in to your Auth0 account and navigate to **User Management > Users**.\n   * Select the SAML owner.\n   * Verify the details.\n\n    SAML assertion requires first and last name, which are not available in the default user profile. \n\n    > [!NOTE]\n    > Depending how they are created, users can have different profiles. \n    >\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_1.png)\n\n1. Add `user_metadata` to fulfill the SAML assertion, then select **Save**. \n   \n   ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_2.png)\n\n   The key-value pair of `redisAccountMapping` consists of a lowercase role name (owner, member, manager, billing_admin, or viewer) and your Redis Cloud Account ID found in the [account settings](https://redis.io/docs/latest/operate/rc/accounts/account-settings).\n\n    [code example]\n\n1. Open **Actions > Triggers** and select **`post-login`**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_3.png)\n\n1. Select **Create Action** to create a new custom action.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_add-action.png)\n\n1. Provide a **name** for the action and select **Create**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_create-action.png)\n\n1. Add the following code to the action:\n\n    [code example]\n\n1. Select **Deploy** to save and deploy the action.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_4.png)\n\n1. Return to the **`post-login`** trigger and drag the action you just created to the trigger.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_action-trigger.png)\n\n    Select **Apply** to save your changes."
    },
    {
      "id": "create-and-configure-the-saml-application",
      "title": "Create and configure the SAML application",
      "role": "content",
      "text": "1. Open **Applications > Applications** and select **Create Application**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_5.png)\n\n1. Provide a **name** for the Application and select **Single Page Web Applications**. Select **Create**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_6.png)\n\n1. From the newly created application, go to **Settings > Advanced Settings > Certificates**.\n\n    * Copy and save the **Signing Certificate**. You will need this information to configure SAML in admin console.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_7.png)\n\n    * We suggest that you update the default logo of the application to the Redis icon for better visibility. \n\n1. From the newly created application, go to **Addons** and enable **SAML 2 WEB APP**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_8.png)\n\n1. From the **Usage** tab:\n\n    * Copy and save the **Issuer** value.\n    * Copy and save the **Identity Provider Login URL**.\n    \n    You will need both of these values, along with the certificate value you copied in the previous step, to configure SAML in the Redis Cloud console.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_9.png)"
    },
    {
      "id": "step-2-configure-saml-support-in-redis-cloud",
      "title": "Step 2: Configure SAML support in Redis Cloud",
      "role": "content",
      "text": "Now that you have you Auth0 IdP server ready, configure support for SAML in Redis Cloud."
    },
    {
      "id": "sign-in-to-redis-cloud",
      "title": "Sign in to Redis Cloud",
      "role": "content",
      "text": "Sign in to your account on the [Redis Cloud console](https://cloud.redis.io/#/login)."
    },
    {
      "id": "activate-saml-in-access-management",
      "title": "Activate SAML in Access Management",
      "role": "content",
      "text": "To activate SAML, you need to have a local user (or social sign-on user) with the **owner** role. If you have the correct permissions, you will see the **Single Sign-On** tab.\n\n1. Fill in the information you saved previously in the **setup** form. This includes:\n\n    * **Issuer (IdP Entity ID)**: Issuer value from Auth0\n    * **IdP server URL**: Identity Provider Login URL from Auth0\n    * **Assertion signing certificate**: Certificate value from Auth0\n\n    ![](https://redis.io/docs/latest/images/rc/saml/sm_saml_1.png)\n\n    Once you click **Enable**, wait a few seconds for the status to change.\n\n1. Download the service provider (SP) metadata. Save the file to your local hard disk.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/sm_saml_3.png)\n\n1. Open the file in any text editor. Save the following text from the metadata:\n\n    * **EntityID**: The unique name of the service provider (SP)\n\n    ![](https://redis.io/docs/latest/images/rc/saml/sm_saml_4.png)\n\n    * **Location** : The location of the assertion consumer service\n\n    ![](https://redis.io/docs/latest/images/rc/saml/sm_saml_5.png)"
    },
    {
      "id": "step-3-finish-saml-configuration-in-auth0",
      "title": "Step 3: Finish SAML configuration in Auth0",
      "role": "content",
      "text": "1. Return to the Auth0 SAML application and select **Addons > SAML 2 Web App > Settings**:\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_10.png)\n\n    * Paste the **Location** link in **Application Callback URL** field.\n\n    * Enter the following code in the **Settings** code area. Modify the `audience` variable with the `EntityID` value, and the `recipient` variable with the `Location` value from the metadata file you downloaded. \n\n    [code example]\n    Scroll down and select **Enable** to apply the configuration."
    },
    {
      "id": "idp-initiated-sso",
      "title": "IdP initiated SSO",
      "role": "content",
      "text": "To use IdP-initiated SSO with certain identity providers, you also need to set the `RelayState` parameter to this URL: \n\n`https://cloud.redis.io/#/login/?idpId=<ID>`\n\n> [!NOTE]\n> Replace `ID` so it matches the `AssertionConsumerService` Location URL ID (the content after the last forward slash \"/\"). To learn more about how to configure service provider apps, see your identity provider’s documentation."
    },
    {
      "id": "step-4-return-to-the-redis-cloud-console",
      "title": "Step 4: Return to the Redis Cloud console",
      "role": "content",
      "text": "1. Return to the Redis Cloud console and select **Activate**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/sm_saml_8.png)\n\n   A popup appears, explaining that, in order to test the SAML connection, we need to login with credentials of a user defined in Auth0. Select **Continue** to go to the Auth0 login screen.\n\n1. The Auth0 login screen appears. Enter the credentials and select **Sign In**.\n\n    ![](https://redis.io/docs/latest/images/rc/saml/auth0_saml_12.png)\n\nIf everything is configured correctly, you will see the the Redis Cloud console screen. Your local account is now considered a SAML account. \n\nTo log in to the Redis Cloud console from now on, click on **Sign in with SSO**.\n\n![Sign in with SSO button](https://redis.io/docs/latest/images/rc/button-sign-in-sso.png)"
    }
  ],
  "examples": [
    {
      "id": "specify-the-saml-owner-ex0",
      "language": "json",
      "code": "{\n       \"FirstName\": \"Test\",\n       \"LastName\": \"User\",\n       \"redisAccountMapping\": \"YOUR_REDIS_CLOUD_ID=owner\"\n    }",
      "section_id": "specify-the-saml-owner"
    },
    {
      "id": "specify-the-saml-owner-ex1",
      "language": "js",
      "code": "exports.onExecutePostLogin = async (event, api) => {\n        const um = event.user.user_metadata || {};\n        const am = event.user.app_metadata || {};\n        api.samlResponse.setAttribute('email', event.user.email);\n        api.samlResponse.setAttribute(\n            'firstName',\n            um.FirstName || ''\n        );\n        api.samlResponse.setAttribute(\n            'lastName',\n            um.LastName || ''\n        );\n        const mapping = am.redisAccountMapping || um.redisAccountMapping;\n        if (mapping) {\n            api.samlResponse.setAttribute('redisAccountMapping', mapping);\n        } else {\n            api.access.deny('missing_redis_account_mapping', 'redisAccountMapping not set for user');\n        }\n    };",
      "section_id": "specify-the-saml-owner"
    },
    {
      "id": "step-3-finish-saml-configuration-in-auth0-ex0",
      "language": "json",
      "code": "{\n      \"audience\": \"<EntityID>\",\n      \"recipient\": \"<Location>\",\n      \"passthroughClaimsWithNoMapping\": false,\n      \"nameIdentifierProbes\": [\n        \"http://schemas.xmlsoap.org/ws/2005/05/identity/claims/emailaddress\"\n      ]\n    }",
      "section_id": "step-3-finish-saml-configuration-in-auth0"
    }
  ]
}