Chapter 3   Attribute Reference


This chapter contains an alphabetic list of the standard autarkies. It gives a definition of each attribute, and gives the attribute syntax and OID.

abstract

Definition
Provides an abstract of a document entry.

This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.102.1.9

aliasedObjectName

Definition
Used by the directory server to identify alias entries in the directory. Contains the distinguished name of the entry for which it is an alias.

Note: Alias dereferencing is not supported in iPlanet Directory Server.

For example:

aliasedObjectName: cn=jdoe, dc=siroe, dc=com

This attribute is defined in RFC 2256.

Syntax
DN, single-valued.

OID
2.5.4.1

associatedDomain

Definition
Specifies a DNS domain associated with an object in the directory tree. For example, the entry in the directory tree with a distinguished name c=US, o=Siroe Corporation might be associated to the domain siroe.com. Note that all domains should be represented in rfc822 order.

For example:

associatedDomain: siroe.com

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.37

associatedName

Definition
Specifies an entry in the organizational directory tree associated with a DNS domain.

For example:

associatedName: c=us

This attribute is defined in RFC 1274.

Syntax
DN, multi-valued.

OID
0.9.2342.19200300.100.1.38

audio

Definition
Contains a sound file in binary format. The attribute uses a u-law encoded sound file.

For example:

audio:: AAAAAA==

This attribute is defined in RFC 1274.

Syntax
Binary, multi-valued.

OID
0.9.2342.19200300.100.1.55

authorCn

Definition
Contains the common name of the author of a document entry.

For example:

authorCn: Kacey

This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.102.1.11

authorSn

Definition
Contains the surname of the author of a document entry.

For example:

authorSn: Doe

This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.102.1.12

authorityRevocationList

Definition
Contains a list of CA certificates that have been revoked. This attribute is to be stored and requested in the binary form, as authorityRevocationList;binary.

For example:

authorityrevocationlist;binary:: AAAAAA==

This attribute is defined in RFC 2256.

Syntax
Binary, multi-valued.

OID
2.5.4.38

buildingName

Definition
Defines the building name associated with the entry.

For example:

buildingName: B14

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.48

businessCategory

Definition
Identifies the type of business in which the entry is engaged. This should be a broad generalization such as is made at the corporate division level.

For example:

businessCategory: Engineering

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.15

c (countryName)

Definition
Contains the two-character code representing country names, as defined by ISO, in the directory.

For example:

countryName: IE

or

c: IE

This attribute is defined in RFC 2256.

Syntax
DirectoryString, single-valued.

OID
2.5.4.6

CACertificate

Definition
Contains the CA's certificate. This attribute is to be stored and requested in the binary form, as CACertificate;binary.

For example:

CACertificate;binary:: AAAAAA==

This attribute is defined in RFC 2256.

Syntax
Binary, multi-valued.

OID
2.5.4.37

carLicense

Definition
Identifies the entry's automobile license plate number.

For example:

carLicense: 4MCS389

This attribute is defined in RFC 2798.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.1

certificateRevocationList

Definition
Contains a list of revoked user certificates. This attribute is to be stored and requested in the binary form, as certificateRevocationList;binary.

For example:

certificaterevocationlist;binary:: AAAAAA==

This attribute is defined in RFC 2256.

Syntax
Binary, multi-valued.

OID
2.5.4.39

cn (commonName)

Definition
Identifies the name of an object in the directory. When the object corresponds to a person, the cn is typically the person's full name.

When identifying the entry's common name or full name:

commonName: Bill Anderson

or

cn: Bill Anderson

When in reference to LDAPReplica or LDAPServer object classes:

commonName: replicater.iplanet.com:17430/dc%3DSiroe%2Cdc%3Dcom

or

cn: replicater.iplanet.com:17430/dc%3DSiroe%2Cdc%3Dcom

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.3

co (friendlyCountryName)

Definition
Contains the name of a country. Often, the country attribute is used to describe a two-character code for a country, and the friendlyCountryName attribute is used to describe the actual country name.

For example:

friendlyCountryName: Ireland

or

co: Ireland

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.43

