instance

One connection's metadata.

Changed on
get/api/v1/instance/connections/{connection}

Request

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

Response

The connection.

idstring required

A prefixed UUIDv7, e.g. org_0198….

principalstring required
labelstring required

Names the intended peer for the audit trail. Descriptive, NOT enforced: this instance cannot verify who holds the token.

kind'hikyo-token' | 'oidc-federation' required

How a credential authenticates its service account. The discriminator exists before a second kind does, so adding one is a new row type rather than a schema change.

prefix_hintstring required

The leading, non-secret slice of the minted value, so two connections are distinguishable in a list without either being retrievable.

lifetime'finite' | 'indefinite' required

indefinite is a VALUE, not a large number: it is unreachable by raising the instance ceiling, and is admitted only under a separate, default-off instance opt-in.

expires_atstring date-time

RFC 3339 UTC, microsecond precision.

created_atstring date-time required

RFC 3339 UTC, microsecond precision.

created_bystring required
revoked_atstring date-time

RFC 3339 UTC, microsecond precision.

last_used_atstring date-time

RFC 3339 UTC, microsecond precision.

liveboolean required

Whether it authenticates right now, under the current credential epoch.

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

  • 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 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