Scopes

Zoho Assist APIs require OAuth scopes to define the level of access your application needs. When requesting for access token, request only the scopes your application requires. These will be displayed to the users when asking for consent.

Scopes contain three parameters — service name, scope name, and operation type. The format to define scope is service_name.scope_name.operation_type

Example:

https://accounts.zoho.com/oauth/v2/auth?scope=ZohoAssist.sessionapi.CREATE

Here, ZohoAssist is the service API name, sessionapi is the scope name, and CREATE is the operation type.

 

User Scope

Scope NamePurpose
ZohoAssist.userapi.READKnow who you are on Zoho Assist.

Session Scope

Scope Name Purpose
ZohoAssist.sessionapi.CREATE
Create your remote support sessions using Zoho Assist.
ZohoAssist.unattended.device.CREATECreate your Unattended Remote sessions using Zoho Assist.

Unattended Computer Scopes

Scope NamePurpose
ZohoAssist.unattended.computer.READView and manage unattended computers configured on Zoho Assist.   
ZohoAssist.unattended.computer.UPDATEUpdate unattended computers configured on Zoho Assist.
ZohoAssist.unattended.computer.DELETEDelete unattended computers configured on Zoho Assist.

Unattended Group Scopes

Scope NamePurpose
ZohoAssist.unattended.group.READView unattended computer groups on Zoho Assist.
ZohoAssist.unattended.group.CREATECreate unattended computer groups on Zoho Assist.
ZohoAssist.unattended.group.UPDATEUpdate unattended computer groups on Zoho Assist.
ZohoAssist.unattended.group.DELETEDelete unattended computer groups on Zoho Assist.

Report Scope

Scope NamePurpose
ZohoAssist.reportapi.READView remote support and unattended session reports on Zoho Assist.

To request multiple scopes, separate them with commas: 

scope=ZohoAssist.userapi.READ,ZohoAssist.sessionapi.CREATE

For more details about scope format, see OAuth Scopes.