Adding Apps - OpenID Connect (OIDC) - Overview | Admin Guide - Zoho Directory

OpenID Connect (OIDC) - Overview

OpenID Connect (OIDC) is an identity layer built on top of OAuth 2.0 authorization protocol. It facilitates third-party apps(clients) in verifying user's identity as well as accessing their basic profile information.

Now, let's familiarize ourselves with few terminologies before understanding how OIDC works:
OpenID Provider (OP)
Claims
ID token
Access token
JSON Web Key (JWK) Endpoint
Refresh token
Authorization Endpoint
Token Endpoint
User Info Endpoint
Discovery Endpoint
OpenID Provider (OP)
An OAuth 2.0 authorization component that helps in authenticating the user and providing user information to the client requesting these information.
Claims
Any information about the user sent in OIDC flow is called as claims.
ID token
JSON Web Tokens that contain information about the user and the authentication performed.
Access token
Token used to access user information from the resource server of OP.
Refresh token
Token used to get new access token once the previously provided access token gets expired.
Authorization Endpoint
Where the user authenticates themselves and grants permission to access certain information about them.
Token Endpoint
Where RP exchanges the Authorization Code received from OP for ID token, access token, and/or refresh token.
User Info Endpoint
Where RP requests user information(claims) about the user by providing the access token.
Discovery Endpoint
Where all the configuration details related to OP are displayed.
JSON Web Key (JWK) Endpoint
Where RP receives certain keys to verify the authenticity of the tokens received.
Relying Party (RP)/ Client
Scope
Authorization code
Redirect URI
Sign-out Endpoint
Relying Party (RP)/ Client
The client application that requests user authentication and user information from the OpenID provider.
Scope
Parameter used in authentication and authorization requests that defines what type of user information is required.
Authorization code
Code sent by the authorization endpoint to the client in the authentication response, which can then be exchanged at Token Endpoint for ID token and access token.
Redirect URI
URL to which the authorization endpoint sends the authentication and authorization response.
Sign-out Endpoint
Endpoint used to logout the users from the current authenticated session.

 Prerequisites for clients:

Clients(Relying Party) should have registered themselves with the Resource Provider (OpenID Provider) and gotten their Client ID and Client Secret from OpenID Provider.

Basic OIDC flow:

Relying Party requests the Authorization Endpoint of OpenID Provider to authenticate the user and get user's authorization to access certain user information. After authenticating the user and obtaining authorization, the authorization endpoint sends an ID token and access token to the Relying Party.
The method used for this token exchange varies based on the Relying Party (RP) type and the authentication flow chosen. We will explore about the RP types and the recommended authentication flows for each in the later sections of this article.
RP requests user information (claims) to the UserInfo Endpoint of the OP with the access token. OP sends the consented claims to the RP.


Regular Web Application (MPA) and Authorization Code flow:

These applications run on a server and send new page requests to the server for each action. These applications can store client secrets securely; hence, they are also referred to as Confidential Clients. The optimal authentication flow recommended for MPAs is Authorization Code Flow.
In this flow, RP(client) requests the Authorization Endpoint of OP to authenticate the user and get authorization to access certain user information. After authenticating the user and obtaining authorization, the authorization endpoint sends Authorization Code to the client.The client then exchanges this authorization code for ID token and access token (if requested, refresh token as well) at the token endpoint of OP. The client retrieves required user information(claims) from the ID token.
Single-Page Application (SPA) and Implicit flow
SPAs are modern web applications that loads the required section based on your action. These applications typically run on the client side after initially retrieving all the necessary resources from the server. They are also referred to as public clients, and they can't store client secrets securely as their entire source is on a browser. The suggested authentication flow for SPAs is the Implicit Code Flow.
In this flow, client(RP) requests Authorization Endpoint of OP to authenticate the user and get authorization to access certain user information. After authenticating the user and obtaining authorization, the authorization endpoint sends the ID token directly to the client. If requested, they also send access and refresh tokens. The client retrieves necessary user information from the ID token. Token endpoint is not used in this flow.
Native Applications and PKCE flow

