Understand authentication | Zoho Creator Help

Understanding authentication


NotesThis help page is for users in Creator 6. If you are in the older version (Creator 5), click here. Know your Creator version.

Info
In a nutshell  
Portal authentication verifies the identity of a portal user before granting them access to a Zoho Creator portal. Zoho Creator offers multiple authentication methods such as default login, federated login, JWT token based login, and SAML login for portals. Once a portal user is authenticated using their credentials, Zoho Creator grants application access based on the user's assigned portal permissions. 
Idea
Availability
Default authentication is available in all plans of Creator while federated login and custom authentication are available only in the paid plans.
Only super admins and admins can configure and switch authentication types for customer portals. Other users can access the portal by logging in through the configured authentication method.

1. Overview 

Portal authentication is the process of verifying the identity of a portal user before granting access to a Creator portal application. It enables external users to securely access the portal without requiring a Zoho Creator account.
Depending on your organization's authentication requirements, portal users can authenticate either using credentials managed within Creator or through an external Identity Provider (IdP). Zoho Creator supports the following authentication methods for portal applications:
  1. Default authentication
  2. Custom authentication
You can select the appropriate authentication method to provide the required login experience, security, and identity management.

2. Default authentication

Zoho Creator offers two default authentication methods for portal users to sign in:

  1. Creator-managed authentication
  2. Federated login

While both methods can be enabled simultaneously for a portal, each portal user is tied to one method and cannot switch between them to sign in.

2.1 Creator-managed authentication

Portal users sign in using credentials managed and validated directly in Zoho Creator. The available Creator-managed authentication types for portals are:

  1. Email Address: Portal users can access the portal only through their registered email address.
  2. Mobile Number/Email Address: Portal users are given the flexibility to sign up or be added using either a mobile number or an email address. However, each user is linked to only one identifier, either an email address or a mobile number.
  3. Mobile Number: Portal users can access the portal only through their registered mobile number.
NotesNote: The following authentication types are only available for IN and US data centers for Indian mobile numbers (+91):
  1. Mobile Number/Email Address
  2. Mobile Number

They can be configured only when SMS templates are assigned to the portal.

Mobile-based portal users configuration flow

To enable mobile number sign-in for portal users, complete the following steps in order:

  1. Explore System Integrations and configure the Zoho Creator SMS integration.
  2. Purchase SMS credits to enable SMS delivery.
  3. Learn about SMS templates and configure SMS templates for each notification type.
  4. Learn about SMS notifications and configure SMS notifications by assigning templates to your portals.
  5. Learn about portal authentication types and configure your portal with mobile-based authentication.
  6. Learn about portal users and add portal users using their mobile number.

2.2 Federated login

The Federated login option allows portal users to sign in to your portal using an account they already hold with a supported external identity provider. Creator supports the following third-parties as identity providers:

  1. Google
  2. Facebook
  3. Apple
  4. LinkedIn

If your organization uses a different identity provider, you can configure custom authentication using SAML authentication.

When a portal user chooses this option on the sign-in page, Creator relies on identity verification to the selected provider. The provider authenticates the user and confirms their identity, after which access to the portal is granted based on the registered credentials.

Security note: When a portal user utilizes federated login to sign up with Creator, their password is never shared with or stored in Creator

Federated login is configured in addition to email and mobile credential login, giving portal users the flexibility to choose their preferred sign-in method. Since federated login verification happens through an existing account, they don't need to create or remember a separate password for the portal.

3. Custom authentication   

Custom authentication allows portal users to be authenticated through an external authentication system. The portal user's credentials, password policies, and authentication rules are managed within the required external Identity Provider(IdP). You can enable single sign-on (SSO) for multiple portal applications using an Identity Provider, allowing users to sign in once and access all the portals without signing in separately.

Once a user signs in through the IdP using the stored credentials, it sends a secure authentication response to Creator, which is used to grant access to the portal. Creator supports the following custom authentication methods:
  1.  SAML Authentication 
  2.  JWT Authentication 
Notes
Note:  Custom authentication allows you to integrate your own identity provider using SAML or JWT, whereas federated login supports built-in identity providers, such as Google, Microsoft, Apple or LinkedIn.

3.1. SAML authentication   

SAML (Security Assertion Markup Language) is an XML-based authentication standard that enables secure exchange of user identity information between an Identity Provider (IdP) and Zoho Creator portals. The Identity Provider authenticates the portal user and generates a digitally signed XML document called a SAML assertion. The assertion contains information such as the portal user's identity, authentication status, and other attributes required by the application. Zoho Creator validates the received SAML assertion and grants the user access to the portal if the validation is successful.

Before configuring SAML, it's important to understand the configuration attributes   involved in this authentication process:

Term
Description
Entity ID
A unique identifier that enables Zoho Creator Portal and the Identity Provider to recognize each other. For example, Zoho Creator uses 11118664031.zoho.com for US customers, 11118664031.zoho.eu for EU customers, and 11118664031.zoho.com.cn for China customers.

