Skip to content

Commit 26766b8

Browse files
Merge pull request #1616 from salesforcecli/js/edit-messages
W-21617433: edit messages
2 parents 4586dfe + 1016f61 commit 26766b8

1 file changed

Lines changed: 21 additions & 23 deletions

File tree

messages/create_agent_user.md

Lines changed: 21 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -1,56 +1,54 @@
11
# summary
22

3-
Create a default_agent_user for use with Agentforce and agentscript.
3+
Create the default Salesforce user that is used to run an agent.
44

55
# description
66

7-
Agent users are specialized user accounts designed to be used as default_agent_user in AgentScript. These users are
8-
automatically configured with the Einstein Agent User profile and required Agentforce permission sets.
7+
You specify this user in the agent's Agent Script file using the "default_agent_user" parameter in the "config" block.
98

10-
The command automatically:
9+
By default, this command:
1110

12-
- Checks that agent user licenses are available in your org
13-
- Generates a globally unique username with a GUID for uniqueness
14-
- Creates the user with the Einstein Agent User profile
15-
- Assigns required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser,
16-
EinsteinGPTPromptTemplateUser
17-
- Infers locale settings (timezone, language) from the current user
11+
- Generates a user called "Agent User" with a globally unique username. Use flags to change these default names.
12+
- Sets the user's email to the new username.
13+
- Assigns the user the "Einstein Agent User" profile.
14+
- Assigns the user these required permission sets: AgentforceServiceAgentBase, AgentforceServiceAgentUser, EinsteinGPTPromptTemplateUser
15+
- Checks that the user licenses required by the profile and permission sets are available in your org.
1816

19-
To assign additional permission sets after creation, use: sf org assign permset
17+
The generated user doesn't have a password. You can’t log into Salesforce using the agent user's username. Only Salesforce users with admin permissions can view or edit an agent user in Setup.
2018

21-
The command performs comprehensive validation and provides clear error messages to help diagnose and resolve any issues
22-
during the creation process.
19+
To assign additional permission sets or licenses after the user was created, use the "org assign permset" or "org assign permsetlicense" commands.
20+
21+
When the command completes, it displays a summary of what it did, including the new agent user's username and ID, the available licenses associated with the Einstein Agent User profile, and the profile and permission sets assigned to the agent user.
2322

2423
# examples
2524

26-
- Create an agent user with auto-generated username:
25+
- Create an agent user with an auto-generated username; create the user in the org with alias "myorg":
2726

2827
<%= config.bin %> <%= command.id %> --target-org myorg
2928

30-
- Create an agent user with a base username pattern (GUID will be appended):
29+
- Create an agent user by specifying a base usernmane pattern; to make the username unique, the command appends a unique identifier:
3130

32-
<%= config.bin %> <%= command.id %> --target-org myorg --base-username service-agent@corp.com
31+
<%= config.bin %> <%= command.id %> --base-username service-agent@corp.com --target-org myorg
3332

34-
- Create an agent user with custom name:
33+
- Create an agent user with an auto-generated username but the custom name "Service Agent"; create the user in your default org:
3534

36-
<%= config.bin %> <%= command.id %> --target-org myorg --first-name Service --last-name Agent
35+
<%= config.bin %> <%= command.id %> --first-name Service --last-name Agent
3736

3837
# flags.target-org.summary
3938

4039
Username or alias of the target org where the agent user will be created.
4140

4241
# flags.base-username.summary
4342

44-
Base username pattern. A GUID will be appended to ensure global uniqueness.
43+
Base username pattern. A unique ID is appended to ensure global uniqueness of the usename.
4544

4645
# flags.base-username.description
4746

48-
Specify a base username in email format (e.g., service-agent@corp.com). The command will append a 12-character GUID to
49-
ensure the username is globally unique across all Salesforce orgs and sandboxes.
47+
Specify a base username in email format, such as "service-agent@corp.com". The command then appends a 12-character globally unique ID (GUID) to the name before the "@" sign, which ensures that the username is globally unique across all Salesforce orgs and sandboxes.
5048

51-
Example: "service-agent@corp.com" becomes "service-agent.a1b2c3d4e5f6@corp.com"
49+
For example, if you specify "service-agent@corp.com", then the username might be "service-agent.a1b2c3d4e5f6@corp.com".
5250

53-
If not specified, the command auto-generates: agent.user.<GUID>@your-org-domain.com
51+
If not specified, the command auto-generates the username using this pattern: "agent.user.<GUID>@your-org-domain.com".
5452

5553
# flags.first-name.summary
5654

0 commit comments

Comments
 (0)