Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-14171791756.1 KB

Creates a user account for the specified Amazon Connect instance.

For information about how to create user accounts using the Amazon Connect console, see Add Users in the Amazon Connect Administrator Guide.

put/users/{InstanceId}

Path parameters

InstanceIdstring required

The identifier of the Amazon Connect instance. You can <a href="https://docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html">find the instance ID</a> in the Amazon Resource Name (ARN) of the instance.

Request body

Usernamestring 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_-.@]+.

Passwordstring

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.

DirectoryUserIdstring
<p>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.</p> <p>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.</p>
SecurityProfileIdsSecurityProfileId[] required

The identifier of the security profile for the user.

RoutingProfileIdstring required

The identifier of the routing profile for the user.

HierarchyGroupIdstring

The identifier of the hierarchy group for the user.

Tagsobject

The tags used to organize, track, or control access for this resource. For example, { "tags": {"key1":"value1", "key2":"value2"} }.

Response

Success

UserIdstring

The identifier of the user account.

UserArnstring

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