Scopes

For improved security, Bigin APIs enable scopes for API requests to restrict clients from accessing unauthorized resources. In general, the implementation of scopes helps users to limit the amount of access that is given to an application.

In Bigin, to control the resource access, the scopes are associated with an access token that the client must share with each API request. For that reason, as a developer, you must register your client to get client credentials. Then, along with the client credentials you can associate the required scopes with authorization code request. Once the code is generated, you can use it to generate access tokens for the given scopes.

Also, when the client requests user to authorize for accessing resources, the user has an option to view the scopes the client is trying to gain access to, and then decide whether to accept or reject the request.

In Bigin, the format of scope has three components as shown below:

Scope = scope_service.scope_name.operator_type

Component name	Description
scope_service	The service API name. In this case, ZohoBigin.
scope_name	Name of the scope. For example, pipelines, org, settings and modules.
operator_type	Indicates the type of access. Bigin APIs have the following operator types: ALL - gets full access to data READ - retrieves data from the resource server CREATE - creates data in the resource server WRITE - edits data in the resource server DELETE - removes data in the resource server

Available Scopes

users

Scope	Description	Endpoints
ZohoBigin.users.ALL	View and manage users in an organization	Get a list of users, Add a user, Update a user, Delete a user
ZohoBigin.users.READ	View the details of users in an organization	Get a list of users
ZohoBigin.users.CREATE	Create users in an organization	Add a user
ZohoBigin.users.WRITE	Edit user details in an organization	Update a user
ZohoBigin.users.DELETE	Delete users from an organization	Delete a user

org

Scope	Description	Endpoints
ZohoBigin.org.ALL	View and manage organization details	Get organization details, Upload organization photo
ZohoBigin.org.READ	View the organization details	Get organization details
ZohoBigin.org.CREATE	Upload the brand logo or image of the organization	Upload organization photo
ZohoBigin.org.WRITE	Update the brand logo or image of the organization	Upload organization photo

settings

Scope	Description	Endpoints
ZohoBigin.settings.ALL	View and manage all aspects of an organization	Get a list of modules, Get the metadata of a specific module, Get the field details of a specific module, Get the layout details of a specific module, Get the related list metadata of a specific module, Get the custom view metadata of a specific module, Get a list of tags available in a module, Get record count for a specific tag, Create tags, Update tags, Delete tags
ZohoBigin.settings.modules.ALL	View and manage details of modules available in an organization	Get a list of modules, Get the metadata of a specific module
ZohoBigin.settings.modules.READ	View all details of modules available in an organization	Get a list of modules, Get the metadata of a specific module
ZohoBigin.settings.roles.ALL	View and manage roles' details	Get roles details
ZohoBigin.settings.roles.READ	View details of all roles	Get roles details
ZohoBigin.settings.profiles.ALL	View and manage profile details	Get profiles details
ZohoBigin.settings.profiles.READ	View details of all profiles	Get profiles details
ZohoBigin.settings.fields.ALL	View and manage the field metadata of a module	Get the field metadata of a specific module
ZohoBigin.settings.fields.READ	View metadata of all fields in a module	Get the field metadata of a specific module
ZohoBigin.settings.layouts.ALL	View and manage the layouts associated with a module	Get the layout details of a specific module
ZohoBigin.settings.layouts.READ	View the details of layouts associated with a module	Get the layout details of a specific module
ZohoBigin.settings.related_lists.ALL	View and manage the related list details of a module	Get the related list metadata of a specific module
ZohoBigin.settings.related_lists.READ	View the details of related lists in a module	Get the related list metadata of a specific module
ZohoBigin.settings.custom_views.ALL	View and manage the custom view details of a module	Get the custom view metadata of a specific module
ZohoBigin.settings.custom_views.READ	View the details of custom views in a module	Get the custom view metadata of a specific module
ZohoBigin.settings.tags.ALL	View and manage the tag details of a module	Get a list of tags available in a module, Get record count for a specific tag, Create tags, Update tags
ZohoBigin.settings.tags.READ	View the tag details of a module	Get a list of tags available in a module, Get record count for a specific tag
ZohoBigin.settings.tags.WRITE	Edit the tag details of a module	Create tags, Update tags, Delete tags
ZohoBigin.settings.tags.CREATE	Create tags for a module	Create tags
ZohoBigin.settings.tags.UPDATE	Update tags for a module	Update tags
ZohoBigin.settings.tags.DELETE	Delete existing tags from a module	Delete tags

modules

Scope	Description	Endpoints
ZohoBigin.modules.ALL	View and manage modules	Get a list of attachments, Upload an attachment, Download an attachment, Delete an attachment, Upload a photo, Download a photo, Delete a photo, Get a list of available records, Insert new records, Update existing records, Delete records, Get the related list records, Update related records, Delink related records, Get a list of notes, Add new notes, Update an existing note, Delete notes, Add tags to records, Delete tags from records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.ALL ZohoBigin.modules.accounts.ALL ZohoBigin.modules.products.ALL	View and manage specific modules such as contacts, accounts (companies in Bigin UI) and products	Upload a photo, Download a photo, Get a list of available records, Insert new records, Update existing records, Delete records, Search records, Get the related list records, Update related records, Delink related records, Add tags to records, Delete tags from records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.READ ZohoBigin.modules.accounts.READ ZohoBigin.modules.products.READ	View the details of modules such as contacts, accounts (companies in Bigin UI) and products	Download a photo, Get a list of available records, Search records, Get the related list records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.CREATE ZohoBigin.modules.accounts.CREATE ZohoBigin.modules.products.CREATE	Add new records to a module	Upload a photo, Insert new records, Add tags to records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.WRITE ZohoBigin.modules.accounts.WRITE ZohoBigin.modules.products.WRITE	Edit records in the module	Upload a photo, Insert new records, Update existing records, Update related records, Delink related records, Add tags to records, Delete tags from records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.UPDATE ZohoBigin.modules.accounts.UPDATE ZohoBigin.modules.products.UPDATE	Update records in the module	Update existing records, Update related records
You can use any of the following based on the module you want to access: ZohoBigin.modules.contacts.DELETE ZohoBigin.modules.accounts.DELETE ZohoBigin.modules.products.DELETE	Remove existing records from the module	Delete records, Delink related records

bulk

Scope	Description	Endpoints
ZohoBigin.bulk.ALL	View and manage large set of data	Get details of bulk write job
ZohoBigin.bulk.READ	View the large set of data from your organization	Create bulk read job, Get the status of the bulk read job, Download bulk read result
ZohoBigin.bulk.CREATE	Insert or update large set of data	Get details of bulk write job, Create bulk write job

notifications

Scope	Description	Endpoints
ZohoBigin.notifications.ALL	View and manage notifications	Enable notifications, Get notification details, Update the notification details, Update specific details of a notification, Disable notifications, Disable specific notifications
ZohoBigin.notifications.READ	View notification details	Get notification details
ZohoBigin.notifications.WRITE	Edit instant notification details	Enable notifications, Update the notification details, Update specific details of a notification
ZohoBigin.notifications.CREATE	Enable instant notification details	Enable notifications
ZohoBigin.notifications.UPDATE	Update instant notification details	Update the notification details, Update specific details of a notification
ZohoBigin.notifications.DELETE	Delete notifications	Disable notifications, Disable specific notifications