Chapter 2   Object Class Reference


This chapter contains an alphabetical list of the object classes accepted by the default schema. It gives a definition of each object class, and lists its required and allowed attributes. The object classes listed in this chapter are available for you to use to support your own information in the Directory Server. Object classes that are used by the Directory Server or other iPlanet products for internal operations are not documented here. For information about these object classes, please refer to the iPlanet Directory Server Configuration, Command, and File Reference. When an object class inherits attributes from other object classes, the inherited attributes are shown in italics. An object class which inherits from another object class must appear after this object class in the .ldif file, otherwise the server will not start.

account

Definition
Used to define entries representing computer accounts.

This object class is defined in RFC 1274.

Superior Class
top

OID
0.9.2342.19200300.100.4.5

Required Attributes

objectClass	Defines the object class for the entry.
uid (userID)	Identifies the account's user ID.

Allowed Attributes

description	Text description of the entry.
host	Hostname of the computer on which the account resides.
l (localityName)	Place in which the account is located.
o (organizationName)	Organization to which the account belongs.
ou (organizationUnitName)	Organizational unit to which the account belongs.
seeAlso	DN to information relevant to the account.

alias

Definition
Used to point to other entries in the directory tree.

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

This object class is defined in RFC 2256.

Superior Class
top

OID
2.5.6.1

Required Attributes

objectClass	Defines the object classes for the entry.
aliasedObjectName	Distinguished name of the entry for which this entry is an alias.

cosClassicDefinition

Definition
Identifies the template entry using both the template entry's DN (as specified in the cosTemplateDn attribute) and the value of one of the target entry's attributes (as specified in the cosSpecifier attribute).

This object class is defined in iPlanet Directory Server.

Superior Class
cosSuperDefinition

OID
2.16.840.1.113730.3.2.100

Required Attributes

objectClass	Defines the object classes for the entry.
cosAttribute	Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value.

Allowed Attributes

cn (commonName)	Common name of the entry.
cosSpecifier	Specifies the attribute value used by a classic CoS, which, along with the template entry's DN, identifies the template entry.
cosTemplateDn	Provides the DN of the template entry associated with the CoS definition.
description	Text description of the entry.

cosDefinition

Definition
Defines the Class of Services you are using. This object class is supported in order to provide compatibility with the DS4.1 CoS Plugin.

This object class is defined in iPlanet Directory Server

Superior Class
top

OID
2.16.840.1.113730.3.2.84

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

aci	Evaluates what rights are granted or denied when the directory server receives an LDAP request from a client.
cn (commonName)	Common name of the entry.
cosAttribute	Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value.
cosSpecifier	Specifies the attribute value used by a classic CoS, which, along with the template entry's DN, identifies the template entry.
cosTargetTree	Determines the subtrees of the DIT to which the CoS schema applies.
cosTemplateDn	Provides the DN of the template entry associated with the CoS definition.
uid (userID)	Identifies the user id.

cosIndirectDefinition

Definition
Identifies the template entry using the value of one of the target entry's attributes. The attribute of the target entry is specified in the cosIndirectSpecifier attribute.

This object class is defined in iPlanet Directory Server.

Superior Class
cosSuperDefinition

OID
2.16.840.1.113730.3.2.102

Required Attributes

objectClass	Defines the object classes for the entry.
cosAttribute	Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value.

Allowed Attributes

cn (commonName)	Common name of the entry.
cosIndirectSpecifier	Specifies the attribute value used by an indirect CoS to identify the template entry.
description	Text description of the entry.

cosPointerDefinition

Definition
Identifies the template entry associated with the CoS definition using the template entry's DN value. The DN of the template entry is specified in the cosTemplateDn attribute.

This object class is defined in iPlanet Directory Server.

Superior Class
cosSuperDefinition

OID
2.16.840.1.113730.3.2.101

Required Attributes

objectClass	Defines the object classes for the entry.
cosAttribute	Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value.

Allowed Attributes

cn (commonName)	Common name of the entry.
cosTemplateDn	Provides the DN of the template entry associated with the CoS definition.
description	Text description of the entry.

cosSuperDefinition

Definition
All CoS definition object classes inherit from the cosSuperDefinition object class.

This object class is defined in iPlanet Directory Server.

