• Routes
• Objects
  • Error
  • Date
  • Roster
  • Membership Detail
  • Change Membership Request
• API Methods
  • Org Roster
  • Org Membership Replace
  • Org Membership Delete

Attributes marked with // * may not always appear in the object.

An error. The message property is contains a user-facing string.

{
  message: String
}

All Date objects will be represented as ISO-8601 UTC datetime strings.

An object mapping usernames to org roles.

{
  [username]: "developer" |
              "admin" |
              "owner"
}

{
  org: {
    name: String,
    size: Number    // the current roster count of the org
  },
  user: String,
  role: "developer" |
        "admin" |
        "owner"
}

// "*" indicates a field that may not always appear
{
  "user": String,
  "role": "developer" |   // * -- defaults to "developer" if not given
          "admin" |
          "owner" |
          "team-admin" |  // archaic, synonymous with "admin"
          "super-admin"   // archaic, synonymous with "owner"
}

curl -u user:pass \
     https://registry.npmjs.org/-/org/SCOPE/user

Get the set of members for the org identified by SCOPE. Returns a Roster object on success.

curl -u user:pass \
     -X PUT \
     -H 'content-type: application/json' \
     -d <Change Membership Request> \
     https://registry.npmjs.org/-/org/SCOPE/user

Add or change a user's membership in the org identified by SCOPE. Takes a Change Membership Request and returns a Membership Detail object.

Returns:

• 201 with a Membership Detail object on success.
• 400 with an Error if user is omitted from the request body.

curl -u user:pass \
     -X DELETE \
     -H 'content-type: application/json' \
     -d {"user": USERNAME} \
     https://registry.npmjs.org/-/org/SCOPE/user

Remove a user from an org. The user will be removed from all teams managed by the org.

Returns:

• 204 on success.