@@ -99,6 +99,7 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
9999
100100<!-- commands -->
101101
102+ - [ ` sf org create agent-user ` ] ( #sf-org-create-agent-user )
102103- [ ` sf org create sandbox ` ] ( #sf-org-create-sandbox )
103104- [ ` sf org create scratch ` ] ( #sf-org-create-scratch )
104105- [ ` sf org delete sandbox ` ] ( #sf-org-delete-sandbox )
@@ -116,6 +117,84 @@ the [SandboxNuts](https://github.com/salesforcecli/plugin-org/actions/workflows/
116117- [ ` sf org resume sandbox ` ] ( #sf-org-resume-sandbox )
117118- [ ` sf org resume scratch ` ] ( #sf-org-resume-scratch )
118119
120+ ## ` sf org create agent-user `
121+
122+ Create the default Salesforce user that is used to run an agent.
123+
124+ ```
125+ USAGE
126+ $ sf org create agent-user -o <value> [--json] [--flags-dir <value>] [--api-version <value>] [--base-username <value>]
127+ [--first-name <value>] [--last-name <value>]
128+
129+ FLAGS
130+ -o, --target-org=<value> (required) Username or alias of the target org. Not required if the `target-org`
131+ configuration variable is already set.
132+ --api-version=<value> Override the api version used for api requests made by this command
133+ --base-username=<value> Base username pattern. A unique ID is appended to ensure global uniqueness of the
134+ usename.
135+ --first-name=<value> [default: Agent] First name for the agent user.
136+ --last-name=<value> [default: User] Last name for the agent user.
137+
138+ GLOBAL FLAGS
139+ --flags-dir=<value> Import flag values from a directory.
140+ --json Format output as json.
141+
142+ DESCRIPTION
143+ Create the default Salesforce user that is used to run an agent.
144+
145+ You specify this user in the agent's Agent Script file using the "default_agent_user" parameter in the "config" block.
146+
147+ By default, this command:
148+
149+ - Generates a user called "Agent User" with a globally unique username. Use flags to change these default names.
150+ - Sets the user's email to the new username.
151+ - Assigns the user the "Einstein Agent User" profile.
152+ - Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,
153+ EinsteinGPTPromptTemplateUser
154+ - Checks that the user licenses required by the profile and permission sets are available in your org.
155+
156+ The generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only
157+ Salesforce users with admin permissions can view or edit an agent user in Setup.
158+
159+ To assign additional permission sets or licenses after the user was created, use the "org assign permset" or "org
160+ assign
161+ permsetlicense" commands.
162+
163+ When the command completes, it displays a summary of what it did, including the new agent user's username and ID, the
164+ available licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to
165+ the
166+ agent user.
167+
168+ EXAMPLES
169+ Create an agent user with an auto-generated username; create the user in the org with alias "myorg":
170+
171+ $ sf org create agent-user --target-org myorg
172+
173+ Create an agent user by specifying a base username pattern; to make the username unique, the command appends a unique
174+ identifier:
175+ $ sf org create agent-user --base-username service-agent@corp.com --target-org myorg
176+
177+ Create an agent user with an auto-generated username but the custom name "Service Agent"; create the user in your
178+ default org:
179+ $ sf org create agent-user --first-name Service --last-name Agent
180+
181+ FLAG DESCRIPTIONS
182+ --base-username=<value> Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.
183+
184+ Specify a base username in email format, such as "service-agent@corp.com". The command then appends a 12-character
185+ globally unique ID (GUID) to the name before the "@" sign, which ensures that the username is globally unique across
186+ all
187+ Salesforce orgs and sandboxes.
188+
189+ For example, if you specify "service-agent@corp.com", then the username might be
190+ "service-agent.a1b2c3d4e5f6@corp.com".
191+
192+ If not specified, the command auto-generates the username using this pattern:
193+ "agent.user.<GUID>@your-org-domain.com".
194+ ```
195+
196+ _ See code: [ src/commands/org/create/agent-user.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75/src/commands/org/create/agent-user.ts ) _
197+
119198## ` sf org create sandbox `
120199
121200Create a sandbox org.
@@ -248,7 +327,7 @@ FLAG DESCRIPTIONS
248327 You can specify either --source-sandbox-name or --source-id when cloning an existing sandbox, but not both.
249328```
250329
251- _ See code: [ src/commands/org/create/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/create/sandbox.ts ) _
330+ _ See code: [ src/commands/org/create/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/create/sandbox.ts ) _
252331
253332## ` sf org create scratch `
254333
@@ -430,7 +509,7 @@ FLAG DESCRIPTIONS
430509 Omit this flag to have Salesforce generate a unique username for your org.
431510```
432511
433- _ See code: [ src/commands/org/create/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/create/scratch.ts ) _
512+ _ See code: [ src/commands/org/create/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/create/scratch.ts ) _
434513
435514## ` sf org delete sandbox `
436515
@@ -476,7 +555,7 @@ EXAMPLES
476555 $ sf org delete sandbox --target-org my-sandbox --no-prompt
477556```
478557
479- _ See code: [ src/commands/org/delete/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/delete/sandbox.ts ) _
558+ _ See code: [ src/commands/org/delete/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/delete/sandbox.ts ) _
480559
481560## ` sf org delete scratch `
482561
@@ -520,7 +599,7 @@ EXAMPLES
520599 $ sf org delete scratch --target-org my-scratch-org --no-prompt
521600```
522601
523- _ See code: [ src/commands/org/delete/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/delete/scratch.ts ) _
602+ _ See code: [ src/commands/org/delete/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/delete/scratch.ts ) _
524603
525604## ` sf org disable tracking `
526605
@@ -559,7 +638,7 @@ EXAMPLES
559638 $ sf org disable tracking
560639```
561640
562- _ See code: [ src/commands/org/disable/tracking.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/disable/tracking.ts ) _
641+ _ See code: [ src/commands/org/disable/tracking.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/disable/tracking.ts ) _
563642
564643## ` sf org display `
565644
@@ -604,7 +683,7 @@ EXAMPLES
604683 $ sf org display --target-org TestOrg1 --verbose
605684```
606685
607- _ See code: [ src/commands/org/display.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/display.ts ) _
686+ _ See code: [ src/commands/org/display.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/display.ts ) _
608687
609688## ` sf org enable tracking `
610689
@@ -646,7 +725,7 @@ EXAMPLES
646725 $ sf org enable tracking
647726```
648727
649- _ See code: [ src/commands/org/enable/tracking.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/enable/tracking.ts ) _
728+ _ See code: [ src/commands/org/enable/tracking.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/enable/tracking.ts ) _
650729
651730## ` sf org list `
652731
@@ -685,7 +764,7 @@ EXAMPLES
685764 $ sf org list --clean
686765```
687766
688- _ See code: [ src/commands/org/list.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/list.ts ) _
767+ _ See code: [ src/commands/org/list.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/list.ts ) _
689768
690769## ` sf org list metadata `
691770
@@ -752,7 +831,7 @@ FLAG DESCRIPTIONS
752831 Examples of metadata types that use folders are Dashboard, Document, EmailTemplate, and Report.
753832```
754833
755- _ See code: [ src/commands/org/list/metadata.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/list/metadata.ts ) _
834+ _ See code: [ src/commands/org/list/metadata.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/list/metadata.ts ) _
756835
757836## ` sf org list metadata-types `
758837
@@ -807,7 +886,7 @@ FLAG DESCRIPTIONS
807886 Override the api version used for api requests made by this command
808887```
809888
810- _ See code: [ src/commands/org/list/metadata-types.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/list/metadata-types.ts ) _
889+ _ See code: [ src/commands/org/list/metadata-types.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/list/metadata-types.ts ) _
811890
812891## ` sf org open `
813892
@@ -883,7 +962,7 @@ EXAMPLES
883962 $ sf org open --source-file force-app/main/default/bots/Coral_Cloud_Agent/Coral_Cloud_Agent.bot-meta.xml
884963```
885964
886- _ See code: [ src/commands/org/open.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/open.ts ) _
965+ _ See code: [ src/commands/org/open.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/open.ts ) _
887966
888967## ` sf org open agent `
889968
@@ -934,7 +1013,7 @@ EXAMPLES
9341013 $ sf org open agent --target-org MyTestOrg1 --browser firefox --api-name Coral_Cloud_Agent
9351014```
9361015
937- _ See code: [ src/commands/org/open/agent.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/open/agent.ts ) _
1016+ _ See code: [ src/commands/org/open/agent.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/open/agent.ts ) _
9381017
9391018## ` sf org open authoring-bundle `
9401019
@@ -980,7 +1059,7 @@ EXAMPLES
9801059 $ sf org open authoring-bundle --target-org MyTestOrg1 --browser firefox
9811060```
9821061
983- _ See code: [ src/commands/org/open/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/open/authoring-bundle.ts ) _
1062+ _ See code: [ src/commands/org/open/authoring-bundle.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/open/authoring-bundle.ts ) _
9841063
9851064## ` sf org refresh sandbox `
9861065
@@ -1083,7 +1162,7 @@ FLAG DESCRIPTIONS
10831162 You can specify either --source-sandbox-name or --source-id when refreshing an existing sandbox, but not both.
10841163```
10851164
1086- _ See code: [ src/commands/org/refresh/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/refresh/sandbox.ts ) _
1165+ _ See code: [ src/commands/org/refresh/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/refresh/sandbox.ts ) _
10871166
10881167## ` sf org resume sandbox `
10891168
@@ -1146,7 +1225,7 @@ FLAG DESCRIPTIONS
11461225 returns the job ID. To resume checking the sandbox creation, rerun this command.
11471226```
11481227
1149- _ See code: [ src/commands/org/resume/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/resume/sandbox.ts ) _
1228+ _ See code: [ src/commands/org/resume/sandbox.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/resume/sandbox.ts ) _
11501229
11511230## ` sf org resume scratch `
11521231
@@ -1199,6 +1278,6 @@ FLAG DESCRIPTIONS
11991278 returns the job ID. To resume checking the scratch creation, rerun this command.
12001279```
12011280
1202- _ See code: [ src/commands/org/resume/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.74 /src/commands/org/resume/scratch.ts ) _
1281+ _ See code: [ src/commands/org/resume/scratch.ts] ( https://github.com/salesforcecli/plugin-org/blob/5.9.75 /src/commands/org/resume/scratch.ts ) _
12031282
12041283<!-- commandsstop -->
0 commit comments