cosAttribute

Description
Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value. This attribute is used by all types of CoS definition entries.

This attribute is defined in iPlanet Directory Server.

Syntax
Directory String, multi-valued.

OID
2.16.840.1.113730.3.1.550

cosIndirectSpecifier

Description
Specifies the attribute values used by an indirect CoS to identify the template entry.

This attribute is defined in iPlanet Directory Server.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.577

cosPriority

Definition
Specifies which template provides the attribute value, when CoS templates compete to provide an attribute value. This attribute represents the global priority of a particular template. A priority of zero is the highest priority.

This attribute is defined in iPlanet Directory Server.

Syntax
INTEGER, single-valued.

OID
2.16.840.1.113730.3.1.569

cosSpecifier

Description
Specifies the attribute value used by a classic CoS, which, along with the template entry's DN, identifies the template entry.

This attribute is defined in iPlanet Directory Server.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.551

cosTargetTree

Definition
Determines the subtrees of the DIT to which the CoS schema applies. The values for this attribute for the schema and for multiple CoS schema may overlap their target trees in an arbitrary fashion.

This attribute is defined in iPlanet Directory Server.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.552

cosTemplateDn

Definition
Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value. This attribute is used by all types of CoS definition entries.

This attribute is defined in iPlanet Directory Server.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.553

crossCertificatePair

Definition
This attribute contains a pair of cross signed certificates. It is to be stored and requested in the binary form, as crossCertificatePair;binary.

For example:

crosscertificatepair;binary:: AAAAAA==

This attribute is defined in RFC 2256.

Syntax
Binary, multi-valued.

OID
2.5.4.40

dc (domainComponent)

Definition
Specifies one component of a domain name.

For example:

domainComponent: siroe

or

dc: siroe

This attribute is defined in RFC 2247.

Syntax
DirectoryString, single-valued.

OID
0.9.2342.19200300.100.1.25

deltaRevocationList

Definition
This attribute contains the "delta revocation list", a list of newly revoked certificates. It is to be stored and requested in the binary form, as deltaRevocationList;binary.

For example:

deltaRevocationList;binary:: AAAAAA==

This attribute is defined in RFC 2256.

Syntax
Binary, multi-valued.

OID
2.5.4.53

departmentNumber

Definition
Identifies the entry's department number.

For example:

departmentNumber: 2604

This attribute is defined in RFC 2798.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.2

description

Definition
Provides a human-readable description of the object. For people and organizations this often includes their role or work assignment.

For example:

description: Quality control inspector for the ME2873 product line

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.13

destinationIndicator

Definition
The country and city associated with the entry needed to provide Public Telegram Service. Generally used in conjunction with registeredAddress.

For example:

destinationIndicator: Stow, Ohio, USA

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID

2.5.4.27

displayName

Definition
Preferred name of a person to be used when displaying entries. Especially useful in displaying a preferred name for an entry within a one-line summary list. Since other attribute types, such as cn, are multivalued, they can not be used to display a preferred name.

For example:

displayName: Michigan Smith

This attribute is defined in RFC 2798.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.241

dITRedirect

Definition
Used to indicate that the object described by one entry now has a newer entry in the directory tree. This attribute may be used when an individual's place of work changes, and the individual acquires a new organizational DN.

For example:

ditRedirect: cn=jdoe, dc=siroe, dc=com

This attribute is defined in RFC 1274.

Syntax
DN

OID
0.9.2342.19200300.100.1.54

dmdName

Definition
The value of this attribute specifies a directory management domain (DMD), the administrative authority which operates the directory server.

For example:

dmdName: siroe.com

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.54

dn (distinguishedName)

Definition
Defines the distinguished name (dn) for the entry.

For example:

dn: cn=Jane Doe, ou=Quality Control, dc=siroe, dc=com

This attribute is defined in RFC 2256.

Syntax
DN

OID
2.5.4.49

dNSRecord

Definition
Specifies DNS resource records, including type A (Address), type MX (Mail Exchange), type NS (Name Server), and type SOA (Start Of Authority) resource records.

For example:

