1. SuiteCloud Platform
  2. SuiteCloud SDK
  3. SuiteCloud CLI
  4. SuiteCloud CLI for Node.js
  5. SuiteCloud CLI for Node.js Reference
  6. account:manageauth

account:manageauth

Manages authentication IDs for all your projects.

Syntax

            account:manageauth [--info myNetSuiteDevRole] [--rename myNetSuiteDevRole --renameto myOtherNetSuiteDevRole] [--remove myNetSuiteDevRole]

Options

Option

Required / Optional

Description

--info

Optional

Prints the following information for the specified authentication ID: account ID, role ID, and domain.

For example, account:manageauth --info myDevAccountAuthId.

-i or --interactive

Optional

Runs the command in interactive mode.

--list

Required if the -info, -rename, or -remove options are specified.

Prints a list of all the configured authentication IDs.

For example, account:manageauth --list.

--remove

Optional

Removes an authentication ID.

For example, account:manageauth --remove myDevAccountAuthId.

--rename

Optional

Renames an authentication ID. You must specify it together with the --renameto option.

For example, account:manageauth --rename myDevAccountAuthId --renameto devAccount.

--renameto

Optional

Specifies the new ID for an authentication ID. You must specify it together with the --rename option.

For example, account:manageauth --rename myDevAccountAuthId --renameto devAccount.

-h or --help

Optional

Prints the help for this command.

Interactive Example

The following command starts the process to view and edit your authentication IDs using the interactive mode:

            suitecloud account:manageauth -i

Before the command is executed, the following questions are prompted:

            Select an authentication ID to see its details:
(*) myAdminDRole | Admin - companyName
( ) myDevRole | Developer - companyName
myNetSuiteDevRole authentication ID information: Authentication ID: myAdminDRole Account Name: My Company Account ID: accountID Role: Admin Domain: netsuite.com Account Type: Production
Select one of the following actions: > Rename the authentication ID. Remove the authentication ID. Exit the process.
Enter a new name for the authentication ID: adminRoleAuthId

Non-interactive Example

The following command removes an authentication ID using the non-interactive mode:

            suitecloud account:manageauth --remove myNetSuiteDevRole

Output Example

When you finish answering the questions prompted by the interactive command, the command produces output that is similar to the following:

            The authentication ID adminRoleAuthId was successfully updated.

Related Topics

General Notices