Sign in
access

Create or replace the instance registration policy.

Changed on

A full replacement; the caller becomes the authority principal (any edit reassigns it, #579 d4). Reauthentication-gated: proof carries a TOTP code, or the password where no factor is enrolled, consumed in the write transaction. No session is purged. Write-time preconditions refuse 400 naming the failing item in detail: no-public-origin, mailer-unconfigured, provider-disabled, provider-kind-unsupported, provider-missing-email-scope, cap-zero, template-not-org-applicable, with the provider as <kind>:<slug> where one is involved. email is never an allowlist claim.

put/api/v1/instance/registration-policy

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/instance/registration-policy
  • Auth: HTTP bearer

Request body

proofstring required

The reauthentication proof: a TOTP code, or the account password where no factor is enrolled.

Response

The saved policy with its live state.

idstring required
orgstring

The organisation; absent for the instance policy.

authority_principal_idstring required

The standing delegation's authority principal (empty when unassigned); re-checked against its current grants on every read and every sign-up.

state'active' | 'inactive' required
inactive_cause'authority-lost' | 'authority-unassigned' | 'precondition'
inactive_preconditionstring

When inactive_cause is precondition, the failing precondition by name, with the provider as <kind>:<slug> where one is involved.

fresh_org_countinteger

For a fresh-org landing, the live orgs this policy minted (the n of n / cap).

row_versioninteger required
created_atstring date-time required
updated_atstring date-time required

Changes

  • 8a6e250b7105Revision changes
    • info

      added subschema #1 subschema #2 to the / request property anyOf list

    • info

      added subschema #1 subschema #2 to the / response property anyOf list for the response status

  • 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