Skip to content

enumeray access invite

Create a recipient-bound model invitation and save its token privately.

Use when: A specific account or verified email should receive invitation-based access.

Role and prerequisites: Model owner or current co-admin. Install enumeray, configure the API and log in. Use an account or delegated token with the required permissions. Example IDs must be replaced with IDs from your service.

Terminal window
enumeray access invite scalar-double --user 11111111-1111-4111-8111-111111111111 --output invitation.json
# Alternative recipient form:
enumeray access invite scalar-double --email colleague@example.org --output email-invitation.json
Input Meaning and use
<MODEL> Stable model ID from model list/get or supplied by the author. An unlisted model can be addressed by ID, but still requires access.
--user <USER> Stable UUID of the target account, obtained from auth whoami for yourself or from the service administrator for another account. Display labels and email addresses are not user IDs.
--email <EMAIL> Invitation recipient email. Use exactly one of --email or --user. The recipient must authenticate with the matching verified identity to redeem an email invitation.
--output <OUTPUT> New private JSON file containing the invitation token and response. Existing files are refused; do not share it publicly or commit it.

Every command also accepts the profile, API, JSON and timeout options.

Creates an invitation and writes its one-time secret response to a new private JSON file. Stdout prints only path, invitation ID and expiry.

Deliver the token securely to the intended recipient; they accept it through stdin.

Exact syntax, defaults and accepted values
Create a user or email invitation and save its one-time secret privately
Usage: enumeray access invite [OPTIONS] --output <OUTPUT> <MODEL>
Arguments:
<MODEL> Stable model ID from model list/get or supplied by its author
Options:
--api <API> User API origin override; credentials never cross origins. Host/runner commands use explicit configuration
--user <USER> Recipient account UUID; provide exactly one of --user or --email
--email <EMAIL> Recipient email; redemption requires the matching verified identity. Alternative to --user
--profile <PROFILE> Named local user API/login profile; host/runner commands use explicit configuration [default: default]
--config <CONFIG> Private user profiles file; defaults to $XDG_CONFIG_HOME/enumeray/profiles.json or ~/.config/enumeray/profiles.json
--output <OUTPUT> New private JSON file containing the invitation secret; existing paths are refused
--json Emit user API results as JSON (NDJSON for following logs) and runtime errors on stderr; host/runner output follows its own protocol
--timeout <TIMEOUT> User API HTTP timeout in seconds; live logs use it for read inactivity. Does not limit execution time [default: 60]
-h, --help Print help

Documentation 205dcb3116ea · public sources 8c70356d340f · built .Download documentation identity.