Create User

connect_create_user

R Documentation

Creates a user account for the specified Connect Customer instance

Description

Creates a user account for the specified Connect Customer instance.

Certain UserIdentityInfo parameters are required in some situations. For example, Email, FirstName and LastName are required if you are using Connect Customer or SAML for identity management.

Fields in PhoneConfig cannot be set simultaneously with their corresponding channel-specific configuration parameters. Specifically:

• PhoneConfig.AutoAccept conflicts with AutoAcceptConfigs

• PhoneConfig.AfterContactWorkTimeLimit conflicts with AfterContactWorkConfigs

• PhoneConfig.PhoneType and PhoneConfig.PhoneNumber conflict with PhoneNumberConfigs

• PhoneConfig.PersistentConnection conflicts with PersistentConnectionConfigs

We recommend using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs for per-channel configuration.

For information about how to create users using the Connect Customer admin website, see Add Users in the Connect Customer Administrator Guide.

Usage

connect_create_user(Username, Password, IdentityInfo, PhoneConfig,
  DirectoryUserId, SecurityProfileIds, RoutingProfileId, HierarchyGroupId,
  InstanceId, AutoAcceptConfigs, AfterContactWorkConfigs,
  PhoneNumberConfigs, PersistentConnectionConfigs,
  VoiceEnhancementConfigs, Tags)

Arguments

Username	[required] The user name for the account. For instances not using SAML for identity management, the user name can include up to 20 characters. If you are using SAML for identity management, the user name can include up to 64 characters from [a-zA-Z0-9_-.\@]+. Username can include @ only if used in an email format. For example: Correct: testuser Correct: testuser@example.com Incorrect: testuser@example
Password	The password for the user account. A password is required if you are using Connect Customer for identity management. Otherwise, it is an error to include a password.
IdentityInfo	The information about the identity of the user.
PhoneConfig	The phone settings for the user. This parameter is optional. If not provided, the user can be configured using channel-specific parameters such as AutoAcceptConfigs, AfterContactWorkConfigs, PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs.
DirectoryUserId	The identifier of the user account in the directory used for identity management. If Connect Customer cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Connect Customer cannot access the directory. Otherwise, the identity information is used to authenticate users from your directory. This parameter is required if you are using an existing directory for identity management in Connect Customer when Connect Customer cannot access your directory to authenticate users. If you are using SAML for identity management and include this parameter, an error is returned.
SecurityProfileIds	[required] The identifier of the security profile for the user.
RoutingProfileId	[required] The identifier of the routing profile for the user.
HierarchyGroupId	The identifier of the hierarchy group for the user.
InstanceId	[required] The identifier of the Connect Customer instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.
AutoAcceptConfigs	The list of auto-accept configuration settings for each channel.
AfterContactWorkConfigs	The list of after contact work (ACW) timeout configuration settings for each channel.
PhoneNumberConfigs	The list of phone number configuration settings for each channel.
PersistentConnectionConfigs	The list of persistent connection configuration settings for each channel.
VoiceEnhancementConfigs	The list of voice enhancement configuration settings for each channel.
Tags	The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }.

Value

A list with the following syntax:

list(
  UserId = "string",
  UserArn = "string"
)

Request syntax

svc$create_user(
  Username = "string",
  Password = "string",
  IdentityInfo = list(
    FirstName = "string",
    LastName = "string",
    Email = "string",
    SecondaryEmail = "string",
    Mobile = "string"
  ),
  PhoneConfig = list(
    PhoneType = "SOFT_PHONE"|"DESK_PHONE",
    AutoAccept = TRUE|FALSE,
    AfterContactWorkTimeLimit = 123,
    DeskPhoneNumber = "string",
    PersistentConnection = TRUE|FALSE
  ),
  DirectoryUserId = "string",
  SecurityProfileIds = list(
    "string"
  ),
  RoutingProfileId = "string",
  HierarchyGroupId = "string",
  InstanceId = "string",
  AutoAcceptConfigs = list(
    list(
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      AutoAccept = TRUE|FALSE,
      AgentFirstCallbackAutoAccept = TRUE|FALSE
    )
  ),
  AfterContactWorkConfigs = list(
    list(
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      AfterContactWorkConfig = list(
        AfterContactWorkTimeLimit = 123
      ),
      AgentFirstCallbackAfterContactWorkConfig = list(
        AfterContactWorkTimeLimit = 123
      )
    )
  ),
  PhoneNumberConfigs = list(
    list(
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      PhoneType = "SOFT_PHONE"|"DESK_PHONE",
      PhoneNumber = "string"
    )
  ),
  PersistentConnectionConfigs = list(
    list(
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      PersistentConnection = TRUE|FALSE
    )
  ),
  VoiceEnhancementConfigs = list(
    list(
      Channel = "VOICE"|"CHAT"|"TASK"|"EMAIL",
      VoiceEnhancementMode = "VOICE_ISOLATION"|"NOISE_SUPPRESSION"|"NONE"
    )
  ),
  Tags = list(
    "string"
  )
)