Native applications are the ones installed directly on the specific device. They are also known as public clients. They can't store their secrets securely, as they are directly installed onto a device, and the applications can be decompiled by anyone to access the client secrets. The flow recommended for native apps is Authorization Code Flow with Proof Key for Code Exchange (PKCE).
In this flow, the client(RP) generates a Code Verifier(a random string) and a Code Challenge (hashed version of the code verifier using any hashing method). Along with the authorization request sent to the Authorization endpoint of OP, the client also sends the code verifier. After authenticating the user and obtaining authorization, the authorization endpoint sends the Authorization Code to the client. At the token endpoint of OP, the client provides this authorization code along with the Code Challenge and the hashing method used to hash the code verifier. The token endpoint then dehashes the code challenge using the mentioned hashing method and checks whether the answer and the code verifier matches, to verify that it received the authorization code from the same client who sent authorization request.The token endpoint then provides the ID token and access token (if requested, refresh token as well). The client gets required user information from the ID token.

      Create. Review. Publish.

      Write, edit, collaborate on, and publish documents to different content management platforms.

      Get Started Now


        Access your files securely from anywhere

          Zoho CRM Training Programs

          Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

          Zoho CRM Training
            Redefine the way you work
            with Zoho Workplace

              Zoho DataPrep Personalized Demo

              If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

              Zoho CRM Training

                Create, share, and deliver

                beautiful slides from anywhere.

                Get Started Now


                  Zoho Sign now offers specialized one-on-one training for both administrators and developers.

                  BOOK A SESSION







                              Quick LinksWorkflow AutomationData Collection
                              Web FormsRetailOnline Data Collection Tool
                              Embeddable FormsBankingBegin Data Collection
                              Interactive FormsWorkplaceData Collection App
                              CRM FormsCustomer ServiceForms for Solopreneurs
                              Digital FormsMarketingForms for Small Business
                              HTML FormsEducationForms for Enterprise
                              Contact FormsE-commerceForms for any business
                              Lead Generation FormsHealthcareForms for Startups
                              Wordpress FormsCustomer onboardingForms for Small Business
                              No Code FormsConstructionRSVP tool for holidays
                              Free FormsTravelFeatures for Order Forms
                              Prefill FormsNon-Profit
                              Forms for Government
                              Intake FormsLegal
                              Mobile App
                              Form DesignerHR
                              Mobile Forms
                              Card FormsFoodOffline Forms
                              Assign FormsPhotographyMobile Forms Features
                              Translate FormsReal EstateKiosk in Mobile Forms
                              Electronic FormsInsurance
                              Drag & drop form builder

                              Notification Emails for FormsAlternativesSecurity & Compliance
                              Holiday FormsGoogle Forms alternative GDPR
                              Form to PDFJotform alternativeHIPAA Forms
                              Email FormsWufoo alternativeEncrypted Forms
                              Accessible FormsTypeform alternativeSecure Forms

                              WCAG

                                          Create. Review. Publish.

                                          Write, edit, collaborate on, and publish documents to different content management platforms.

                                          Get Started Now






                                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                                Manage your brands on social media

                                                                  Use cases

                                                                  Make the most of Zoho Desk with the use cases.

                                                                   
                                                                    

                                                                  eBooks

                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho Desk.

                                                                   
                                                                    

                                                                  Videos

                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho Desk.

                                                                   
                                                                    

                                                                  Webinar

                                                                  Sign up for our webinars and learn the Zoho Desk basics, from customization to automation and more

                                                                   
                                                                    
                                                                  • Desk Community Learning Series


                                                                  • Meetups


                                                                  • Ask the Experts


                                                                  • Kbase


                                                                  • Resources


                                                                  • Glossary


                                                                  • Desk Marketplace


                                                                  • MVP Corner



                                                                    Zoho Sheet Resources

                                                                     

                                                                        Zoho Forms Resources


                                                                          Secure your business
                                                                          communication with Zoho Mail


                                                                          Mail on the move with
                                                                          Zoho Mail mobile application

                                                                            Stay on top of your schedule
                                                                            at all times


                                                                            Carry your calendar with you
                                                                            Anytime, anywhere




                                                                                  Zoho Sign Resources

                                                                                    Sign, Paperless!

                                                                                    Sign and send business documents on the go!

                                                                                    Get Started Now




                                                                                            Zoho TeamInbox Resources





                                                                                                      Zoho DataPrep Demo

                                                                                                      Get a personalized demo or POC

                                                                                                      REGISTER NOW


                                                                                                        Design. Discuss. Deliver.

                                                                                                        Create visually engaging stories with Zoho Show.

                                                                                                        Get Started Now










                                                                                                                            • Related Articles

                                                                                                                            • Adding apps - Overview

                                                                                                                              General Info: The Free plan allows you to add only up to 3 non-Zoho apps. Zoho Directory supports adding and managing five different types of apps: Directory apps These are pre-integrated SSO apps available in the app directory. SAML custom apps ...
                                                                                                                            • Using Open ID Connect (OIDC) in Zoho Directory

                                                                                                                              As an OpenID provider, Zoho Directory (ZD) can help you in authenticating the users and getting authorization to access users profile information securely. This is done through the OIDC authentication protocol. Learn more about OIDC. In Zoho ...
                                                                                                                            • Adding a custom OIDC app

                                                                                                                              The Free plan allows you to add only up to 3 non-Zoho apps. Check our app directory to see if the app you need is already integrated with Zoho Directory, or request an integration. In Zoho Directory, you can configure OpenID Connect (OIDC) for any ...
                                                                                                                            • Add bookmarked custom app

                                                                                                                              General Info: The Free plan allows you to add only up to 3 non-Zoho apps. Prerequisites Permissions required to perform this action: Add apps Assign apps Add bookmarked custom apps: Sign in to Zoho Directory , then click Admin Panel in the left menu. ...
                                                                                                                            • Add associated custom app

                                                                                                                              General Info: The Free plan allows you to add only up to 3 non-Zoho apps. Prerequisites Permissions required to perform this action: Add apps Assign apps Add associated custom app: Sign in to Zoho Directory , then click Admin Panel in the left menu. ...
                                                                                                                              Wherever you are is as good as
                                                                                                                              your workplace

                                                                                                                                Resources

                                                                                                                                Videos

                                                                                                                                Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                                eBooks

                                                                                                                                Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                                Webinars

                                                                                                                                Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                                CRM Tips

                                                                                                                                Make the most of Zoho CRM with these useful tips.



                                                                                                                                  Zoho Show Resources