diff --git a/public/docs-static/img/manage/team/single-sign-on/zoho-idp/assign-users.png b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/assign-users.png new file mode 100644 index 00000000..07106796 Binary files /dev/null and b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/assign-users.png differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zoho-idp/client-credentials.png b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/client-credentials.png new file mode 100644 index 00000000..be0fec41 Binary files /dev/null and b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/client-credentials.png differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zoho-idp/configure-oidc-app.png b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/configure-oidc-app.png new file mode 100644 index 00000000..a7f766bf Binary files /dev/null and b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/configure-oidc-app.png differ diff --git a/public/docs-static/img/manage/team/single-sign-on/zoho-idp/create-custom-app.png b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/create-custom-app.png new file mode 100644 index 00000000..b2f4e058 Binary files /dev/null and b/public/docs-static/img/manage/team/single-sign-on/zoho-idp/create-custom-app.png differ diff --git a/src/pages/manage/team/single-sign-on/index.mdx b/src/pages/manage/team/single-sign-on/index.mdx index ce7e2b35..5c685c08 100644 --- a/src/pages/manage/team/single-sign-on/index.mdx +++ b/src/pages/manage/team/single-sign-on/index.mdx @@ -93,3 +93,9 @@ to integrate with NetBird. Below are the steps to set up different OIDC-complian [AWS Cognito](https://aws.amazon.com/cognito/) is a fully managed customer identity and access management (CIAM) service from Amazon Web Services. It provides authentication, authorization, and user management for web and mobile applications, with native support for OpenID Connect, OAuth 2.0, and SAML 2.0. + +### Zoho + +[Zoho Directory](https://www.zoho.com/directory/) is a cloud-based identity and access management platform that provides single sign-on, multi-factor authentication, and user lifecycle management. It supports OpenID Connect, OAuth 2.0, and SAML, and lets you register NetBird as a custom OIDC application. + + diff --git a/src/pages/manage/team/single-sign-on/zoho.mdx b/src/pages/manage/team/single-sign-on/zoho.mdx new file mode 100644 index 00000000..2ae12517 --- /dev/null +++ b/src/pages/manage/team/single-sign-on/zoho.mdx @@ -0,0 +1,76 @@ +import {Note} from "@/components/mdx"; + +# Zoho on NetBird Cloud + +You can use Zoho as your Identity Provider with NetBird, but it will require some additional configuration steps. Zoho Directory is a cloud-based identity and access management platform that provides single sign-on, multi-factor authentication, and user lifecycle management, with support for OpenID Connect, OAuth 2.0, and SAML. + +NetBird integrates with Zoho as a custom OIDC application. + + + Support for OIDC-compliant IdPs is available on the Team plan and higher. + The Free plan supports Google, Microsoft, and social logins. + + +## Step 1: Create a Custom OIDC Application + +Log in to [Zoho Directory](https://directory.zoho.com/) and open the **Admin Panel** from the left sidebar. Navigate to **Applications**, click **Add Application**, and then choose **Create Custom App**. + +Enter `NetBird` as the application name and an optional description. + +

+ zoho-create-custom-app +

+ +## Step 2: Configure the OIDC Application + +Click **Select SSO mode** and choose **OIDC** as the Sign-In Type. On the same form, set the following: + +- **Application Type**: `Regular Web Application` + +Under **Relying Party Details**, enter the NetBird endpoints: + +- **Sign-in URL**: `https://app.netbird.io` +- **Sign-out URL**: `https://app.netbird.io` +- **Redirect URL**: `https://login.netbird.io/login/callback` + +

+ zoho-configure-oidc-app +

+ +Click **Done**, then **Create**. + +## Step 3: Retrieve the Client Credentials + +Open the newly created application and select the **Single Sign-on** tab. Copy and store the following securely: + +- **Client ID** +- **Client Secret** + +Under **Optional Endpoints**, copy the **Discovery Endpoint** as well. NetBird uses this single URL to automatically discover the Authorization, Token, and User Info endpoints for your Zoho data center. + +

+ zoho-client-credentials +

+ +## Step 4: Assign Users + +Assign access to the NetBird application so users can sign in to NetBird with Zoho. You can assign individual users with **Add User**, or assign entire groups with **Add Group**. + +

+ zoho-assign-users +

+ +## Step 5: Share Configuration with NetBird + +Send the following information to the NetBird support team at support@netbird.io: + +- **Client ID** +- **Client Secret** +- **Discovery Endpoint** (the OpenID configuration URL you copied in Step 3) +- **Email domains for your users** + + +We recommend using a secure channel to share the Client Secret. You can send a separate email and use a secret sharing service like:
+- https://onetimesecret.com/en/
+- https://password.link/en
+