Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,7 @@ redirect_from:

An access token is an alternative to using your username and password for authenticating to npm when using the API or the npm command-line interface (CLI). An access token is a hexadecimal string that you can use to authenticate, and which gives you the right to install and/or publish your modules.

There are two types of access tokens available:

- [Legacy tokens](#about-legacy-tokens)
- [Granular access tokens](#about-granular-access-tokens)
As of November 2025, only [Granular access tokens](#about-granular-access-tokens) are supported. Legacy access tokens have been removed.

You can create access tokens to give other tools (such as continuous integration testing environments) access to your npm packages. For example, GitHub Actions provides the ability to store [secrets](https://docs.github.com/en/actions/configuring-and-managing-workflows/creating-and-storing-encrypted-secrets), such as access tokens, that you can then use to authenticate. When your workflow runs, it will be able to complete npm tasks as you, including installing private packages you can access.

Expand All @@ -25,13 +22,19 @@ You can work with tokens from the web or the CLI, whichever is easiest. What you
npm token commands let you:

- View tokens for easier tracking and management
- Create new legacy tokens
- Create new legacy tokens (deprecated)
- Limit access according to IP address ranges (CIDR)
- Delete/revoke tokens

For more information on creating and viewing access tokens on the web and CLI, see "[Creating and viewing access tokens][create-token]".

## About legacy tokens
## About legacy tokens (Deprecated)

<Note variant="danger">

**Warning:** Legacy access tokens were removed on November 5, 2025.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We might wanna add another note saying npm token is not deprecated and it will eventually work with Granular tokens.

Copy link
Contributor Author

@karenjli karenjli Nov 4, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We removed all the documentation about npm token in https://npm-bb091a8293-15913497.drafts.github.io/creating-and-viewing-access-tokens

This is the current verbiage under Creating tokens with the CLI

Note: You cannot create granular access tokens from the CLI. You must use the website to generate these types of tokens. For more information, see "Creating granular access tokens on the website."

We can change it and mention npm token there as follow

Note: You cannot create granular access tokens from the CLI currently. You must use the website to generate these types of tokens. Support for creating granular access token via npm token CLI command will be added in the future. For more information, see "Creating granular access tokens on the website."


</Note>

Legacy tokens are created with the same permissions as the user who created them. The npm CLI automatically generates and uses a publish token when you run `npm login`.

Expand All @@ -52,10 +55,13 @@ Granular access tokens allow you to restrict access provided to the token based
- Set a token expiration date
- Limit token access based on IP address ranges
- Select between **read-only** or **read and write** access
- Configure a token to **Bypass 2FA** requirements

You can create up to 1000 granular access tokens on your npm account. You can set how long your token is valid for, at least one day in the future. Each token can access up to 50 organizations, and up to either 50 packages, 50 scopes, or a combination of 50 packages and scopes. Access tokens are tied to users’ permission; hence it cannot have more permission than the user at any point in time. If a user has their access revoked from a package or an org., their granular access token also will have its access revoked from those packages or org.

When you give a token access to an organization, the token can only be used for managing organization settings and teams or users associated with the organization. It does not give the token the right to publish packages managed by the organization.

The Bypass 2FA capability applies to tokens with write access and is set to false by default at token creation. When the Bypass 2FA option is set to true, this setting takes precedence over account-level and package-level 2FA settings. This means that even if account-level 2FA is enabled and/or package-level 2FA is required, 2FA will still be bypassed when using the token. Do not set Bypass 2FA to true if a package or organization requires fully enforced 2FA.

[create-token]: creating-and-viewing-access-tokens
[secure-token]: using-private-packages-in-a-ci-cd-workflow#securing-your-token
Original file line number Diff line number Diff line change
Expand Up @@ -8,37 +8,6 @@ You can [create](#creating-access-tokens) and [view](#viewing-access-tokens) acc

## Creating access tokens

### Creating legacy tokens on the website

<Note>

**Note:** For greater security, we recommend using [granular access tokens](#creating-granular-access-tokens-on-the-website) instead of legacy read-only tokens or legacy automation tokens. For CI/CD workflows, consider using [trusted publishing](/trusted-publishers), which eliminates the need for long-lived tokens entirely.

</Note>

1. In the upper right corner of the page, click your profile picture, then click **Access Tokens**.

<Screenshot src="/integrations/integrating-npm-with-external-services/tokens-profile.png" alt="Screenshot of the account menu with the tokens link selected" />

2. Click **Generate New Token**, then select **legacy token** from the dropdown menu.

<Screenshot src="/integrations/integrating-npm-with-external-services/create-token.png" alt="Screenshot of the create new token button" />

3. (Optional) Name your token.

4. Select the type of access token:
- **Read-only**: A read-only token can only be used to download packages from the registry. It will have permission to read any private package that you have access to. This is recommended for automation and workflows where you are installing packages, but not publishing new ones.

- **Automation**: An automation token can download packages and publish new ones, but if you have two-factor authentication (2FA) configured on your account, it will **not** be enforced. You can use an automation token in continuous integration workflows and other automation systems to publish a package even when you cannot enter a one-time passcode. For enhanced security in CI/CD workflows, consider using [trusted publishing](/trusted-publishers) instead, which eliminates the need for long-lived tokens.

- **Publish**: A publish token can perform any action on your behalf, including downloading packages, publishing packages, and changing user settings or package settings. If you have two-factor authentication configured on your account, you will be required to enter a one-time passcode when using a publish token. This is recommended for interactive workflows such as a CLI.

<Screenshot src="/integrations/integrating-npm-with-external-services/token-level-select.png" alt="Screenshot of the access level selection" />

5. Click **Generate Token**.

6. Copy the token from the top of page.

### Creating granular access tokens on the website

1. In the upper right corner of the page, click your profile picture, then click **Access Tokens**.
Expand All @@ -53,68 +22,46 @@ You can [create](#creating-access-tokens) and [view](#viewing-access-tokens) acc

4. (Optional) In the **Description** field, enter a description for your token.

5. In the **Expiration** field, enter a token expiration period. The date must be at least 1 day in the future.
5. (Optional) Check the **Bypass two-factor authentication** checkbox if you want this token to bypass 2FA requirements for write actions.
- This setting is unchecked (false) by default
- By checking this box, the token will bypass 2FA for write actions even if 2FA is enabled at the account or package level

6. (Optional) In the **Allowed IP Ranges** field, enter IP address ranges to restrict your access token to. You must use [CIDR][cidr-wiki] notation to enter IP address ranges. To add more than one allowed IP range, click **Add IP Range** and enter an IP range in the new text field.
6. In the **Expiration** field, enter a token expiration period. The date must be at least 1 day in the future.

7. (Optional) In the **Allowed IP Ranges** field, enter IP address ranges to restrict your access token to. You must use [CIDR][cidr-wiki] notation to enter IP address ranges. To add more than one allowed IP range, click **Add IP Range** and enter an IP range in the new text field.

<Screenshot src="/integrations/integrating-npm-with-external-services/granular-access-token-ip-range.png" alt="Screenshot of the allowed IP ranges section" />

7. (Optional) In the **Packages and scopes** section, configure your token's access to packages and scopes.
8. (Optional) In the **Packages and scopes** section, configure your token's access to packages and scopes.
- In the **Permissions** dropdown menu, select **No access**, **Read-only**, or **Read and write**.
- Under **Select Packages**, select either:
- **All Packages** to grant the token access to all packages the user account has access to.
- **Only select packages and scopes** to choose up to 50 specific packages or scopes to give the token access to. Then select specific packages or scopes from the dropdown menu.

<Screenshot src="/integrations/integrating-npm-with-external-services/granular-access-token-packages-scopes.png" alt="Screenshot of the packages and scopes section" />

8. (Optional) In the **Organizations** section, configure your token's access to organizations.
9. (Optional) In the **Organizations** section, configure your token's access to organizations.
- In the **Permissions** dropdown menu, select **No access**, **Read-only**, or **Read and write**.
- Under **Select organizations**, select the organizations you want to grant your token access to.

<Screenshot src="/integrations/integrating-npm-with-external-services/granular-access-token-organizations.png" alt="Screenshot of the organizations section" />

_**Note**: When you give a token access to an organization, the token can only be used for managing organization settings and teams or users associated with the organization. It does not give the token the right to publish packages managed by the organization._

9. Review the token summary, then click **Generate Token**.
10. Review the token summary, then click **Generate Token**.

<Screenshot src="/integrations/integrating-npm-with-external-services/granular-access-token-summary.png" alt="Screenshot of the granular access token summary and the generate token button" />

10. Copy the token from the top of page.
11. Copy the token from the top of page.

### Creating tokens with the CLI

You can create tokens with **read-only** permissions or **read and publish** permissions with the CLI.

<Note>

**Note:** You cannot create legacy automation tokens or granular access tokens from the CLI. You must use the website to generate these types of tokens. For more information, see "[Creating legacy tokens on the website](#creating-legacy-tokens-on-the-website)" and "[Creating granular access tokens on the website](#creating-granular-access-tokens-on-the-website)."
**Note:** You cannot create granular access tokens from the CLI currently. You must use the website to generate these types of tokens. Support for creating granular access tokens via `npm token` CLI command will be added in the future. For more information, see "[Creating granular access tokens on the website](#creating-granular-access-tokens-on-the-website)."

</Note>

- **Read-only:** Tokens that allow installation and distribution only, but no publishing or other rights associated with your account.
- **Publish:** The default setting for new tokens, and most permissive token type. Publish tokens allow installation, distribution, modification, publishing, and all rights that you have on your account.

In addition, you can specify that the token is only valid for a specific IPv4 address range, using [CIDR][cidr-wiki] notation. The token will only be valid when used from the specified IP addresses.

1. To create a new token, on the command line, run:
- `npm token create` for a read and publish token
- `npm token create --read-only` for a read-only token
- `npm token create --cidr=[list]` for a CIDR-restricted read and publish token. For example, `npm token create --cidr=192.0.2.0/24`
- `npm token create --read-only --cidr=[list]` for a CIDR-restricted read-only token
2. When prompted, enter your password.
3. If you have enabled [two-factor authentication][tfa], when prompted, enter a one-time password.
4. Copy the token from the **token** field in the command output.

#### CIDR-restricted token errors

If the CIDR string you enter is invalid or in an inappropriate format, you will get an error similar to the one below:

```
npm ERR! CIDR whitelist contains invalid CIDR entry: X.X.X.X./YY,Z.Z.. . .
```

Make sure you are using a valid IPv4 range and try creating the token again.

## Viewing access tokens

<Note>
Expand All @@ -141,8 +88,7 @@ npm token list

- **id:** Use the token ID to refer to the token in commands.
- **token:** The first digits of the actual token.
- **create:** Date the token was created.
- **readonly:** If yes, indicates a read-only token. If no, indicates a token with both read and publish permissions.
- **created:** Date the token was created.
- **CIDR whitelist:** Restricts token use by IP address.

[tfa]: about-two-factor-authentication
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,19 @@ redirect_from:
- /revoking-authentication-tokens
---

To keep your account and packages secure, we strongly recommend revoking (deleting) tokens you no longer need or that have been compromised. You can revoke any token you have created.
To keep your account and packages secure, we strongly recommend revoking (deleting) tokens you no longer need or that have been compromised. You can revoke any token you have created, including granular access tokens.

## Revoking tokens on the website

1. In the upper right corner of the page, click your profile picture, then click **Access Tokens**.

2. Find the token you want to delete in the token list.

3. Click the **×** button next to the token, or select multiple tokens and click **Delete Selected Tokens**.

4. Confirm the deletion when prompted.

## Revoking tokens using the CLI

1. To see a list of your tokens, on the command line, run:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,44 +25,48 @@ Create a new access token that will be used only to access npm packages from a C

When generating an access token for use in a continuous integration environment, we recommend using a granular access token with limited access to provide greater security.

If you use a legacy token instead, by default, `npm token create` will generate a token with both read and write permissions. We recommend creating a read-only token:
For most CI workflows that only install dependencies and run tests, a **read-only** granular access token is sufficient and most secure.

```
npm token create --read-only
```
<Note>

**Note:** If your CI workflow requires write operations (such as publishing test packages), you may need a granular access token with read and write permissions and bypass 2FA enabled to prevent automated workflows from being blocked by 2FA prompts. However, we strongly recommend using read-only tokens whenever possible and reserving bypass 2FA for deployment workflows only.

</Note>

<Note variant="danger">

For more information on creating access tokens, including CIDR-whitelisted tokens, see "[Creating an access token][create-token]".
**Warning:** Legacy access tokens are removed as of November 2025.

</Note>

For more information on creating granular access tokens, including CIDR-whitelisted tokens, see "[Creating and viewing access tokens][create-token]".

### Continuous deployment

For publishing packages in continuous deployment environments, we strongly recommend using [trusted publishing](/trusted-publishers) when available, as it provides enhanced security without requiring token management.

If trusted publishing is not available for your CI/CD provider, you may create an [automation token][create-token] on the website. This will allow you to publish even if you have two-factor authentication enabled on your account.
If trusted publishing is not available for your CI/CD provider, you can create a [granular access token with bypass 2FA enabled][create-token] on the website. This will allow you to publish even if you have two-factor authentication enabled on your account.

### Interactive workflows
<Note>

If your workflow produces a package, but you publish it manually after validation, then you will want to create a token with read and write permissions, which are granted with the standard token creation command:
**Security considerations for bypass 2FA:**

```
npm token create
```
- Only enable bypass 2FA when necessary for automated publishing workflows
- Use restrictive permissions and short expiration dates
- Consider IP address restrictions and regular token rotation
- Use trusted publishing instead of bypass 2FA tokens whenever possible

### CIDR whitelists
</Note>

For increased security, you may use a CIDR-whitelisted token that can only be used from a certain IP address range. You can use a CIDR whitelist with a read and publish token or a read-only token:
### Interactive workflows

```
npm token create --cidr=[list]
npm token create --read-only --cidr=[list]
```
If your workflow produces a package, but you publish it manually after validation, then you will want to create a granular access token with read and write permissions. See "[Creating and viewing access tokens][create-token]" for instructions.

Example:
### CIDR whitelists

```
npm token create --cidr=192.0.2.0/24
```
For increased security, you may use a CIDR-whitelisted granular access token that can only be used from a certain IP address range. You can configure IP address restrictions when creating your granular access token on the website.

For more information, see "[Creating and viewing authentication tokens][create-token]".
For more information, see "[Creating and viewing access tokens][create-token]".

## Set the token as an environment variable on the CI/CD server

Expand Down
Loading
Loading