Superior Class
ldapSubEntry

OID
2.16.840.1.113730.3.2.99

Required Attributes

objectClass	Defines the object classes for the entry.
cosAttribute	Provides the name of the attribute for which you want to generate a value. You can specify more than one cosAttribute value

Allowed Attributes

cn (commonName)	Common name of the entry.
description	Text description of the entry.

cosTemplate

Definition
Contains a list of the shared attribute values.

This object class is defined in iPlanet Directory Server.

Superior Class
top

OID
2.16.840.1.113730.3.2.128

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

cn (commonName)	Common name of the entry.
cosPriority	Specifies which template provides the attribute value, when CoS templates compete to provide an attribute value.

country

Definition
Used to define entries that represent countries.

This object class is defined in RFC 2256.

Superior Class
top

OID
2.5.6.2

Required Attributes

objectClass	Defines the object classes for the entry.
c (countryName)	Contains the two-character code representing country names, as defined by ISO, in the directory.

Allowed Attributes

description	Text description of the country.
searchGuide	Specifies information for suggested search criteria when using the entry as the base object in the directory tree for a search operation.

dcObject

Definition
Defines a domain component, such as a network domain that is associated with the entry. This object class is defined as auxiliary because it is commonly used in combination with another object class, such as organization, organizationUnit, or locality. For example:

dn: ou=Engineering,dc=siroe,dc=com
objectClass: top
objectClass: organizationalUnit
objectClass: dcObject
ou: Engineering
dc: eng

This object class is defined in RFC 2247.

---

Note

Suffixes often contain the dc attribute, such as dc=siroe,dc=com in the example above. Suffixes use the dc attribute to suggest that the directory they represent is associated with a certain domain. However, the suffix is a string associated with a database and is not related to the dcObject object class.

---

Superior Class
top

OID
1.3.6.1.4.1.1466.344

Required Attributes

objectClass	Defines the object classes for the entry.
dc (domainComponent)	One component of a domain name.

See Also
domain

device

Definition
Used to store information about network devices, such as printers, in the directory.

This object class is defined in RFC 2256.

Superior Class
top

OID
2.5.6.14

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The common name of the series.

Allowed Attributes

description	Text description of the device.
l (localityName)	Place in which the device is located.
o (organizationName)	Organization to which the device belongs.
ou (organizationUnitName)	Organizational unit to which the device belongs.
owner	Distinguished name of the person responsible for the device.
seeAlso	DN to information relevant to the device.
serialNumber	Serial number of the device.

document

Definition
Used to define entries which represent documents in the directory.

This object class is defined in RFC 1274.

Superior Class
top

OID
0.9.2342.19200300.100.4.6

Required Attributes

objectClass	Defines the object classes for the entry.
documentIdentifier	Unique identifier for a document.

Allowed Attributes

abstract	Abstract of the document.
audio	Stores a sound file in binary format.
authorCn	Author's common or given name.
authorSn	Author's surname.
cn (commonName)	Common name of the document.
description	Text description of the document.
dITRedirect	Distinguished name to use as a redirect for the entry.
documentAuthor	Distinguished name of the document author.
documentLocation	Location of the original document.
documentPublisher	Person or organization that published the document.
documentStore	Not defined.
documentTitle	The document's title.
documentVersion	The document's version number.
info	Information about the object.
jpegPhoto	Photo in jpeg format.
keyWords	Keywords that describe the document.
l (localityName)	Place in which the document is located.
lastModifiedBy	Distinguished name of the last user to modify the document.
lastModifiedTime	Last time the document was modified.
manager	Distinguished name of the object's manager.
o (organizationName)	Organization to which the document belongs.
obsoletedByDocument	Distinguished name of a document that obsoletes this document.
obsoletesDocument	Distinguished name of a document that is obsoleted by this document.
ou (organizationUnitName)	Organizational unit to which the document belongs.
photo	Photo of the document, in binary form.
seeAlso	DN to information relevant to the document.
subject	Subject of the document.
uniqueIdentifier	Specific item used to distinguish between two entries when a distinguished name has been reused.
updatedByDocument	Distinguished name of a document that is an updated version of this document.
updatesDocument	Distinguished name of a document for which this document is an updated version.

documentSeries

