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

Inherits:

Struct

• Object
• Struct
• Aws::Connect::Types::CreateUserRequest

Includes:

Structure

Defined in:

lib/aws-sdk-connect/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:password]

Instance Attribute Summary

• #directory_user_id ⇒ 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.

• #identity_info ⇒ Types::UserIdentityInfo

  The information about the identity of the user.

• #instance_id ⇒ String

  The identifier of the Amazon Connect instance.

• #password ⇒ String

  The password for the user account.

• #phone_config ⇒ Types::UserPhoneConfig

  The phone settings for the user.

• #routing_profile_id ⇒ String

  The identifier of the routing profile for the user.

• #security_profile_ids ⇒ Array<String>

  The identifier of the security profile for the user.

• #tags ⇒ Hash<String,String>

  The tags used to organize, track, or control access for this resource.

• #username ⇒ String

  The user name for the account.

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)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#hierarchy_group_id ⇒ String

The identifier of the hierarchy group for the user.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#identity_info ⇒ Types::UserIdentityInfo

The information about the identity of the user.

Returns:

• (Types::UserIdentityInfo)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#instance_id ⇒ String

The identifier of the Amazon Connect instance. You can [find the instance ID] in the Amazon Resource Name (ARN) of the instance.

[1]: docs.aws.amazon.com/connect/latest/adminguide/find-instance-arn.html

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#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)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#phone_config ⇒ Types::UserPhoneConfig

The phone settings for the user.

Returns:

• (Types::UserPhoneConfig)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#routing_profile_id ⇒ String

The identifier of the routing profile for the user.

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#security_profile_ids ⇒ Array<String>

The identifier of the security profile for the user.

Returns:

• (Array<String>)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end

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

Username can include @ only if used in an email format. For example:

• Correct: testuser

• Correct: testuser@example.com

• Incorrect: testuser@example

Returns:

• (String)

# File 'lib/aws-sdk-connect/types.rb', line 3725

class CreateUserRequest < Struct.new(
  :username,
  :password,
  :identity_info,
  :phone_config,
  :directory_user_id,
  :security_profile_ids,
  :routing_profile_id,
  :hierarchy_group_id,
  :instance_id,
  :tags)
  SENSITIVE = [:password]
  include Aws::Structure
end