Menu
Amazon Connect Service
API Reference (API Version 2017-08-08)

CreateUser

Creates a new user account in your Amazon Connect instance.

Request Syntax

PUT /users/InstanceId HTTP/1.1 Content-type: application/json { "DirectoryUserId": "string", "HierarchyGroupId": "string", "IdentityInfo": { "Email": "string", "FirstName": "string", "LastName": "string" }, "Password": "string", "PhoneConfig": { "AfterContactWorkTimeLimit": number, "AutoAccept": boolean, "DeskPhoneNumber": "string", "PhoneType": "string" }, "RoutingProfileId": "string", "SecurityProfileIds": [ "string" ], "Username": "string" }

URI Request Parameters

The request requires the following URI parameters.

InstanceId

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Choose the alias of the instance in the Instance alias column. The instance ID is displayed in the Overview section of your instance settings. For example, the instance ID is the set of characters at the end of the instance ARN, after instance/, such as 10a4c4eb-f57e-4d4c-b602-bf39176ced07.

Length Constraints: Minimum length of 1. Maximum length of 100.

Request Body

The request accepts the following data in JSON format.

DirectoryUserId

The unique identifier for the user account in the directory service directory used for identity management. If Amazon Connect is unable to access the existing directory, you can use the DirectoryUserId to authenticate users. If you include the parameter, it is assumed that Amazon Connect cannot access the directory. If the parameter is not included, the UserIdentityInfo is used to authenticate users from your existing 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 InvalidRequestException is returned.

Type: String

Required: No

HierarchyGroupId

The unique identifier for the hierarchy group to assign to the user created.

Type: String

Required: No

IdentityInfo

Information about the user, including email address, first name, and last name.

Type: UserIdentityInfo object

Required: No

Password

The password for the user account to create. This is required if you are using Amazon Connect for identity management. If you are using SAML for identity management and include this parameter, an InvalidRequestException is returned.

Type: String

Pattern: /^(?=.*[a-z])(?=.*[A-Z])(?=.*\d)[a-zA-Z\d\S]{8,}$/

Required: No

PhoneConfig

Specifies the phone settings for the user, including AfterContactWorkTimeLimit, AutoAccept, DeskPhoneNumber, and PhoneType.

Type: UserPhoneConfig object

Required: Yes

RoutingProfileId

The unique identifier for the routing profile to assign to the user created.

Type: String

Required: Yes

SecurityProfileIds

The unique identifier of the security profile to assign to the user created.

Type: Array of strings

Array Members: Minimum number of 1 item. Maximum number of 10 items.

Required: Yes

Username

The user name in Amazon Connect for the account to create.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 20.

Pattern: [a-zA-Z0-9\_\-\.]+

Required: Yes

Response Syntax

HTTP/1.1 200 Content-type: application/json { "UserArn": "string", "UserId": "string" }

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

UserArn

The Amazon Resource Name (ARN) of the user account created.

Type: String

UserId

The unique identifier for the user account in Amazon Connect

Type: String

Errors

For information about the errors that are common to all actions, see Common Errors.

DuplicateResourceException

A resource with that name already exisits.

HTTP Status Code: 409

InternalServiceException

Request processing failed due to an error or failure with the service.

HTTP Status Code: 500

InvalidParameterException

One or more of the parameters provided to the operation are not valid.

HTTP Status Code: 400

InvalidRequestException

The request is not valid.

HTTP Status Code: 400

LimitExceededException

The allowed limit for the resource has been reached.

HTTP Status Code: 429

ResourceNotFoundException

The specified resource was not found.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 429

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following: