OAuth Scopes and Endpoints
Required Scopes and Endpoint Domains for NetSuite
When integrating with NetSuite, your application needs specific permissions to interact with the API.These permissions are defined by access scopes, which determine what data your application can access and what actions it can perform.
This topic provides information about the required access scopes and endpoint domains for the NetSuite driver.
Understanding Scopes
Scopes are a way to limit an application's access to a user's data. They define the specific actions that an application can perform on behalf of the user.
For example, a read-only scope might allow an application to view data, while a full access scope might allow it to modify data.
Required Scopes for NetSuite
Scope | Description |
restlets | Access the RESTlets feature in the SuiteTalk schema. Required for read access. |
rest_webservices | Access REST web services. Required for read and write access. |
Understanding Endpoint Domains
Endpoint domains are the specific URLs that the application needs to communicate with in order to authenticate, retrieve records, and perform other essential operations.
Allowlisting these domains ensures that the network traffic between your application and the API is not blocked by firewalls or security settings.
Note: Most users do not need to make any special configurations. Allowlisting is typically only necessary for environments with strict security measures, such as restricted outbound network traffic.
Required Endpoint Domains for NetSuite
Domain | Always Required | Description |
<AccountId>.restlets.api.netsuite.com | FALSE | The subdomain used to access the SuiteQL API. Required when Schema is set to SuiteQL. |
<AccountId>.suitetalk.api.netsuite.com | FALSE | The subdomain used to communicate with the SuiteTalk API. Required when Schema is set to SuiteTalk. |
<AccountId>.app.netsuite.com | TRUE | The subdomain corresponding to your NetSuite account. The <Account> must match the value you set in AccountId. |