Definition
Used to define an entry that represents a series of documents.

This object class is defined in RFC 1274.

Superior Class
top

OID
0.9.2342.19200300.100.4.9

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The common name of the series.

Allowed Attributes

description	Text description of the series.
l (localityName)	Place in which the series is located.
o (organizationName)	Organization to which the series belongs.
ou (organizationUnitName)	Organizational unit to which the series belongs.
seeAlso	DN to information relevant to the series.
telephoneNumber	Telephone number of the person responsible for the series.

domain

Definition
Used to represent Internet Domains (for example, siroe.com). The domainComponent attribute should be used for naming entries of this object class.

The domain object class can only be used with an entry that does not correspond to an organization, organizational unit or other type of object for which an object class has been defined. The domain object class requires that the domainComponent attribute be present, and allows several other attributes to be present in the entry. These allowed attributes are used to describe the object represented by the domain, and may also be useful when searching.

This object class is defined in RFC 2247.

Superior Class
top

OID
0.9.2342.19200300.100.4.13

Required Attributes

objectClass	Defines the object classes for the entry.
dc (domainComponent)	One component of a domain name.

Allowed Attributes

associatedName	Entry in the organizational directory tree associated with a DNS domain.
businessCategory	Type of business in which this domain is engaged.
description	Text description of the domain.
destinationIndicator	Country and city associated with the entry needed to provide Public Telegram Service.
fax (facsimileTelephoneNumber)	Domain's fax number.
internationaliSDNNumber	Domain's ISDN number.
l (localityName)	Place in which the domain is located.
o (organizationName)	Organization to which the domain belongs.
physicalDeliveryOfficeName	Location where physical deliveries can be made.
postOfficeBox	Domain's post office box.
postalAddress	Domain's mailing address.
postalCode	The postal code for this address (such as a United States zip code).
preferredDeliveryMethod	Domain's preferred method of contact or delivery.
registeredAddress	Postal address suitable for reception of expedited documents, where the recipient must verify delivery.
searchGuide	Specifies information for suggested search criteria when using the entry as the base object in the directory tree for a search operation.
seeAlso	DN to information relevant to the domain.
st (stateOrProvinceName)	State or province in which the domain is located.
street	Street address in which the domain is located.
telephoneNumber	Domain's telephone number.
teletexTerminalIdentifier	Identifier for a domain's teletex terminal.
telexNumber	Domain's telex number.
userPassword	Password with which the entry can bind to the directory.
x121Address	X.121 address of the domain.

See Also
dcObject

domainRelatedObject

Definition
Used to define entries which represent DNS/NRS domains which are "equivalent" to an X.500 domain, for example, an organization or organizational unit.

This object class is defined in RFC 1274.

Superior Class
top

OID
0.9.2342.19200300.100.4.17

Required Attributes

objectClass	Defines the object classes for the entry.
associatedDomain	Specifies a DNS domain associated with an object in the directory tree.

dSA

Definition
Used to define entries representing Directory Server Agents.

This object class is defined in RFC 1274.

Superior Class
top

OID
2.5.6.13

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The Directory Server Agent's common name.
presentationAddress	Contains an OSI presentation address for the entry.

Allowed Attributes

description	Text description of the series.
knowledgeInformation	This attribute is no longer used.
l (localityName)	Place in which the series is located.
o (organizationName)	Organization to which the series belongs.
ou (organizationUnitName)	Organizational unit to which the series belongs.
seeAlso	DN to information relevant to the series.
supportedApplicationContext	This attribute contains the identifiers of OSI application contexts.

extensibleObject

Definition
When present in an entry, permits the entry to optionally hold any attribute. The allowed attribute list of this class is implicitly the set of all attributes known to the server.

This object class is defined in RFC 2252.

Superior Class
top

OID
1.3.6.1.4.1.1466.101.120.111

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes
All attributes known to the server.

friendlyCountry

Definition
Used to define country entries in the directory tree. This object class is used to allow more user-friendly country names than those allowed by the country object class.

This object class is defined in RFC 1274.

Superior Class
top

OID
0.9.2342.19200300.100.4.18

Required Attributes

objectClass	Defines the object classes for the entry.
co (friendlyCountryName)	Stores the name of a country.
c (countryName)	Contains the two-character code representing country names, as defined by ISO, in the directory.

