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

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 @@ -55,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.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Changes are highlighted in orange box

Image
[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 @@ -22,33 +22,37 @@ 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.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added the bypass 2FA step to the instruction

Image

### Creating tokens with the CLI

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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Previous documentation doesn't include instruction for revoking tokens via UI
Image


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,50 +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.

<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">

**Warning:** Legacy access tokens are removed as of November 2025.

</Note>

```
npm token create --read-only
```

For more information on creating access tokens, including CIDR-whitelisted tokens, see "[Creating an access token][create-token]".
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
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added bypass 2FA implications and recommendations
Image


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,21 @@ import shared from '~/shared.js'

To protect your packages, as a package publisher, you can require everyone who has write access to a package to have two-factor authentication (2FA) enabled. This will require that users provide 2FA credentials in addition to their login token when they publish the package. For more information, see "[Configuring two-factor authentication][config-2fa]".

You may also choose to allow publishing with either two-factor authentication _or_ with [automation tokens][creating-automation-token]. This lets you configure automation tokens in a CI/CD workflow, but requires two-factor authentication from interactive publishes.
You may also choose to allow publishing with either two-factor authentication _or_ with [granular access tokens with bypass 2FA enabled][creating-granular-access-token]. This lets you configure tokens in a CI/CD workflow, but requires two-factor authentication from interactive publishes.

For CI/CD workflows, consider using [trusted publishing](/trusted-publishers), which provides secure, token-free publishing that automatically enforces strong authentication without requiring manual token management.

<Note>

**Important notes about granular access tokens:**

- Bypass 2FA configuration is set at token creation
- When **bypass 2FA is disabled**: The system will check account-level and package-level settings to determine if 2FA is required
- When **bypass 2FA is enabled**: The token will bypass all 2FA requirements at all times, regardless of account-level or package-level 2FA settings
- When **Require two-factor authentication and disallow tokens** is selected at the package level, granular access tokens cannot be used regardless of their bypass 2FA setting

</Note>

## Configuring two-factor authentication

1. <>{shared['user-login'].text}</>
Expand All @@ -26,16 +37,15 @@ For CI/CD workflows, consider using [trusted publishing](/trusted-publishers), w
1. **Dont require two-factor authentication**
With this option, a maintainer can publish a package or change the package settings whether they have two-factor authentication enabled or not. This is the least secure setting.

2. **Require two-factor authentication or automation tokens or granular access token**
With this option, maintainers must have two-factor authentication enabled for their account. If they publish a package interactively, using the `npm publish` command, they will be required to enter 2FA credentials when they perform the publish. However, maintainers may also create an [automation token][creating-automation-token] or a [granular access token][creating-granular-access-token] and use that to publish. A second factor is _not_ required when using a token, making it useful for continuous integration and continuous deployment workflows.
2. **Require two-factor authentication or granular access tokens**
With this option, maintainers must have two-factor authentication enabled for their account. If they publish a package interactively, using the `npm publish` command, they will be required to enter 2FA credentials when they perform the publish. However, maintainers may also create a [granular access token with bypass 2FA enabled][creating-granular-access-token] and use that to publish. A second factor is _not_ required when using these specific token types, making them useful for continuous integration and continuous deployment workflows.

3. **Require two-factor authentication and disallow tokens**
With this option, a maintainer must have two-factor authentication enabled for their account, and they must publish interactively. Maintainers will be required to enter 2FA credentials when they perform the publish. Automation tokens and granular access tokens cannot be used to publish packages.
With this option, a maintainer must have two-factor authentication enabled for their account, and they must publish interactively. Maintainers will be required to enter 2FA credentials when they perform the publish. Granular access tokens cannot be used to publish packages, regardless of their bypass 2FA setting.
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This page explains the nuance of when 2FA will be prompted
Image

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Also, references of automation tokens are removed as we are deprecating it


<Screenshot src="/packages-and-modules/securing-your-code/2fa-package-setting.png" alt="Screenshot showing the require two-factor option for a package" />

5. Click **Update Package Settings**.

[config-2fa]: configuring-two-factor-authentication
[creating-automation-token]: creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website
[creating-granular-access-token]: creating-and-viewing-access-tokens#creating-granular-access-tokens-on-the-website
Loading