Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

npm Trusted Publishers API

Configure trusted publisher settings for packages to enable OIDC token exchange from CI/CD providers without long-lived npm tokens.

npm Trusted Publishers API is one of 10 APIs that npm publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Trusted Publishers. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 2 paths, and defines 3 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.

Requests are made against a single base URL, https://registry.npmjs.org.

3 operations 2 paths 3 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.0.0
Base URL
https://registry.npmjs.org
Authentication
HTTP Bearer
Terms of Service
Resource Areas
1

Authentication & Security 1

npm Trusted Publishers API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (bearerAuth). By default, every request must be authenticated.

  • bearerAuth — npm access token provided as a Bearer token.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Trusted Publishers 3

Configure trusted publisher settings for packages to enable OIDC token exchange from CI/CD providers without long-lived npm tokens.

GET
/-/npm/v1/security/trusted-publishers/packages/{package}
List trusted publishers for a package
listTrustedPublishers 1 param → 200401404
POST
/-/npm/v1/security/trusted-publishers/packages/{package}
Add a trusted publisher for a package
addTrustedPublisher 1 param body → 201400401403
DELETE
/-/npm/v1/security/trusted-publishers/packages/{package}/{publisher_id}
Remove a trusted publisher from a package
removeTrustedPublisher 2 params → 204401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are TrustedPublisher (7 properties), TrustedPublisherRequest (5 properties), Error (2 properties). Each schema is shown below with its type and property counts.

TrustedPublisherRequest
object
Request body for adding a trusted publisher configuration.
5 properties 3 required
TrustedPublisher
object
A trusted publisher configuration that allows a CI/CD provider to publish a package using OIDC token exchange.
7 properties
Error
object
An error response from the npm API.
2 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

npm-trusted-publishers-api-openapi.yml Raw ↑

Other APIs npm publishes across the network.

npm Registry API
npm Hooks API
npm Provenance
npm Downloads API
npm OIDC API
npm Packages API
npm Search API
npm Tokens API