Scopes
Scopes how a user or API access token can interact with a Bunny object
Scopes are assigned to User Roles or API Client applications to limit the level of access that is available to that client or user.
We recommend using the principle of least privileged access. This means that you should only assign the scopes that are required to perform the API requests that you want to do.
Use this list of scopes to determine which ones you need to build your API application.
| Scope | Description |
|---|---|
| admin:read | View templates and objects |
| admin:write | Create, update or delete templates and objects |
| analytics:read | View analytics dashboards |
| analytics:write | Create, update or delete analytics dashboards |
| billing:read | View billing, currencies, transactions and payments |
| billing:write | Create, update or delete billing, currencies, transactions and payments |
| developer:read | View API client applications |
| developer:write | Create, update or delete API client applications |
| owner:read | View account owner settings |
| owner:write | Modify account owner settings |
| platform:read | Grants no access on its own yet; pair it with platform:write |
| platform:write | Update tenants with tenantUpdate and report tenant metrics with tenantMetricsUpdate |
| portal:read | Read the data the customer portal shows |
| portal:write | Create customer portal sessions with portalSessionCreate, without the user and role access of security:write |
| portal_assume:write | Open the customer portal for a tenant from Bunny |
| product:read | View products, plans, price lists and features |
| product:write | Create, update or delete products, plans, price lists and features |
| quoting:read | View quotes |
| quoting:write | Grants no access on its own yet; creating and changing quotes needs standard:write |
| security:read | View users, roles and groups |
| security:write | Create, update or delete users, roles and groups |
| signup:read | Read the product catalog and preview signup pricing, for the Signup component |
| signup:write | Sign up a new account, for the Signup component |
| standard:read | View contacts, deals, accounts, quotes and subscriptions |
| standard:write | Create, update or delete contacts, deals, accounts, quotes and subscriptions |
| workflow:read | View workflows |
| workflow:write | Create, update or delete workflows |
| openid | View the signed-in user’s profile, such as name and email |
Each mutation’s page in the API reference shows the scope it requires.
API client applicationsLink to API client applications section
When an API client requests an access token, it must also request the scopes that it wants access to. If the client requests scopes that have not been assigned then an error will be raised and an access token will not be returned.