Troubleshooting Guide for SuiteCloud SDK

This topic provides information about errors related to SuiteCloud SDK and how to fix them.

Authentication Errors

Error Message

Scenario

Solution

Secure storage is inaccessible. Ensure that the secure storage in your system is properly configured and accessible.

The OS secure storage isn't accessible. It might be locked or not set up right.

Check the OS-based secure storage service on your machine.

  • For Windows, ensure that Credentials Manager is working.

  • For MacOS, ensure that Keychain is working.

  • For Linux, make sure the default keyring is available and unlocked. You can use Seahorse or another tool that lets you see the GNOME Keyring v2.22+/Libsecret.

As a temporary fix, while the secure storage issue is being resolved, you can use the SUITECLOUD_FALLBACK_PASSKEY environment variable to set the passkey for the credentials file.

If the credentials_browser_based.p12 file already exists and the passkey from secure storage cannot be retrieved, delete this file and authenticate again to run operations that require authentication. After you re-authenticate, the new credentials file will be saved with the new passkey you set in SUITECLOUD_FALLBACK_PASSKEY.

For more information, see Browser-Based Authentication Standard Process and Fallback Mode and Setting Up Environment Variables for SuiteCloud SDK Tools.

Secure storage is inaccessible. Ensure that the secure storage in your system is properly configured and accessible.

Secure storage isn't accessible in a CI/CD environment.

Actions that need credentials (like deploy) fail with this error because the right environment variables aren't set up to use the credentials in the credentials_ci.p12 file.

Ensure that the following environment variables are set:

  • SUITECLOUD_CI=1

  • SUITECLOUD_CI_PASSKEY set to an alphanumeric string with 32-100 characters.

With these environment variables set, actions that need credentials (like deploy) can access the auth IDs stored in the credentials_ci.p12 file.

For more information, see Execution Context for Secure Credentials Storage.

There was an error with the private key used to authenticate.

The private key does not match the certificate ID <certificateId >.

When you're using machine-to-machine authentication, the private key and certificate ID you entered don't match.

Ensure that you're using the right private key and certificate ID together.

There was an error with the private key used to authenticate. Verify the contents of the private key.

When you're using machine-to-machine authentication, the private key file you specified is either corrupted or not valid.

Generate a new certificate. For information about how to obtain the certificate ID, see OAuth 2.0 Authentication for SuiteCloud SDK.

There was an error with the certificate ID used to authenticate.

Verify that certificate ID <certificateId> is valid and not expired or revoked in account <accountId>.

When you're using machine-to-machine authentication, the certificate ID you specified is not valid.

Ensure that OAuth 2.0 is enabled in your account. For more information, see Enable the OAuth 2.0 Feature.

Verify that the certificate ID is valid. In your NetSuite account, go to Setup > Integration > Manage Authentication > OAuth 2.0 Client Credentials (M2M) Setup.

Credentials and Passkey Errors

Error Message

Scenario

Solution

The current passkey cannot decrypt the credentials file <credentialsFile>.

Try deleting the file and setting up your account again.

The current passkey isn't the same as the one used to create the existing credentials file.

If the passkey is set in the environment variable SUITECLOUD_FALLBACK_PASSKEY or SUITECLOUD_CI_PASSKEY, ensure that you've got the right passkey.

If you don't have the passkey for the existing credentials file, delete the credentials file from C:\Users\<username>\.suitecloud-sdk, then set up your account again with any SuiteCloud SDK tool.

Note:

When you delete the credentials file, any authentication IDs you set up before will be lost.

When you re-authenticate, a new credentials file will be generated with the correct passkey. If the passkey is set in the SUITECLOUD_FALLBACK_PASSKEY or SUITECLOUD_CI_PASSKEY environment variable, that passkey will be used to encrypt the new credentials file. Otherwise, if you use browser-based authentication, a new passkey will be generated and stored in the secure storage.

The passkey required to decrypt your credentials is missing.

Try deleting the credentials file <credentialsFile> and setting up your account again.

The passkey is missing or there is a problem with the Oracle NetSuite: Account Credentials entry in your OS secure storage.

Delete the credentials file from the C:\Users\<username>\.suitecloud-sdk folder, then set up your account again using any of the SuiteCloud SDK tools.

Note:

When you delete the credentials file, any authentication IDs you set up before will be lost.

When you re-authenticate, a new credentials file and passkey will be generated, and the passkey will be stored in the secure storage.

Credentials passkey could not be retrieved from the secure storage.

Try deleting the current credentials file <credentialsFile> and setting up your account again.

There was a problem getting the passkey from secure storage.

Delete the credentials file from the C:\Users\<username>\.suitecloud-sdk folder, then set up your account again using any of the SuiteCloud SDK tools.

Note:

When you delete the credentials file, any authentication IDs you set up before will be lost.

The credentials passkey set in the environment variable <environmentVariable> must be between 32 and 100 alphanumeric characters.

The passkey you set in the environment variable doesn't meet the requirements.

Use a passkey with 32 to 100 alphanumeric characters.

The credentials passkey set in secure storage must be between 32 and 100 alphanumeric characters.

The passkey stored in secure storage doesn't meet the requirements.

Delete the credentials file from the C:\Users\<username>\.suitecloud-sdk folder, then set up your account again using any of the SuiteCloud SDK tools.

Note:

When you delete the credentials file, any authentication IDs you set up before will be lost.

Execution Context Errors

Error Message

Scenario

Solution

The following environment variables are currently set: <environmentVariables>.

The operation you are trying to perform is not allowed with the current environment variable configuration.

Your current setup doesn't match any valid execution context.

For example, both SUITECLOUD_CI_PASSKEY and SUITECLOUD_FALLBACK_PASSKEY environment variables are set.

Check your environment variable setup for the execution context you want to use, and make sure it's set up right. For more information, see the Execution Context for Secure Credentials Storage table.

In the current execution context, you can perform only machine-to-machine authentication or operations that do not require authentication.

Only the SUITECLOUD_CI_PASSKEY environment variable is set, and you're trying to do operations that require NetSuite authentication.

If you want to use machine-to-machine authentication (CI/CD), set the SUITECLOUD_CI environment variable to 1.

If you want to use browser-based authentication, remove the SUITECLOUD_CI_PASSKEY environment variable.

Machine-to-machine authentication is not allowed for the current execution context.

You're trying to run machine-to-machine authentication, but the required environment variables aren't set up right.

Ensure that the you've set these environment variables:

  • SUITECLOUD_CI=1

  • SUITECLOUD_CI_PASSKEY (must contain 32 to 100 alphanumeric characters)

Browser-based authentication is not allowed for the current execution context.

The SUITECLOUD_CI_PASSKEY environment variable is set, and you're trying to run browser-based authentication.

Remove the SUITECLOUD_CI_PASSKEY environment variable.

Secure storage is available, but the SUITECLOUD_FALLBACK_PASSKEY is set. Remove the fallback passkey to use secure storage.

The SUITECLOUD_FALLBACK_PASSKEY environment was set when secure storage wasn't available, but it wasn't removed after you fixed secure storage.

Remove the SUITECLOUD_FALLBACK_PASSKEY environment variable.

Related Topics

General Notices