---
title: "Update scope"
method: PATCH
path: "/scopes/{scope}"
---

# Update scope

`PATCH /scopes/{scope}`

Updates the details of a scope

## Path parameters

- `scope` string, required — The name of a scope. This must not be @ prefixed.

## Request body

- union
  - object
    - `ghActionsVerifyActor` boolean, required — Whether to verify the actor of a GitHub Actions run when authenticating publishing with a GitHub Actions OIDC token.
  - object
    - `requirePublishingFromCI` boolean, required — Whether to require publishing from a CI environment. This disables publishing from a local environment.

## Response `200`

OK

- Scope
  - `scope` string, required — The name of a scope. This must not be @ prefixed.
  - `creator` User
    - `id` string, uuid, required — The ID of a user.
    - `name` string, required — The user's display name.
    - `email` string — The user's email address.
    - `avatarUrl` string, required — The URL to the user's avatar.
    - `githubId` integer — The user's GitHub ID.
    - `isBlocked` boolean — Whether the user is blocked from using the registry.
    - `isStaff` boolean — Whether the user is a staff member.
    - `scopeUsage` integer — The number of scopes the user created.
    - `scopeLimit` integer — The maximum number of scopes the user can create.
    - `inviteCount` integer — The number of invites pending for the user.
    - `createdAt` string, date-time, required — The date and time when the user profile was created.
    - `updatedAt` string, date-time, required — The date and time when the user profile was last updated.
  - `quotas` object
    - `packageUsage` integer — The number of packages in the scope.
    - `packageLimit` integer — The maximum number of packages allowed in the scope.
    - `newPackagePerWeekUsage` integer — The number of new packages created in the scope in the last week.
    - `newPackagePerWeekLimit` integer — The maximum number of new packages allowed to be created in the scope in a week.
    - `publishAttemptsPerWeekUsage` integer — The number of times packages in the scope have been published in the last week.
    - `publishAttemptsPerWeekLimit` integer — The maximum number of times packages in the scope can be published in a week.
  - `ghActionsVerifyActor` boolean — Whether to verify the actor of a GitHub Actions run when authenticating publishing with a GitHub Actions OIDC token.
  - `requirePublishingFromCI` boolean — Whether to require publishing from a CI environment. This disables publishing from a local environment.
  - `createdAt` string, date-time, required — The date and time when the scope was created.
  - `updatedAt` string, date-time, required — The date and time when the scope was last updated.

## Other responses

- `400` — Invalid request
- `401` — Unauthorized
- `403` — User is not scope admin
- `404` — Scope not found

## Changes

- **2024-03-14** `cebb48e7803a` — 1 breaking, 1 warning, 2 info
  - the request's body type/format changed from `object`/`` to ``/``
  - removed the request property `ghActionsVerifyActor`
  - added `subschema #1, subschema #2` to the request body `oneOf` list
  - added the optional property `requirePublishingFromCI` to the response with the `200` status
- **2024-02-28** `f8d3b912d946` — 4 breaking, 1 warning, 4 info
  - added the new required request property `ghActionsVerifyActor`
  - removed `subschema #1, subschema #2, subschema #3` from the request body `oneOf` list
  - the request's body type/format changed from ``/`` to `object`/``
  - removed the required property `description` from the response with the `200` status
  - …5 more

[Change history](https://skmtc.dev/jsr-io/apis/jsr-api/changes/scopes/:scope/patch.md)

---

[API](https://skmtc.dev/jsr-io/apis/jsr-api.md) · [All operations](https://skmtc.dev/jsr-io/apis/jsr-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/jsr-io/jsr-api/revisions/cebb48e7803a/schema)