Auth0

The User Manual has moved! For the most up-to-date information, please visit our new site at docs.antavo.com.
We're committed to providing you with the best resources, and our new site offers an enhanced experience with the latest documentation. Thank you for your understanding and continued support.

Auth0 is a cloud-based identity management platform that provides secure authentication and authorization solutions. In Antavo, Auth0 serves as an SSO provider, allowing users who are already authenticated in other systems to access the loyalty management platform without re-entering their credentials.

Establishing the connection

Prerequisite
The Keycloak extension is required to use Auth0 and needs to be configured where the list of users to be authenticated needs to be added. For Keycloak configuration details, please refer to their documentation site.

The next step is to establish the connection between the Antavo platform and the Auth0 server through the configuration of the Auth0 module in the Backoffice. Find the configuration page of the SSO module by clicking on the icon in the sidebar and typing ‘Auth0' into the search bar of the Modules menu. The page will open up to the content of the 'Settings’ tab.

Settings

Authentication

  • Domain (required)
    There are two options to set up the domain:

    1. CNAME record
      CNAME is used to alias one domain name to another, allowing you to create a custom domain name that points to an existing domain or hostname. Read more about custom domains here.

    2. Default Auth0 Domain
      This entry points to the default Auth0 domain directly without setting up a custom CNAME record.

  • Client ID (required)
    The unique identifier for your application. This ID is generated by the Auth0 system when you create a new application and cannot be modified.
    To reach the client ID, follow these steps:

    • Click the ‘Applications’ menu on the left side

    • Go to the ‘Settings’ tab

    • Find the ID under the ‘Basic information’ section.

  • Client Secret
    A string used to sign and validate ID Tokens for authentication flows and to gain access to select Auth0 API endpoints.
    To reach the client secret, follow these steps:

    • Click the ‘Applications’ menu on the left side

    • Go to the ‘Settings’ tab

    • Find the secret under the ‘Basic information’ section.
      By default, the value is hidden, so check the Reveal Client Secret box to see it. While the Client ID is considered public information, the Client Secret must be kept confidential.

  • Certificate
    Enter here the certificate to sign that is requested by the identity provider. Read more about signing keys here.

User authentication

  • Platform auth enabled
    With this checkbox is off, you can only authenticate through an SSO login.
    When enabled, you can log in to the platform by using the password stored in our system. If you already have an account with Antavo (because of SSO), then for the first time, please use the 'Forgot password' feature to get a password.

  • Auth connection type
    For now, Antavo supports the SAML protocol.

  • Auth connection
    Enter here the rhe realm that is configured in Keycloak.

Logs

Under the ‘Logs’ tab, you can find information related to the authentication and authorization processes for monitoring and possible troubleshooting purposes.

The table contains the following columns:

  • Date

  • Request

  • Response

  • Success or error marks

 

© Copyright 2022 Antavo Ltd.