Class: Aws::DirectoryServiceData::Types::User

Inherits:

Struct

• Object
• Struct
• Aws::DirectoryServiceData::Types::User

Includes:

Structure

Defined in:

lib/aws-sdk-directoryservicedata/types.rb

Overview

A user object that contains identifying information and attributes for a specified user.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]

Instance Attribute Summary

• #distinguished_name ⇒ String

  The [distinguished name] of the object.

• #email_address ⇒ String

  The email address of the user.

• #enabled ⇒ Boolean

  Indicates whether the user account is active.

• #given_name ⇒ String

  The first name of the user.

• #other_attributes ⇒ Hash<String,Types::AttributeValue>

  An expression that includes one or more attributes, data types, and values of a user.

• #sam_account_name ⇒ String

  The name of the user.

• #sid ⇒ String

  The unique security identifier (SID) of the user.

• #surname ⇒ String

  The last name of the user.

• #user_principal_name ⇒ String

  The UPN that is an internet-style login name for a user and based on the internet standard [RFC 822].

Instance Attribute Details

#distinguished_name ⇒ String

The [distinguished name] of the object.

[1]: learn.microsoft.com/en-us/windows/win32/ad/object-names-and-identities#distinguished-name

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#email_address ⇒ String

The email address of the user.

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#enabled ⇒ Boolean

Indicates whether the user account is active.

Returns:

• (Boolean)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#given_name ⇒ String

The first name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#other_attributes ⇒ Hash<String,Types::AttributeValue>

An expression that includes one or more attributes, data types, and values of a user.

Returns:

• (Hash<String,Types::AttributeValue>)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#sam_account_name ⇒ String

The name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#sid ⇒ String

The unique security identifier (SID) of the user.

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#surname ⇒ String

The last name of the user.

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end

#user_principal_name ⇒ String

The UPN that is an internet-style login name for a user and based on the internet standard [RFC 822]. The UPN is shorter than the distinguished name and easier to remember.

[1]: datatracker.ietf.org/doc/html/rfc822

Returns:

• (String)

# File 'lib/aws-sdk-directoryservicedata/types.rb', line 1674

class User < Struct.new(
  :distinguished_name,
  :email_address,
  :enabled,
  :given_name,
  :other_attributes,
  :sam_account_name,
  :sid,
  :surname,
  :user_principal_name)
  SENSITIVE = [:distinguished_name, :email_address, :given_name, :surname, :user_principal_name]
  include Aws::Structure
end