service-omni-agent-users-create
Create N agent users on a Salesforce org via Anonymous Apex so Omni-Channel has agents to route work to. Usernames follow a deterministic per-org pattern, detection is SOQL-based, and the skill inserts only the users that are missing — so it is safe to re-run. It is invoked by
service-omni-channel-setup-coordinate
after
service-omni-base-settings-configure
enables Omni-Channel; assigning permission sets (
service-omni-permission-set-assign
) and adding users to queues (
service-omni-queue-members-assign
) are separate leaves. Supervisor users come from
service-omni-supervisor-users-create
.
Inputs
Confirm once, up front:
- (required, no default) — must resolve via .
- User count (optional, default , range ).
- Profile name (optional, default for portability). The coordinator overrides this to a Service Cloud profile so agents consume Service Cloud licenses; on many CDOs the Salesforce license pool is saturated while Service Cloud has free slots.
Usernames and passwords are never accepted from the operator — both are generated (usernames from the org suffix, passwords via Anonymous Apex). Operator-supplied credentials would break re-run detection and risk weak or leaked secrets.
Preconditions and safety
- Target org authenticated via CLI (My Domain URL, not ), Service Cloud license present, CLI ≥ 2.139.6.
- The executing user has and
PermissionsManagePasswordPolicies
(standard on System Administrator).
- Production guardrail: the detect script computes as OR
TrialExpirationDate != null
OR in {Developer Edition, Base Edition}, and the skill blocks with no override when it is false. CDOs, scratch orgs, and dev orgs are permitted.
Password handling (fail-closed). Passwords are set by Anonymous Apex
(
sf user password generate
cannot target Apex-inserted users — it fails with
). The password literal appears in the inline executeAnonymous debug log and, only when a debug-log TraceFlag is active for the running user, in a queryable
. The wrapper therefore fails closed
before the first
: it proves via a SOQL-filtered Tooling API query (
) that no active TraceFlag exists. If safety cannot be positively proven — the running user is unresolved, the query fails or is unparseable, or any active TraceFlag exists — it generates no password at all; the user is left ACTIVE, flagged
password_status:"reset_required"
, and a
explains why. It never deletes logs, so no plaintext can reach an
and unrelated audit logs are untouched. If
itself fails for a user, that user is kept ACTIVE and flagged for reset.
Run
bash
# read-only preview (never writes)
bash scripts/detect-and-create.sh plan <org-alias> [count] [profile-name]
# detect, enforce safe_to_write, then insert only the missing users
bash scripts/detect-and-create.sh run <org-alias> [count=3] [profile-name="Standard User"]
is the canonical entry point: it re-runs detection, enforces the production guard, and only then inserts. Do not call
directly — it is internal and does not enforce the guard on its own.
Behavior
Detection. The detector derives an 8-char suffix from
(
, lowercased), resolves the profile by name, and queries
for
agent{i}.<suffix>@example.com
to find which of the
slot indexes are occupied. A stable, deterministic pattern is what makes re-runs idempotent — the suffix is never a timestamp or UUID.
Insertion. The Apex loads
assets/create-users.apex.template
, substitutes
/
/
, and inserts only the missing indexes. It re-checks existing users inside the transaction, which prevents a single run from double-inserting; across
concurrent runs the in-transaction check is not a guarantee (both can pass their pre-query before either commits), so duplicate protection there relies on the global username-uniqueness constraint plus the
retry (see references/apex-template-notes.md). It enables the Service Cloud feature (
UserPermissionsSupportUser=true
) so users can go online in Omni; if the profile's license does not allow it, the Apex strips the flag and retries (users are still created, but need a Service-Cloud-license profile for full Omni). Each created user is reported via
AGENT_USER_CREATED|<id>|<username>|<email>
(no password in the marker — passwords are set by the separate
submission).
Verification. After insertion the detector re-runs and must show
; otherwise the skill fails (the Apex reported success but the users did not persist).
Output contract
emits a single JSON object with
∈
|
|
|
|
, plus
(mirrors the detector),
(mirrors the inserter,
when nothing was created), top-level
,
,
,
,
users_needing_password_reset
,
, and
. The coordinator combines
with newly created users so mixed runs configure presence and skills for the complete requested agent set.
- — every missing index landed with a working password.
- — some landed but not all, or any user needs a manual password reset, or inactive occupants were found.
- — all requested users already existed; nothing created.
- — plan mode only; reports missing indexes without writing.
- — precondition failed (, unresolved profile/suffix, or nothing inserted).
create.created_users[].password
is populated only for users created this run whose
succeeded;
password_status:"reset_required"
means the user is ACTIVE but has no working password yet. Exit code is 0 for
/
/
/
, 1 for
.
Generated passwords are a secret: the returned JSON is the only place they appear. Any caller that persists stdout must write it only to a restricted
(mode 0600), redact it from every other artifact, and delete it after distribution — the coordinator does this automatically; standalone callers own it. Reused users' passwords are not retrievable; recover via Setup → Users → Reset Password.
Limitations
- Username pattern and org suffix are fixed and never operator-configurable — that determinism is what enables idempotent re-runs.
- Creates only agent users on the given profile; it never deletes, deactivates, or mutates existing users.
- Common User errors (, , ) are translated into operator-friendly messages rather than surfaced raw.
References
| File | When to read |
|---|
references/apex-patterns.md
| Before running the Apex — Apex structure, User field defaults, password policy, and the profile-localization risk |
references/apex-template-notes.md
| When user creation returns a duplicate, license, or password error — explains template substitutions and retry behavior |
assets/create-users.apex.template
| Loaded by when missing agent users must be inserted |
scripts/detect-existing.sh
| Loaded by the canonical entry point for the read-only org, profile, safety, and existing-user checks |
scripts/tests/test_user_create_security.py
| Run after changing the user-creation scripts to verify production refusal and password-handling contracts |