authenticate

Note:

SuiteCloud CLI for Java has reached end of support. The final available version is 2025.2. Oracle no longer provides new releases, features, or issue fixes. The CLI will remain available for download until the NetSuite 2027.1 release. Transition to SuiteCloud CLI for Node.js, SuiteCloud Extension for Visual Studio Code, or SuiteCloud IDE Plug-in for WebStorm.

Important:

Browser-based authentication is not compatible with Windows Subsystem for Linux.

Grants authorization for SuiteCloud SDK to access NetSuite with an account-role combination. It requires browser-based login to NetSuite.

Important:

For this command to work, at least one of the following ports needs to be accessible locally from your machine: 52300 - 52315.

Syntax

          sdfcli authenticate  <-authid AuthId>
    [-url NetSuiteDomainURL]

Options

Option

Required / Optional

Description

-authid

Required

References the custom alias you give to a specific account-role combination (also called authentication ID or auth ID in the documentation).

-url

Optional

Not required when authenticating against system.netsuite.com.

References the NetSuite domain of the account you want to use. It only needs to be specified if you want to use a customized NetSuite domain.

-h or -help

Optional

Prints the help for this command.

Example

Here's a command that authenticates an account by prompting the browser:

          sdfcli authenticate  <-authid AuthId>

Output example

After the browser closes and the account-role combination is authenticated, the command produces output that is similar to the following:

The authentication was successful with the following account and role: Account ID [Role]. This project will use the authentication ID "AuthId" as default.

Syntax

Options

Example

Output example

Related Topics