dNSRecord: IN NS ns.uu.net

This attribute is defined in Internet directory pilot.

Syntax
IA5String, multi-valued.

OID
0.9.2342.19200300.100.1.26

documentAuthor

Definition
Contains the distinguished name of the author of a document entry.

For example:

documentAuthor: cn=John Doe, dc=siroe, dc=com

This attribute is defined in RFC 1274.

Syntax
DN, multi-valued.

OID
0.9.2342.19200300.100.1.14

documentIdentifier

Definition
Specifies a unique identifier for a document.

For example:

documentIdentifier: L3204REV1

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.11

documentLocation

Definition
Defines the location of the original copy of a document entry.

For example:

documentLocation: Department Library

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.15

documentPublisher

Definition
The person and/or organization that published a document.

For example:

documentPublisher: Southeastern Publishing

This attribute is defined in RFC 1274.

Syntax
DirectoryString, single-valued.

OID
0.9.2342.19200300.100.1.56

documentStore

Definition
This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.102.1.10

documentTitle

Definition
Contains the title of a document entry.

For example:

documentTitle: Directory Administrator's Guide

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.12

documentVersion

Definition
Defines the version of a document entry.

For example:

documentVersion: 1.1

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.13

drink (favouriteDrink)

Definition
Describes the favorite drink of a person entry.

For example:

drink: soda

or

favouriteDrink: soda

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.5

dSAQuality

Definition
Specifies the purported quality of a DSA. This attribute allows a DSA manager to indicate the expected level of availability of the DSA.

For example:

dSAQuality: high

This attribute is defined in RFC 1274.

Syntax
DirectoryString, single-valued.

OID
0.9.2342.19200300.100.1.49

employeeNumber

Definition
Identifies the entry's employee number.

For example:

employeeNumber: 3440

This attribute is defined in RFC 2798.

Syntax
DirectoryString, single-valued.

OID
2.16.840.1.113730.3.1.3

employeeType

Definition
Identifies the entry's type of employment.

For example:

employeeType: Full time

This attribute is defined in RFC 2798.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.4

enhancedSearchGuide

Definition
Used by X.500 clients when constructing search filters.

For example:

enhancedSearchGuide: (uid=mhughes)

This attribute is defined in RFC 2798.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.47

fax (facsimileTelephoneNumber)

Definition
Identifies the fax number at which the entry can be reached. Abbreviation: fax

For example:

facsimileTelephoneNumber: 415-555-1212

or:

fax: 415-555-1212

This attribute is defined in RFC 2256.

Syntax
TelephoneNumber, multi-valued.

OID
2.5.4.23

generationQualifier

Definition
Contains the generation Qualifier part of the name, typically appearing in the suffix.

For example:

generationqualifier: Jr

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.44

givenName

Definition
Identifies the entry's given name, usually a person's first name.

For example:

givenName: Hecuba

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.42

homePhone

Definition
Identifies the entry's home phone number.

For example:

homeTelephoneNumber: 415-555-1212

or

homePhone: 415-555-1212

This attribute is defined in RFC 1274.

Syntax
TelephoneNumber, multi-valued.

OID
0.9.2342.19200300.100.1.20

homePostalAddress

Definition
Identifies the entry's home mailing address. This field is intended to include multiple lines, but each line within the entry should be separated by a dollar sign ($). To represent an actual dollar sign ($) or backslash (\) within this text, use the escaped hex values \24 and \5c respectively.

To identify an entry's home mailing address:

homePostalAddress: 1234 Ridgeway Drive$Santa Clara, CA$99555

Additionally, to represent the string:

The dollar ($) value can be found
in the c:\cost file.

provide the string:

The dollar (\24) value can be found$in the c:\5ccost file.

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.39

host

Definition
Defines the hostname of a computer.

For example:

host: mozilla

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.9

houseIdentifier

Definition
Identifies a building in a location.

For example:

houseIdentifier: B105

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.51

info

Definition
Specifies any general information pertinent to an object. It is recommended that specific usage of this attribute type is avoided, and that specific requirements are met by other (possibly additional) attribute types.

