You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

Class: Aws::Connect::Types::CreateUserRequest

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateUserRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  username: "AgentUsername", # required
  password: "Password",
  identity_info: {
    first_name: "AgentFirstName",
    last_name: "AgentLastName",
    email: "Email",
  },
  phone_config: { # required
    phone_type: "SOFT_PHONE", # required, accepts SOFT_PHONE, DESK_PHONE
    auto_accept: false,
    after_contact_work_time_limit: 1,
    desk_phone_number: "PhoneNumber",
  },
  directory_user_id: "DirectoryUserId",
  security_profile_ids: ["SecurityProfileId"], # required
  routing_profile_id: "RoutingProfileId", # required
  hierarchy_group_id: "HierarchyGroupId",
  instance_id: "InstanceId", # required
  tags: {
    "TagKey" => "TagValue",
  },
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#directory_user_id ⇒ String

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.

Returns:

  • (String) —

    The identifier of the user account in the directory used for identity management.

#hierarchy_group_id ⇒ String

The identifier of the hierarchy group for the user.

Returns:

  • (String) —

    The identifier of the hierarchy group for the user.

#identity_info ⇒ Types::UserIdentityInfo

The information about the identity of the user.

Returns:

#instance_id ⇒ String

The identifier of the Amazon Connect instance.

Returns:

  • (String) —

    The identifier of the Amazon Connect instance.

#password ⇒ String

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.

Returns:

  • (String) —

    The password for the user account.

#phone_config ⇒ Types::UserPhoneConfig

The phone settings for the user.

Returns:

#routing_profile_id ⇒ String

The identifier of the routing profile for the user.

Returns:

  • (String) —

    The identifier of the routing profile for the user.

#security_profile_ids ⇒ Array<String>

The identifier of the security profile for the user.

Returns:

  • (Array<String>) —

    The identifier of the security profile for the user.

#tags ⇒ Hash<String,String>

One or more tags.

Returns:

  • (Hash<String,String>) —

    One or more tags.

#username ⇒ String

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

Returns:

  • (String) —

    The user name for the account.