Aurora uses Access Scopes to define how external apps and services can access data in your tenant. Each access scope defines an ability to either read or modify data in your tenant based on a set of Aurora API endpoints. For instance, the read_projects scope will give apps the ability to retrieve basic information about a project, see assets of a project, and retrieve AHJ information for a project.
For the exact data exposed for each access scope, see the API documentation for the relevant endpoints at docs.aurorasolar.com
All Access Scopes
For a list of all access scopes, and what endpoints fall under each scope, please see below:
| Scope | API Endpoints |
|---|---|
| read_tenants | Retrieve Tenant |
| read_versions | Retrieve Versions |
| write_versions | Upgrade Version, Rollback Version |
| read_users | Retrieve User, List Roles |
| list_users | List Users |
| write_users | Create User, Invite User, Update User, Activate User, Deactivate User |
| read_sso_providers | Retrieve SSO Provider |
| write_sso_providers | Create SSO Provider, Update SSO Provider |
| read_teams | List Teams |
| read_partners | List Partners |
| read_leads | Retrieve Lead, Retrieve Solar Estimation Status |
| write_leads | Create Lead, Convert Lead, Run Solar Estimation Job |
| read_projects | Retrieve Project, List Project Assets, Retrieve AHJ |
| list_projects | List Projects |
| write_projects | Create Project, Update Project, Delete Project, Create Project Asset |
| read_consumption_profiles | Retrieve Consumption Profile |
| write_consumption_profiles | Update Consumption Profile |
| read_design_requests | List Design Requests, Retrieve Design Request, Retrieve EagleView Design Request |
| write_design_requests | Create Design Request, Accept Design Request, Create EagleView Design Request, Accept EagleView Design Request |
| read_designs | List Designs, Retrieve Design Summary, Retrieve Roof Summary, List Racking Arrays, Retrieve Web Proposal, Retrieve Proposal PDF Generation |
| write_designs | Create Design, Duplicate Design, Generate Web Proposal URL, Update racking BOM, Update Design, Run Proposal PDF Generation |
| read_design_assets | List Design Assets, Retrieve Design Asset |
| write_design_assets | Create Design Asset |
| read_components | List Modules, Retrieve Module, List Inverters, Retrieve Inverter, List DC Optimizers, Retrieve DC Optimizer |
| read_pricing | Retrieve Design Pricing |
| write_pricing |
Update Design Pricing, Create Adder, Delete Adder |
| read_financings | List Financings, Retrieve Financing |
| read_proposals | List Proposal Templates, Retrieve Proposal Template, Retrieve Proposal |
| write_proposals | Create Proposal, Delete Proposal |
| read_agreements | List Agreements, Retrieve Agreement, Retrieve Agreement Link |
| read_site_surveys | Retrieve Site Survey Request, Retrieve Site Survey, List Site Surveys |
| write_site_surveys | Create Site Survey, Update Site Survey Overview, Update Site Survey Electrical Data, Update Site Survey Subpanels, Update Site Survey Mounting Planes, Update Site Survey Status |
| read_plan_sets | Retrieve Plan Set Request, Retrieve Plan Set |
| write_plan_sets | Create Plan Set Request |
| read_webhooks | List Webhooks, Retrieve Webhook |
| write_webhooks | Create Webhook, Update Webhook, Delete Webhook |