ACS URL (Assertion Consumer Service URL)
The Zoho Creator URL where the Identity Provider sends the SAML response after authenticating a portal user.

Obtained from :  Zoho Creator portal
Configured in : Identity Provider(IdP)

Name ID Format
The format used to identify portal users in the SAML response sent by the Identity Provider to the Service Provider via ACS URL. Zoho Creator supports only the email address format:

urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress 

This must be specified in the Identity Provider to ensure proper authentication. 

Login URL
The Identity Provider’s login URL configured in Zoho Creator portal, where portal users are redirected for authentication.

Obtained from : Identity Provider(IdP)
Configured in : Zoho Creator portal

Logout URL (Portal)
Configured in the Zoho Creator portal, this is the URL where portal users are redirected after the Identity Provider completes the SAML logout process.

Obtained from: Identity Provider(IdP)
Configured in: Zoho Creator portal

Service Provider logout URL
Configured in the Identity Provider (IDP), this URL is triggered when a portal user clicks Sign out in the Zoho Creator portal. The IDP uses this endpoint to terminate the user’s SAML session and log the user out from all connected portal applications.

Obtained from: Zoho Creator portal
Configured in: Identity Provider(IdP)

Key
A certificate or cryptographic key provided by the Identity Provider (IDP) that Zoho Creator uses to verify the authenticity and integrity of the SAML response. This ensures the authentication response is secure and valid.

Obtained from: Identity Provider(IdP)
Configured in: Zoho Creator portal

Algorithm
The cryptographic algorithm used to sign and verify SAML response. Zoho Creator supports standard algorithms such as RSA or DSA. The selected algorithm determines how the SAML response is signed or encrypted, and must match the configuration in the IDP.


Notes
Note:
  1. The ACS URL, Entity ID, and Service Provider Logout URL are automatically generated by the Zoho Creator portal during SAML authentication setup. These values must be configured in the Identity Provider (IdP) to establish trust between the IdP and the Zoho Creator portal. 
  2. The Login URL, Logout URL, Key, and Algorithm are generated by the Identity Provider (IdP). These details must be configured in the Zoho Creator portal while setting up SAML authentication. 

3.1.1  Use case :  Multiple portal access using SAML

Zylker Technologies is an organization that uses multiple Zoho Creator portals such as employee self-service portal , project management portal and external applications such as Monday.com and BambooHR for day to day operations.

Without a centralized authentication system, employees would need to maintain separate credentials and sign in to each portal and application. To provide a seamless authentication experience, Zylker Technologies configures all portals and applications with the same Identity Provider (IdP) using a custom authentication method. As a result, employees can authenticate once through the IdP and seamlessly access all authorized portals and applications without signing in separately.

3.2. JWT authentication 

JWT is a compact, JSON-based authentication standard that uses digitally signed tokens to securely authenticate portal users and grant access to Zoho Creator portal applications. A JWT token contains the portal user's identity and other authentication information required to verify the user.
To grant access to a portal user, Zoho Creator requires a valid JWT token signed using the JWT secret configured for the portal. JWT tokens can be generated using multiple methods, including implementing a custom token generation logic or using an external Identity Provider (IdP) to authenticate the user and generate the token.

Before configuring JWT authentication, it is important to understand the configuration attributes  involved in this authentication process:
Term
Description
 Login URL (Optional)
 The authentication end point of the Identity Provider. When a portal user accesses the portal, Zoho Creator redirects them to this endpoint for a centralised login through IdP.

Obtained from: Identity Provider(IdP)
Configured in: Zoho Creator portal

 Logout URL(Optional)
 The logout end point of the Identity Provider. When a portal user signs out of the portal, Zoho Creator redirects the user to this endpoint to terminate the authenticated user session.
 
Obtained from: Identity Provider(IdP)
Configured in: Zoho Creator portal

 Algorithm
 The cryptographic algorithm used to verify JWT tokens in Creator for secure portal authentication. Zoho Creator supports standard JWT signing algorithms such as HS256 or RS256. The algorithm configured in Zoho Creator must match the algorithm used by the Identity Provider (IdP) to generate and sign JWT tokens.
 
 Public Key (applicable only for HS256 algorithm)
 A cryptographic key generated by Zoho Creator to verify the authenticity of the JWT tokens issued by the identity provider. The generated public key should be configured in the external IdP, to sign the JWT tokens. The same key is used to verify the JWT tokens in Creator, once the portal user is authenticated by the IdP.
 
Obtained from: Zoho Creator portal
Configured in: Identity Provider(IdP)

 Signing Certificate (applicable only for RS256 algorithm)
 A verification certificate, provided by the identity provider (IdP) to verify the authenticity of the JWT tokens issued by the IdP. The certificate contains a public key, which is used to sign the JWT tokens in IdP and verify the tokens in Creator. Signing certificate must be uploaded if RS256 algorithm has been opted.
 
Obtained from: Identity Provider(IdP)
Configured in: Zoho Creator portal