For example:

info: not valid

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.4

initials

Definition
Identifies the entry's initials. Does not identify the entry's surname.

For example:

initials: BFA

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.43

internationaliSDNNumber

Definition
Contains the ISDN number of the entry. This is in the internationally agreed format for ISDN addresses given in CCITT Rec. E. 164.

For example:

interntionaliSDNNumber: +SO 812467

This attribute is defined in RFC 2256.

Syntax
IA5String, multi-valued.

OID
2.5.4.25

janetMailbox

Definition
Specifies an email address. This attribute is intended for the convenience of UK users unfamiliar with rfc822 mail addresses. Entries using this attribute must also include an rfc822Mailbox attribute.

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.46

jpegPhoto

Definition
Contains a JPEG photo of the entry.

For example:

jpegPhoto:: AAAAAA==

This attribute is defined in RFC 2798.

Syntax
Binary, multi-valued.

OID
0.9.2342.19200300.100.1.60

keyWords

Definition
Contains keywords for the entry.

For example:

keyWords: directory LDAP X.500

This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.102.1.7

knowledgeInformation

Definition
This attribute is no longer used.

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.2

l (localityName)

Definition
Identifies the county, city, or other geographical area in which the entry is located or with which it is in some other way associated.

For example:

localityName: Santa Clara

or

l: Santa Clara

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.7

labeledURI

Definition
Specifies a Uniform Resource Identifier (URI) that is relevant in some way to the entry. Values placed in the attribute should consist of a URI (currently only URLs are supported) optionally followed by one or more space characters and a label.

For example:

labeledURI: http://home.iplanet.com

labeledURI: http://home.iplanet.com          iPlanet website

This attribute is defined in RFC 2079.

Syntax
IA5String, multi-valued.

OID
1.3.6.1.4.1.250.1.57

lastModifiedBy

Definition
Specifies the distinguished name of the last user to modify the associated entry.

For example:

lastModifiedby: cn=Jane Doe,ou=Quality Control,dc=siroe, dc=com

This attribute is defined in RFC 1274.

Syntax
DN, multi-valued.

OID
0.9.2342.19200300.100.1.24

lastModifiedTime

Definition
Defines the last time, in UTC format, that a change was made to the entry.

For example:

lastModifiedTime: Thursday, 22-Sep-93 14:15:00 GMT

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.23

mail

Definition
Identifies a user's primary email address (the email address retrieved and displayed by "white-pages" lookup applications).

For example:

mail: banderson@siroe.com

This attribute is defined in RFC 1274.

Syntax
DirectoryString, multi-valued.

OID
0.9.2342.19200300.100.1.3

mailPreferenceOption

Definition
Not used in Messaging Server 4.0.

Indicates a preference for inclusion of user names on mailing lists (electronic or physical). Accepted values include:

• 0: user doesn't want to be included in mailing lists.

• 1: user consents to be added to any mailing list.

• 2: user only wants to be added to mailing lists which the list provider views as relevant to the user's professional interests.

The absence of this attribute for a person should be interpreted as if the attribute was present with value "no-list-inclusion". This attribute should be interpreted by anyone using the directory to derive mailing lists, and its value respected.

For example:

mailPreferenceOption:0

This attribute is defined in RFC 1274.

Syntax
INTEGER, single-valued.

OID
0.9.2342.19200300.100.1.47

manager

Definition
Identifies the distinguished name of the entry's manager.

For example:

manager:cn=Jane Doe, ou=Quality Control, dc=siroe, dc=com

This attribute is defined in RFC 1274.

Syntax
DN, multi-valued.

OID
0.9.2342.19200300.100.1.10

member

Definition
Identifies the distinguished names for each member of the group.

For example:

member: cn=John Doe, dc=siroe, dc=com

This attribute is defined in RFC 2256.

Syntax
DN, multi-valued.

OID
2.5.4.31

memberCertificateDescription

Definition
This attribute is a multivalued attribute, where each value is a description, a pattern, or a filter matching the subject DN of a certificate (usually certificates used for SSL client authentication).

