Scopes

Zoho WorkDrive APIs use selected scopes, which control the type of resource that the client application can access. Tokens are usually created with various scopes to ensure improved security. For example, you can generate a scope to create or view a Team Folder or to view File Metadata. Scopes contain three parameters: Service Name, Scope Name, and OperationType.The format to define a scope is:scope=ServiceName.ScopeName.OperationType


Example:

https://accounts.zoho.com/oauth/v2/auth?scope=WorkDrive.team.ALL


Here, WorkDrive is the service name, scope name would be scopes mentioned in the below table, and ALL is the operation type.

List of Scopes Available in Zoho WorkDrive

Scope NameDescription
team To access team related APIs.

Available scopes:
WorkDrive.team.CREATE, WorkDrive.team.READ, WorkDrive.team.UPDATE, WorkDrive.team.DELETE
teamfolders To access team folder related APIs.

Available scopes:
WorkDrive.teamfolders.CREATE, WorkDrive.teamfolders.READ, WorkDrive.teamfolders.UPDATE, WorkDrive.teamfolders.DELETE
teamfolders.sharing To add or manage members in a team folder.

Available scopes:
WorkDrive.teamfolders.sharing.CREATE, WorkDrive.teamfolders.sharing.READ, WorkDrive.teamfolders.sharing.UPDATE, WorkDrive.teamfolders.sharing.DELETE
teamfolders.admin To perform admin-related operations in a team folder.

Available scopes:
WorkDrive.teamfolders.admin.READ
groups To access group related APIs.

Available scopes:
WorkDrive.groups.CREATE, WorkDrive.groups.READ, WorkDrive.groups.UPDATE, WorkDrive.groups.DELETE
files To access files related APIs.

Available scopes:
WorkDrive.files.CREATE, WorkDrive.files.READ, WorkDrive.files.UPDATE, WorkDrive.files.DELETE
links To access external links related APIs.

Available scopes:
WorkDrive.links.CREATE, WorkDrive.links.READ, WorkDrive.links.UPDATE, WorkDrive.links.DELETE
comments To access comments related APIs.

Available scopes:
WorkDrive.comments.CREATE, WorkDrive.comments.READ, WorkDrive.comments.UPDATE, WorkDrive.comments.DELETE
collection To access collect files related APIs.

Available scopes:
WorkDrive.collection.CREATE, WorkDrive.collection.READ, WorkDrive.collection.UPDATE, WorkDrive.collection.DELETE
datatemplates To access data templates and custom fields related APIs.

Available scopes:
WorkDrive.datatemplates.CREATE, WorkDrive.datatemplates.READ, WorkDrive.datatemplates.UPDATE, WorkDrive.datatemplates.DELETE
labels To access labels related APIs.

Available scopes:
WorkDrive.labels.CREATE, WorkDrive.labels.READ, WorkDrive.labels.UPDATE, WorkDrive.labels.DELETE
libraries To access templates related APIs.

Available scopes:
WorkDrive.libraries.CREATE, WorkDrive.libraries.READ, WorkDrive.libraries.UPDATE
libraries.sharing To access permission details of a template library.

Available scopes:
WorkDrive.libraries.sharing.READ
libraries.categories To access template categories related APIs.

Available scopes:
WorkDrive.libraries.categories.CREATE, WorkDrive.libraries.categories.READ, WorkDrive.libraries.categories.UPDATE
securesearch Required to perform search operations.

Available scopes:
ZohoSearch.securesearch.READ
workflows To access workflow-related APIs.

Available scopes:
WorkDrive.workflows.CREATE, WorkDrive.workflows.READ, WorkDrive.workflows.UPDATE, WorkDrive.workflows.DELETE
workflowinstances To access workflow instance-related APIs.

Available scopes:
WorkDrive.workflowinstances.CREATE, WorkDrive.workflowinstances.READ, WorkDrive.workflowinstances.UPDATE, WorkDrive.workflowinstances.DELETE