| name | jc-onboard-user |
| description | Onboard a new JumpCloud user — create account, add to groups, verify setup using the jc CLI |
Onboard a JumpCloud User
Walk through creating a new user, adding them to groups, and verifying setup.
Prerequisites
jc installed and authenticated (jc auth status)
Gather Information
Ask the user for:
- Username (required)
- Email (required)
- First name (optional)
- Last name (optional)
- Department (optional)
- Groups to add to (optional, comma-separated)
Steps
1. Preview the user creation
jc users create --username USERNAME --email EMAIL --firstname FIRST --lastname LAST --department DEPT --plan
Show the plan output. Confirm with the user before proceeding.
2. Create the user
jc users create --username USERNAME --email EMAIL --firstname FIRST --lastname LAST --department DEPT
Capture the user ID from the output (--ids flag returns just the ID).
3. Add to groups
For each group the user should be added to:
jc groups add-member GROUP_NAME --user USERNAME
If a group doesn't exist, offer to create it first:
jc groups user create --name GROUP_NAME
4. Verify setup
jc users get USERNAME -t
Check that the user exists, is activated, and has the correct details.
5. Verify group memberships
jc graph traverse --from user:USERNAME --to user_group -t
Confirm the user appears in all expected groups.
Safety Notes
- Use
--plan to preview any create/update/delete before executing
- The
users create command does NOT send an activation email by default
- If the user should receive an activation email, note this to the admin
- All mutations require confirmation unless
--force is set