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
}

Instance Attribute Summary collapse

Instance Attribute Details

#directory_user_idString

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.

Returns:

  • (String)

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

#hierarchy_group_idString

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

Returns:

  • (String)

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

#identity_infoTypes::UserIdentityInfo

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

Returns:

#instance_idString

The identifier for your Amazon Connect instance. To find the ID of your instance, open the AWS console and select Amazon Connect. Select 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.

Returns:

  • (String)

    The identifier for your Amazon Connect instance.

#passwordString

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.

Returns:

  • (String)

    The password for the user account to create.

#phone_configTypes::UserPhoneConfig

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

Returns:

  • (Types::UserPhoneConfig)

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

#routing_profile_idString

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

Returns:

  • (String)

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

#security_profile_idsArray<String>

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

Returns:

  • (Array<String>)

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

#usernameString

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

Returns:

  • (String)

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