AWS Directory Service Data attributes
This topic describes how to work with attributes in the AWS Directory Service Data API Reference.
Request Attributes
The following attributes must be defined in the request body parameters. For an example of how to define these attributes, see CreateGroup in the AWS Directory Service Data API Reference.
Directory Service Data attribute name | LDAP display name | AWS Management Console | PowerShell alias | Access type | Object type | Attribute value | Searchable |
---|---|---|---|---|---|---|---|
distinguishedName |
Distinguished name |
None |
ReadOnly |
User, Group |
String |
No |
|
|
Email address |
EmailAddress |
Creatable |
User |
String |
Yes |
|
Enabled |
None |
Enabled |
Enabled |
Mutable |
User |
Boolean |
No |
givenName |
First Name |
GivenName |
Creatable |
User |
String |
Yes |
|
groupScope |
Group scope |
None |
Creatable |
Group |
Enum |
No |
|
groupType |
Group type |
None |
Creatable |
Group |
Enum |
No |
|
sAMAccountName |
User logon name |
sAMAccountName |
Creatable |
User, Group |
String |
Yes |
|
objectSid |
User / Group security identifier (SID) |
SID |
ReadOnly |
User, Group |
String |
No |
|
sn |
Last name |
Surname |
Creatable |
User |
String |
Yes |
|
userPrincipalName |
User principal name |
UserPrincipalName |
ReadOnly |
User |
String |
No |
Other Attributes
The following attributes must be defined in OtherAttributes
and don't
map to any request body parameters. When you define other attributes in your requests,
you must specify the attribute name, data type, and the value for each attribute. For an
example of how to define these attributes, see CreateUser in the AWS Directory Service Data API
Reference.
Note
The names of these attributes are case insensitive when provided as inputs and the equivalent of the LDAP display name.
Directory Service Data attribute name | LDAP display name | AWS Management Console | PowerShell alias | Access type | Object type | Attribute value | Searchable |
---|---|---|---|---|---|---|---|
assistant |
Assistant |
None |
ReadOnly |
User |
String |
No |
|
cn |
Common Name |
None |
ReadOnly |
User, Group |
String |
No |
|
co |
Country/region |
Country |
Mutable |
User |
String |
No |
|
company |
Company |
Company |
Creatable |
User |
String |
No |
|
department |
Department |
Department |
Creatable |
User |
String |
No |
|
description |
Description |
Description |
Creatable |
User, Group |
String |
No |
|
directReports |
Direct reports |
None |
ReadOnly |
User |
String set |
No |
|
displayName |
Display name |
DisplayName |
Creatable |
User, Group |
String |
Yes |
|
facsimileTelephoneNumber |
Fax |
Fax |
Creatable |
User, Group |
String |
No |
|
homePhone |
Home phone number |
HomePhone |
Creatable |
User |
String |
No |
|
info |
Notes |
None |
Mutable |
User, Group |
String |
No |
|
initials |
Initials |
Initials |
ReadOnly |
User |
String |
No |
|
ipPhone |
IP Phone |
None |
Mutable |
User |
String |
No |
|
l |
City |
City |
Creatable |
User |
String |
Yes |
|
manager |
Manager |
Manager |
Mutable |
User |
String |
No |
|
|
Email address |
EmailAddress |
Mutable |
Group |
String |
Yes |
|
mobile |
Mobile phone number |
MobilePhone |
Mutable |
User |
String |
No |
|
ObjectClass |
objectClass |
User / Group |
None |
ReadOnly |
Group |
String |
No |
objectGUID |
Global unique identifier (GUID) |
None |
ReadOnly |
User, Group |
String |
No |
|
pager |
Pager |
None |
Mutable |
User |
String |
No |
|
physicalDeliveryOfficeName |
Office |
None |
Creatable |
User |
String |
Yes |
|
postalCode |
Zip/Postal code |
PostalCode |
Creatable |
User |
String |
No |
|
preferredLanguage |
Preferred language |
None |
Mutable |
User |
String |
No |
|
proxyAddresses |
Proxy address |
None |
ReadOnly |
User, Group |
Multi-valued string |
Yes |
|
servicePrincipalName |
Service principal name |
ServicePrincipalName |
Mutable |
User |
Multi-valued string |
No |
|
st |
State/Province |
State |
Creatable |
User |
String |
No |
|
streetAddress |
Street address |
StreetAddress |
Creatable |
User |
String |
No |
|
telephoneNumber |
Telephone number |
OfficePhone |
Creatable |
User |
String |
No |
|
title |
Job title |
Title |
ReadOnly |
User |
String |
No |
|
whenChanged |
Last updated |
None |
ReadOnly |
User, Group |
String |
No |
|
wWWHomePage |
Home page URL |
wWWHomePage |
Mutable |
User, Group |
String |
No |