Skip to content

Create User

connect_create_user R Documentation

Creates a user account for the specified Amazon Connect instance

Description

Creates a user account for the specified Amazon Connect instance.

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

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

Usage

connect_create_user(Username, Password, IdentityInfo, PhoneConfig,
  DirectoryUserId, SecurityProfileIds, RoutingProfileId, HierarchyGroupId,
  InstanceId, 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 Amazon Connect for identity management. Otherwise, it is an error to include a password.

IdentityInfo

The information about the identity of the user.

PhoneConfig

[required] The phone settings for the user.

DirectoryUserId

The identifier of the user account in the directory used for identity management. If Amazon Connect cannot access the directory, you can specify this identifier to authenticate users. If you include the identifier, we assume that Amazon Connect 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 Amazon Connect when Amazon Connect 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 Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

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"
  ),
  DirectoryUserId = "string",
  SecurityProfileIds = list(
    "string"
  ),
  RoutingProfileId = "string",
  HierarchyGroupId = "string",
  InstanceId = "string",
  Tags = list(
    "string"
  )
)