When to Use a Custom OAuth App

Creating a custom OAuth app is required in order to connect via OAuth.

Desktop Authentication with a Custom OAuth App

Follow the steps below to authenticate with the credentials for a custom OAuth app. See Creating a Custom OAuth App.

Get and Refresh the OAuth Access Token

After setting the following, you are ready to connect:

• AccountId: Set this to the account id you are connecting to.
• OAuthClientId: Set this to the Consumer Key assigned when you registered your app.
• OAuthClientSecret: Set this to the Consumer Secret assigned when you registered your app.
• Scope: Set this value to match what your app has access to when using OAuth 2.0. Set it to restlets, rest_webservices, or restlets rest_webservices.
• CallbackURL: Set this to the redirect URI defined when you registered your app.
• InitiateOAuth: Set this to GETANDREFRESH. You can use InitiateOAuth to avoid repeating the OAuth exchange and manually setting the OAuthAccessToken.

When you connect the driver opens the OAuth endpoint in your default browser. Log in and grant permissions to the application. The driver then completes the OAuth process:

1. Extracts the access token from the callback URL and authenticates requests.
2. Saves OAuth values in OAuthSettingsLocation to be persisted across connections.

Web Authentication with a Custom OAuth App

When connecting via a Web application, you need to register a custom OAuth app with NetSuite. See Creating a Custom OAuth App. You can then use the driver to get and manage the OAuth token values.

Get an OAuth Access Token

Set the following connection properties to obtain the OAuthAccessToken:

• AccountId: Set this to the account id you are connecting to.
• OAuthClientId: Set this to the Consumer Key assigned when you registered your app.
• OAuthClientSecret: Set this to the Consumer Secret assigned when you registered your app.
• Scope: Set this value to match what your app has access to when using OAuth 2.0. Set it to restlets, rest_webservices, or restlets rest_webservices.

You can then call stored procedures to complete the OAuth exchange:

1. Call the GetOAuthAuthorizationURL stored procedure. Set the AuthMode input to WEB and set the CallbackURL input to the Redirect URI you specified in your app settings.

   The stored procedure returns the URL to the OAuth endpoint.

2. When using OAuthVersion 1.0 or Schema set to SuiteTalk, the procedure will additionally return an AuthToken and AuthKey. Save these values - they will need to be passed to GetOAuthAccessToken.
3. Open the URL, log in, and authorize the application. You are redirected back to the callback URL.
4. Call the GetOAuthAccessToken stored procedure. Set the AuthMode input to WEB. Set the Verifier input to the "code" parameter in the query string of the callback URL.
5. Additionally, using OAuthVersion 1.0 or Schema set to SuiteTalk, set the AuthToken and AuthKey inputs.

Refresh the OAuth Access Token

Unlike other sources, NetSuite tokens do not expire. There is no refresh flow.