Sign in
access

Invite a human into this organisation with a local credential.

Changed on

The account-creation path the human-auth ADR names ("accounts are created by invitation from a manage-members holder"). In ONE transaction: a human principal and an account with the given login handle are created, the optional role template is expanded into grants at organisation scope exactly as applyOrgTemplate would write them, and a credential-establishment authority is minted for the new account with issuer invitation and the credential-reset lifetime. The authority is returned once and never re-displayed: hand it to the invitee out of band, who consumes it at establishCredential and then signs in like anyone else.

No session, no assurance and no identity link are created. An invitation carries no email and no delivery channel of its own. A username already in use is a conflict.

post/api/v1/orgs/{org}/invitations

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/v1/orgs/{org}/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