Scopes

Scopes allow you to define the level of access that can be provided to access Catalyst components. There are primarily two scopes that define two levels of access:

  • Admin: If you initialize your SDK with this scope, you can access all the SDK methods of all the components. There are no restrictions.
  • User: If you initialize with this scope, you will only be able to access certain SDK methods of certain Catalyst components.
Notes: By default you will be able to initialize the SDK in the Admin scope.

The following table will provide the complete list of SDK methods present in each Catalyst component, and the scope required to implement them.

Catalyst Service Component SDK Methods Required Scope
Serverless Functions Execute Function Admin, User
Circuits Execute Circuits Admin
CloudScale Authentication Admin
Admin, User
DataStore Admin, User
Get Table Metadata Admin
NoSQL All NoSQL SDK Methods Admin
Stratus Admin, User
Admin
Cache All Cache SDK Methods Admin
Mail All Mail SDK Methods Admin
Push Notifications All Push Notifications SDK Methods Admin
Zia Services All Zia Components All Zia Services SDK Methods Admin
SmartBrowz PDF & Screenshot and Dataverse All SDK Methods Admin
Job Scheduling All Components All SDK Methods Admin
Pipelines All Components All SDK Methods Admin
QuickML All Components All SDK Methods Admin
Connectors N/A Connectors JavaScript SDK Methods Admin

Implement SDK Methods with Scopes

copy
// initialize the sdk with user scope
 const auth = await new ZCAuth().init(req, {scope: 'user'});
// initialize the sdk with admin scope
const auth = await new ZCAuth().init(req, {scope: 'admin'});

Last Updated 2026-07-02 14:51:41 +0530 IST