npm · Schema

TokenCreateRequest

Request body for creating a new npm access token.

PackagesJavaScriptNode.jsPackage ManagementRegistrySecurity

Properties

Name Type Description
password string The user's npm account password, required to authorize token creation.
readonly boolean Set to true to create a read-only token.
automation boolean Set to true to create an automation token that bypasses two-factor authentication for publishing.
cidr_whitelist array List of CIDR IP ranges to restrict where this token can be used from.
View JSON Schema on GitHub

JSON Schema

npm-tokencreaterequest-schema.json Raw ↑ 
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/TokenCreateRequest",
  "title": "TokenCreateRequest",
  "type": "object",
  "description": "Request body for creating a new npm access token.",
  "required": [
    "password"
  ],
  "properties": {
    "password": {
      "type": "string",
      "description": "The user's npm account password, required to authorize token creation."
    },
    "readonly": {
      "type": "boolean",
      "description": "Set to true to create a read-only token.",
      "default": false
    },
    "automation": {
      "type": "boolean",
      "description": "Set to true to create an automation token that bypasses two-factor authentication for publishing.",
      "default": false
    },
    "cidr_whitelist": {
      "type": "array",
      "description": "List of CIDR IP ranges to restrict where this token can be used from.",
      "items": {
        "type": "string",
        "pattern": "^[0-9]+\\.[0-9]+\\.[0-9]+\\.[0-9]+/[0-9]+$"
      }
    }
  }
}