Allowed Attributes

description	Text description of the country.
searchGuide	Specifies information for suggested search criteria when using the entry as the base object in the directory tree for a search operation.

groupOfCertificates

Definition
Used to describe a set of X.509 certificates. Any certificate that matches one of the memberCertificateDescription values is considered a member of the group.

This object class is defined in iPlanet Directory Server.

Superior Class
top

OID
2.16.840.1.113730.3.2.31

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The group's common name.

Allowed Attributes

businessCategory	Type of business in which the group is engaged.
description	Text description of the group's purpose.
memberCertificateDescription	Values used to determine if a particular certificate is a member of this group.
o (organizationName)	Organization to which the group of certificates belongs.
ou (organizationUnitName)	Organizational unit to which the group belongs.
owner	Distinguished name of the person responsible for the group.
seeAlso	DN to information relevant to the group.

groupOfNames

Definition
Used to define entries for a group of names.

Note: The definition in iPlanet Directory Server differs from the standard definition. In the standard definition, member is a required attribute. In iPlanet Directory Server member is an allowed attribute. iPlanet Directory Server therefore allows a group to have no member.

This object class is defined in RFC 2256.

Superior Class
top

OID
2.5.6.9

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The group's common name.

Allowed Attributes

businessCategory	Type of business in which the group is engaged.
description	Text description of the group's purpose.
member	Distinguished name of a group member.
o (organizationName)	Organization to which the group belongs.
ou (organizationUnitName)	Organizational unit to which the group belongs.
owner	Distinguished name of the person responsible for the group.
seeAlso	DN to information relevant to the group.

groupOfUniqueNames

Definition
Used to define entries for a group of unique names.

This object class is defined in RFC 2256.

Superior Class
top

OID
2.5.6.17

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The group's common name.

Allowed Attributes

businessCategory	Type of business in which the group is engaged.
description	Text description of the group's purpose.
o (organizationName)	Organization to which the group belongs.
ou (organizationUnitName)	Organizational unit to which the group belongs.
owner	Distinguished name of the person responsible for the group.
seeAlso	DN to information relevant to the group.
uniqueMember	Distinguished name of a unique group member.

groupOfURLs

Definition
An auxiliary object class of groupOfUniqueNames or groupOfNames. The group consists of a list of labeled URLs. Not supported by Netscape Directory Server 3.0.

This object class is defined in iPlanet Directory Server.

Superior Class
top

OID
2.16.840.1.113730.3.2.33

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The group's common name.

Allowed Attributes

businessCategory	Type of business in which the group is engaged.
description	Text description of the group's purpose.
memberURL	URL associated with each member of the group.
o (organizationName)	Organization to which the group belongs.
ou (organizationUnitName)	Organizational unit to which the group belongs.
owner	Distinguished name of the person responsible for the group.
seeAlso	DN to information relevant to the group.

inetOrgPerson

Definition
Used to define entries representing people in an organization's enterprise network.

This object class is defined in RFC 2798.

Superior Class
organizationalPerson

OID
2.16.840.1.113730.3.2.2

Required Attributes

objectClass	Defines the object classes for the entry.
cn (commonName)	The person's common name.
sn (surname)	The person's surname, or last name.

Allowed Attributes

audio	Stores a sound file in binary format.
businessCategory	Type of business in which the person is engaged.
carLicense	The license plate number of the person's vehicle.
departmentNumber	Department for which the person works.
description	Text description of the person.
destinationIndicator	Country and city associated with the entry needed to provide Public Telegram Service.
displayName	Preferred name of a person to be used when displaying entries.
employeeNumber	The person's employee number.
employeeType	The person's type of employment (for example, full time).
fax (facsimileTelephoneNumber)	The person's fax number.
givenName	The person's given, or first, name.
homePhone	The person's home phone number.
homePostalAddress	The person's home mailing address.
initials	The person's initials.
internationaliSDNNumber	The person's ISDN number.
jpegPhoto	Photo in JPEG format.
l (localityName)	Place in which the person is located.
labeledURI	Universal Resource Identifier that is relevant to the person.
mail	The person's email address.
manager	Distinguished name of the object's manager.