hierarchy

Rename an organisation.

Changed on

Requires manage-members at the addressed organisation. Organisation administrators can rename their own organisation; instance-level manage-members grants satisfy this by inheritance. A bare instance-config grant does not authorize renaming. Refusal is the uniform 404. Deleting remains an instance-config operation.

patch/api/v1/orgs/{org}

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/orgs/{org}
  • Auth: HTTP bearer

Request body

namestring required

A display name for an organisation, project or environment. Identity is the immutable id, so this is a label and a rename never breaks a reference. The 128-byte bound is the one the organisation contract has carried since the first slice, adopted for every entity so there is one number rather than four; no ADR fixes a per-entity name length. The grammar itself (non-empty, no control characters, no surrounding whitespace) is enforced in the domain rather than restated as a pattern here — two grammars would be two things to keep in sync.

The bound is 128 UTF-8 BYTES, and the server is authoritative. maxLength below counts Unicode code points, which is the only length JSON Schema can express, so a name of 100 emoji satisfies this schema and is still refused by the server with bad_request. Clients that want to pre-validate must measure the UTF-8 encoding, not the string length.

acknowledgementsstring[]

Secret-scanning acknowledgement tokens (#74). On a value write, a keep-as-config token dismisses a Surface-1 warning for exactly that value. On a declaration write, one override token per finding is re-scanned against the current content; a stale, version-skewed, or surplus token is rejected by name. There is no blanket ignore-all input.

Response

The renamed organisation.

idstring required

A prefixed UUIDv7, e.g. org_0198….

namestring required
activeboolean required
metadataobject nullable
created_atstring date-time required

RFC 3339 UTC, microsecond precision.

origin'manual' | 'registration' required

How the org came to exist (#585 d8): manual (an operator's create) or registration (a sign-up under a registration policy, a self-served org). Typed on the row, never editable.

registration_policy_idstring nullable

The registration policy that minted the org, a trail pointer with no foreign key (the org keeps it after the policy is deleted); null for a manual org.

Changes

  • 54b2780eec85Revision changes
    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

    • info

      added the optional property / to the response with the status

  • f84a1cd8a05aRevision changes
    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new payload_too_large enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status

    • warning

      added the new unprocessable enum value to the / response property for the response status