Create invite
Issues an invite token for an existing person so they can later create Connect login credentials. This is the first step of the user-onboarding flow:
- The person already exists in Register (created via Create Person or imported from a customer feed).
- An admin calls this endpoint with the person's
idPersonand receives aninviteToken. - The token is delivered to the new user (e-mail link, magic link, QR code, etc.).
- The user submits the token plus their chosen
loginandpasswordto Connect · Create User. - Connect decrypts the token, verifies the organization +
personId, and writes the User record.
The token is URL-encoded (so it can ride in a query string) and RSA-encrypted with Connect's public key — only Connect can decrypt it, and only for the organization the token was issued under. It's single-use: once a User is created, the token can't be redeemed again.
Try-it values populated from environment ACME (Demo)
Authentication
Token
Send your user token in the x-guper-authorization header.
Headers
Path parameters
Responses
Related
Copied to clipboard