Service Provider Login URL
The Zoho Creator portal endpoint that is invoked after successful user authentication to process the authentication response and sign the user in to the portal.

The Service Provider Login URL is auto-generated and available in the JWT configuration pane.

Replace the below parameters in the Service Provider Login URL invoking the URL:
  1. <jwt-token>: Replace with a valid JWT token generated using the configured JWT secret
  2. <landing-pageURL>: Replace with the URL of the page to which portal users should be redirected after successful authentication.
Obtained from : Zoho Creator portal
Configured in : Identity Provider(IdP)

Service Provider Logout URL
The Zoho Creator portal endpoint that is invoked during the logout process to terminate the portal user's session in the Creator portal and sign them out.
The Service Provider Logout URL is auto generated and available in the JWT configuration pane.

Obtained from: Zoho Creator portal
Configured in: Identity Provider(IdP)

 

3.2.1. Sample method to generate JWT token

Use the following sample code as a reference method to generate a JWT token. Replace the sample values with your portal's JWT secret and the required portal user information before generating the token.
Java
Java Script
Java
  1. // Secret key must be at least 32 bytes for HS256
  2. String secret = "your-256-bit-secret-key-must-be-at-least-32-bytes";
  3. SecretKey key = Keys.hmacShaKeyFor(secret.getBytes(StandardCharsets.UTF_8));
  4. long now = System.currentTimeMillis();
  5. String jwt = Jwts.builder()
  6.                 .issuer("creator")
  7.                 .subject("user@example.com")
  8.                 .audience().add("portal").and()
  9.                 .issuedAt(new Date(now))
  10.                 .notBefore(new Date(now))
  11.                 .expiration(new Date(now + 10 * 60 * 1000)) // 10 minutes
  12.                 .id(UUID.randomUUID().toString()) // jti
  13.                 .claim("email", "user@example.com")
  14.                 .claim("name", "John Doe")
  15.                 .signWith(key, SignatureAlgorithm.HS256)
  16.                 .compact();
  17. System.out.println(jwt);
Java Script
  1. const jwt = require("jsonwebtoken");
  2. const crypto = require("crypto");
  3. const secret = "your-256-bit-secret-key-must-be-at-least-32-bytes"; // Replace with your actual secret
  4. const now = Math.floor(Date.now() / 1000);
  5. const payload = {
  6.   sub: "user@example.com",
  7.   aud: "portal",
  8.   email: "user@example.com",
  9.   name: "John Doe",
  10.   iat: now,
  11.   nbf: now,
  12.   exp: now + 10 * 60, // 10 minutes
  13.   jti: crypto.randomUUID()
  14. };
  15. const options = {
  16.   issuer: "creator",
  17.   algorithm: "HS256"
  18. };
  19. const token = jwt.sign(payload, secret, options);
  20. console.log("JWT:");
  21. console.log(token);

3.2.2. Use cases 

A. Embedded Zoho Creator portal application

Zylker Technologies has a user-facing, third-party application for customer support and service management. To enhance the application's capabilities with artificial intelligence, Zylker embeds a Zoho Creator form within the application.The form leverages Zoho Creator's built-in AI capabilities, to extract information from uploaded documents, analyze customer sentiment and identify relevant keywords from the ticket description.

Without a centralized authentication system, customers would need to maintain separate credentials and sign in individually to the customer support application and the embedded Zoho Creator portal component. To provide a seamless user experience, both applications are configured with the same Identity Provider (IdP) using a custom authentication method. As a result, users who authenticate in the customer support application are automatically authenticated to access the embedded Zoho Creator portal. Similarly, when users log out of the external application, the authenticated session in the embedded Zoho Creator portal is also terminated.
Notes
Note:
For Zoho Creator portals embedded in external applications, JWT authentication is preferred, as portal login and logout redirections are not exposed to end users, enabling a seamless UI experience. 

B. JWT generation using custom logic

Zylker Foundation uses a Zoho Creator portal to manage fundraising campaigns and donations. The foundation promotes its campaigns across multiple partner websites, social media pages, and email campaigns, each containing a Donate Now button that redirects visitors to the donation portal. The portal is open to the public, so visitors are not required to create an account or sign in.
When a visitor clicks the Donate Now button, a custom logic implemented in the backend of the application generates a JWT token using the JWT secret configured for the portal. Zoho Creator verifies this token and grants the visitor access to the donation portal.

SAML and JWT authentication methods integrated with Identity Providers are commonly used for Single Sign-On (SSO) and centralised identity management, across multiple portals and applications.

4. Related topics         

  1. Configure federated login
  2. Configuring SAML authentication in portal
  3. Configuring JWT authentication
  4. Customizing portal pages

What's next
Previous step
What's next
The next step after understanding authentication and its types is to learn how to configure federated, JWT, and SAML authentication for portals.

Previous step

Before working with portal authentication, make sure to understand the concept of portals, how to setup a portal and how to manage and configure portal user permissions.