access

Invite a human at instance scope with a local credential.

Changed on

The instance-scope form of inviteOrgMember: the same one-transaction account creation and authority mint, authorized by manage-members held at instance scope. The optional template is expanded at instance scope (operator), so this is how a second instance operator comes to exist without host access. Without a template the account can sign in and see nothing until someone grants it something.

A username already in use is a conflict.

post/api/v1/instance/invitations

Request

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

Request body

usernamestring required

The invitee's local login handle; globally unique.

display_namestring

Defaults to the username.

template'viewer' | 'editor' | 'publisher' | 'revealer' | 'historian' | 'maintainer' | 'admin' | 'operator'

The closed v1 role template set.

Response

The invited principal and its single-use authority.

principal_idstring required

A prefixed UUIDv7, e.g. org_0198….

account_idstring required

A prefixed UUIDv7, e.g. org_0198….

authoritystring required

The single-use credential-establishment authority for the new account, returned once. Issuing it creates no session. It establishes the account's first credential: a password, or an OIDC/OAuth2 identity through a claim start. Hand it to the invitee out of band.

expires_atstring date-time required

RFC 3339 UTC, microsecond precision.

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