Blossom Docs
Blossom

Reference

blossom user:register

Register a Blossom user

Usage

blossom user:register [--data DATA]

Flags

Flag Description
--data, -d YAML or JSON registration data, a path to a data file, or an HTTP(S) URL

Examples:

blossom user:register
blossom user:init --type register
blossom user:register --data registration.yml
blossom user:register --data '{"registration":{"name":"Ada Lovelace","username":"ada-lovelace","email":"ada@example.com","password":"PASSWORD"}}'

Registers a Blossom user and sends a confirmation email.

Registration uses --data like other resource create commands. In an interactive terminal, Blossom prompts for any required fields missing from --data. Run blossom user:register with no flags to enter every required value interactively. Use a starter file from blossom user:init --type register when you want an editable file.

registration.yml:

registration:
  name: Ada Lovelace
  username: ada-lovelace
  email: ada@example.com
  password: ${BLOSSOM_REGISTRATION_PASSWORD}
  password_confirmation: ${BLOSSOM_REGISTRATION_PASSWORD}
  time_zone: Pacific Time (US & Canada)
  # Optional: set this when registering from an organization invitation link.
  # invite: INVITATION_TOKEN

Data files and inline data support environment variable substitution. Use BLOSSOM_OUTPUT=json to get a structured response with registration status and next links.

After registration, confirm the user with the token from the email:

blossom user:confirm --token=TOKEN
On this page