Skip to main content
You need a Zoho account that can open the Zoho API Console. The client only asks for read access to Vault users and user groups, and the Client Secret must stay private.

​
Register a client in the Zoho API Console

The client is the Zoho app StackOne uses to ask each Vault administrator for read access.

1

Sign in to the Zoho API Console

Sign in to the Zoho API Console with your Zoho account. For a China account, use the China API Console.

  • If you have not registered a client yet, click GET STARTED.
  • If you already have one, click + ADD CLIENT.
2

Choose the client type

In the Choose a Client Type window, click CREATE NOW on the Server-based Applications card.

3

Enter the client details

Fill in the fields and click CREATE.

  • Client Name: StackOne Vault
  • Homepage URL: your company website
  • Authorized Redirect URIs: https://api.stackone.com/connect/oauth2/zohovault/callback
  • Paste the redirect URI exactly. Zoho refuses the authorization when it differs from the registered one.
4

Copy the Client ID and Client Secret

Open the Client Secret tab of your client and copy the Client ID and the Client Secret.

  • Paste the Client ID into the Client ID field in the StackOne Connector profile.
  • Paste the Client Secret into the Client Secret field in the StackOne Connector profile.
  • To see them later, sign in to the console, select your client and open the Client Secret tab again.
5

Enable other data centers

If any customer uses Vault in a data center other than the one your client is registered in, open the Settings tab of your client and switch on each of those data centers.

  • Select Use the same OAuth credentials for all data centers. Zoho gives each enabled data center its own secret by default, and the StackOne Connector profile stores one Client Secret.
  • A customer whose data center is not switched on cannot authorize.
  • With the checkbox cleared, a customer in a switched-on data center fails to connect, because Zoho expects that data center’s own secret.
  • If the tab shows no switch for a customer’s data center, such as Singapore (SG) or United Arab Emirates (AE), that customer cannot authorize through this client.
  • The Settings tab has no China data center. A customer on China (CN) cannot authorize through a client registered in another data center.

​
Choose the OAuth Scopes

The OAuth Scopes field lists the Vault scopes StackOne asks for, separated by commas.

  • Leave it empty to request ZohoVault.user.READ. Every action, the connection test included, needs it, and none needs more.
  • If you enter your own list, keep ZohoVault.user.READ in it. Without it the connection test fails and no action can read users or user groups.
  • Zoho refuses the authorization if a scope you enter does not exist.
  • Vault also has ZohoVault.user.CREATE and ZohoVault.user.UPDATE for user groups. No action uses them, so leave them out.
1

Review the scope

Enables actions: Check User Access, Get Unified Group, Get Unified Role, Get Unified User, Get User, Get User Group, List Unified Groups, List Unified Roles, List Unified Users, List User Groups, List Users

Reading users and user groups needs this scope. It is read-only.

​
Know how access lasts

An access token lasts 1 hour and StackOne refreshes it automatically with the refresh token.

  • The Vault administrator who authorized can revoke StackOne’s access at any time. They sign in to Zoho Accounts, click Sessions in the left menu, scroll to Connected Apps, hover over the app and click Revoke Access, then click Yes, Proceed.
  • After a revoke, the connection fails at once and the customer must connect their account again.

​
Creating the StackOne Connector Profile

To create the Connector Profile in StackOne for Zoho Vault:
1

Open the connector

Log in to StackOne, open Connectors, and select Zoho Vault.
2

Choose actions and events

  • Click Add Profile.
  • If the connector offers more than one authentication method, set the Auth Method filter to OAuth 2.0.
  • Select the actions, and any events, to enable for this Connector Profile.
  • Click Continue.
3

Set up authentication

  • Select Authentication Type as OAuth 2.0.
  • Fill out the fields using details retrieved from your provider:
    • Client ID
    • Client Secret
    • OAuth Scopes (Optional)
  • Click Create Profile.
Congratulations! The new Connector Profile now shows up on the connector page. If you created it as a project member rather than an admin, it starts disabled until a project admin enables it. You can now continue to Link Accounts for Zoho Vault.