Container for the parameters to the CreateUser operation.
Creates a user account for the specified Amazon Connect instance.
Certain UserIdentityInfo
parameters are required in some situations. For example,
Fields in
We recommend using channel-specific parameters such as Email, FirstName
and LastName are required if you are using Amazon Connect or SAML for identity
management.
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
AutoAcceptConfigs, AfterContactWorkConfigs,
PhoneNumberConfigs, PersistentConnectionConfigs, and VoiceEnhancementConfigs
for per-channel configuration.
For information about how to create users using the Amazon Connect admin website, see Add Users in the Amazon Connect Administrator Guide.
Inheritance Hierarchy
Amazon.Runtime.AmazonWebServiceRequest
Amazon.Connect.AmazonConnectRequest
Amazon.Connect.Model.CreateUserRequest
Namespace: Amazon.Connect.Model
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z
Syntax
public class CreateUserRequest : AmazonConnectRequest IAmazonWebServiceRequest
The CreateUserRequest type exposes the following members
Constructors
| Name | Description | |
|---|---|---|
|
CreateUserRequest() |
Properties
| Name | Type | Description | |
|---|---|---|---|
|
|
AfterContactWorkConfigs | System.Collections.Generic.List<Amazon.Connect.Model.AfterContactWorkConfigPerChannel> |
Gets and sets the property AfterContactWorkConfigs. The list of after contact work (ACW) timeout configuration settings for each channel. |
|
|
AutoAcceptConfigs | System.Collections.Generic.List<Amazon.Connect.Model.AutoAcceptConfig> |
Gets and sets the property AutoAcceptConfigs. The list of auto-accept configuration settings for each channel. |
|
|
DirectoryUserId | System.String |
Gets and sets the property 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. |
|
|
HierarchyGroupId | System.String |
Gets and sets the property HierarchyGroupId. The identifier of the hierarchy group for the user. |
|
|
IdentityInfo | Amazon.Connect.Model.UserIdentityInfo |
Gets and sets the property IdentityInfo. The information about the identity of the user. |
|
|
InstanceId | System.String |
Gets and sets the property InstanceId. The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance. |
|
|
Password | System.String |
Gets and sets the property 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. |
|
|
PersistentConnectionConfigs | System.Collections.Generic.List<Amazon.Connect.Model.PersistentConnectionConfig> |
Gets and sets the property PersistentConnectionConfigs. The list of persistent connection configuration settings for each channel. |
|
|
PhoneConfig | Amazon.Connect.Model.UserPhoneConfig |
Gets and sets the property 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 |
|
|
PhoneNumberConfigs | System.Collections.Generic.List<Amazon.Connect.Model.PhoneNumberConfig> |
Gets and sets the property PhoneNumberConfigs. The list of phone number configuration settings for each channel. |
|
|
RoutingProfileId | System.String |
Gets and sets the property RoutingProfileId. The identifier of the routing profile for the user. |
|
|
SecurityProfileIds | System.Collections.Generic.List<System.String> |
Gets and sets the property SecurityProfileIds. The identifier of the security profile for the user. |
|
|
Tags | System.Collections.Generic.Dictionary<System.String, System.String> |
Gets and sets the property Tags. The tags used to organize, track, or control access for this resource. For example, { "Tags": {"key1":"value1", "key2":"value2"} }. |
|
|
Username | System.String |
Gets and sets the property Username. 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:
|
|
|
VoiceEnhancementConfigs | System.Collections.Generic.List<Amazon.Connect.Model.VoiceEnhancementConfig> |
Gets and sets the property VoiceEnhancementConfigs. The list of voice enhancement configuration settings for each channel. |
Version Information
.NET:
Supported in: 8.0 and newer, Core 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5 and newer, 3.5