memberCertificateDescription matches any certificate that contains a subject DN with the same AVAs as the description. The description may contain multiple "ou=" AVAs. A matching DN must contain those same "ou=" AVAs, in the same order, although it may contain other AVAs (including other "ou=" AVAs) interspersed. For any other attribute type (not ou), there should be at most one AVA of that type in the description. If there are several, all but the last are ignored.

A matching DN must contain that same AVA, but no other AVA of the same type nearer the root (later, syntactically).

AVAs are considered the same if they contain the same attribute description (case-insensitive comparison) and the same attribute value (case-insensitive comparison, leading and trailing whitespace ignored, and consecutive whitespace characters treated as a single SP).

In order to be considered a member of a group with the following memberCertificateDescription, a certificate would need to include ou=x, ou=A, and o=siroe, but not o=company.

memberCertificateDescription: {ou=x, ou=A, o=company, o=siroe}

In order to match the group's requirements, a certificate's subject DNs must contain the same ou attribute types in the same order as defined in the memberCertificateDescription attribute.

This attribute is defined in iPlanet Directory Server.

Syntax
IA5String, multi-valued.

OID
2.16.840.1.113730.3.1.199

memberURL

Definition
Identifies an URL associated with each member of a group. Any type of labeled URL can be used.

For example:

memberURL: ldap:///cn=jdoe,dc=siroe,dc=com

This attribute is defined in iPlanet Directory Server.

Syntax
IA5String, multi-valued.

OID
2.16.840.1.113730.3.1.198

mobile

Definition
Identifies the entry's mobile or cellular phone number. Abbreviation: mobile

For example:

mobileTelephoneNumber: 415-555-4321

or

mobile: 415-555-4321

This attribute is defined in RFC 1274.

Syntax
TelephoneNumber, multi-valued.

OID
0.9.2342.19200300.100.1.41

multiLineDescription

Definition
Provides descriptive text for a mail user. When represented in LDIF format, each line should be separated by a dollar sign ($). The Directory Server expects 0 or 1 occurrences of this attribute per mail account.

For example:

multiLineDescription: Account Administrator and$directory manager.

To represent an actual dollar sign ($) or backslash (\) within this text, use the escaped hex values \24 and \5c respectively. For example, to represent the string:

The dollar ($) value can be found in the c:\cost file.

provide the string:

The dollar (\24) value can be found$in the c:\5ccost file.

This attribute is defined in Internet White Pages Pilot.

Syntax
DirectoryString, multi-valued.

OID
1.3.6.1.4.1.250.1.2

name

Definition
Identifies the attribute supertype from which string attribute types used for naming may be formed. It is unlikely that values of this type will occur in an entry. LDAP server implementations that do not support attribute subtyping do not need to recognize this attribute in requests. Client implementations should not assume that LDAP servers are capable of performing attribute subtyping.

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.41

nsLicensedFor

Definition
Identifies the Netscape server the user is licensed to use. The Netscape Administration Server expects each nsLicenseUser entry to contain zero or more instances of this attribute. Valid keywords for this attribute are currently:

• mail: the user is a licensed client of the Messaging Server.

• new: the user is a licensed client of the Collabra Server.

• slapd: the user is a licensed client of the Directory Server.

• cal: the user is a licensed client of the Calendar Server.

For example:

nsLicensedFor: slapd

This attribute is defined in iPlanet Administration Services.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.36

nsLicenseEndTime

Definition
Reserved for future use.

This attribute is defined in iPlanet Administration Services.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.38

nsLicenseStartTime

Definition
Reserved for future use.

This attribute is defined in iPlanet Administration Services.

Syntax
DirectoryString, multi-valued.

OID
2.16.840.1.113730.3.1.37

o (organizationName)

Definition
Identifies the name of the organization.

For example:

organizationName: Siroe, Inc.

or

o: Siroe, Inc

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.10

objectClass

Definition
Specifies the object classes of the object. Must include the object.

For example:

objectClass: person

This attribute is defined in RFC 2256.

Syntax
DirectoryString, multi-valued.

OID
2.5.4.0

obsoletedByDocument

Definition