Schema Reference Netscape Directory Server

Previous      Contents      Index      DocHome      Next

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 Netscape Directory Server (Directory Server). Object classes that are used by the Directory Server or other Netscape products for internal operations are not documented here. For information about these object classes, please refer to the Netscape Directory Server Configuration, Command, and File Reference.

Note	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 classes 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	URL to information relevant to the account.

alias

---

Definition

Used to point to other entries in the directory tree.

Note: Aliasing is not supported in 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 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 Plug-in.

This object class is defined in 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 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 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 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 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 defines 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

Allows domain components to be defined for an entry. This object class is defined as auxiliary because it is commonly used in combination with another object class, such as (organization), ou (organizationUnitName) (organizationalUnit), or l (localityName) (locality). For example:

dn: dc=example,dc=com
objectClass: top
objectClass: organization
objectClass: dcObject
dc: example
o: Example Corporation

This object class is defined in RFC 2247.

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.

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)	Common name of the device.

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	URL 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	URL 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	URL to information relevant to the series.
telephoneNumber	Telephone number of the person responsible for the series.

domain

---

Definition

Used to define entries that represent DNS domains in the directory. The domainComponent attribute should be used for naming entries of this object class.

Used to represent Internet domain names (for example, example.com).

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 dominComponent attribute be present, and permits several other attributes to be present in the entry.

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	URL 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.

domainRelatedObject

---

Definition

Used to define entries which representDNS/NRS domains which are "equivalent" to an X.500 domain, for example, an organisation or organisational 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 DSAs in the directory.

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 common name of the series.
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	URL 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 (country)	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 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	URL to information relevant to the group.

groupOfNames

---

Definition

Used to define entries for a group of names.

Note: The definition in Directory Server differs from the standard definition. In the standard definition, member is a required attribute. In Directory Server member is an allowed attribute. 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	URL 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	URL 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 Directory Server 3.0.

This object class is defined in 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	URL to information relevant to the group.

inetOrgPerson

---

Definition

Used to define entries representing people in an organization's enterprise network. Inherits cn and sn from the person object class.

This object class is defined in RFC 2798.

Superior Class

person

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 adress.
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 locator that is relevant to the person.
mail	The person's email address.
manager	Distinguished name of the object's manager.
mobile	The person's mobile phone number.
o (organizationName)	Organization to which the person belongs
ou (organizationUnitName)	Organizational unit to which the person belongs.
pager	The person's pager number.
photo	Photo of the person, in binary form.
physicalDeliveryOfficeName	Location where physical deliveries can be made to the person.
postOfficeBox	The person's post office box.
postalAddress	The person's mailing address.
postalCode	The postal code for this address (such as a United States zip code).
preferredDeliveryMethod	The person's preferred method of contact or delivery.
preferredLanguage	The person's preferred written or spoken language.
registeredAddress	Postal address suitable for reception of expediated documents, where the recipient must verify delivery.
roomNumber	The room number in which the person is located.
secretary	Distinguished name of the person's secretary or administrative assistant.
seeAlso	URL to information relevant to the person.
st (stateOrProvinceName)	State or province in which the person is located.
street	Street address at which the person is located.
telephoneNumber	The person's telephone number.
teletexTerminalIdentifier	Identifier for the person's teletex terminal.
telexNumber	The person's telex number.
title	The person's job title.
uid (userID)	Identifies the person's user id (usually the logon ID).
userCertificate	Stores a user's certificate in cleartext (not used).
userPassword	Password with which the entry can bind to the directory.
userSMIMECertificate	Stores a user's certificate in binary form. Used by Netscape Communicator for S/MIME.
x121Address	X.121 address of the person.
x500UniqueIdentifier	Reserved.

labeledURIObject

---

Definition

This object class can be added to existing directory objects to allow for inclusion of URI values. This approach does not preclude including the labeledURI attribute type directly in other object classes as appropriate.

This object class is defined in RFC 2079.

Superior Class

top

OID

1.3.6.1.4.1.250.3.1

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

labeledURI

Universal Resource Locator that is relevant to the entry.

locality

---

Definition

Used to define entries that represent localities or geographic areas.

This object class is defined in RFC 2256.

Superior Class

top

OID

2.5.6.3

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

description	Text description of the locality.
l (localityName)	Place in which the entry is located.
searchGuide	Specifies information for a suggested search criteria when using the entry as the base object in the directory tree for a search operation.
seeAlso	URL to information relevant to the locality.
st (stateOrProvinceName)	State or province to which the locality belongs.
street	Street address associated with the locality.

newPilotPerson

---

Definition

Used as a subclass of person, to allow the use of a number of additional attributes to be assigned to entries of the person object class. Inherits cn and sn from the person object class.

This object class is defined in Internet White Pages Pilot.

Superior Class

person

OID

0.9.2342.19200300.100.4.4

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

businessCategory	Type of business in which this person is engaged.
description	Text description of the person.
drink (favouriteDrink)	The person's favorite drink.
homePhone	The person's home phone number.
homePostalAddress	The person's home mailing address.
janetMailbox	The person's email address.
mail	The person's email address.
mailPreferenceOption	Indicates a preference for inclusion of the person's name on mailing lists (electronic or physical). Not valid in Messaging server 4.0.
mobile	The person's mobile phone number.
organizationalStatus	The person's type of employment (for example, full time).
otherMailbox	Values for electronic mailbox types other than X.400 and rfc822.
pager	The person's pager number.
personalSignature	The person's signature file.
personalTitle	The person's personal title.
preferredDeliveryMethod	The person's preferred method of contact or delivery.
roomNumber	The person's room number.
secretary	Distinguished name of the person's secretary or administrative assistant.
seeAlso	URL to information relevant to the person.
telephoneNumber	The person's telephone number.
textEncodedORAddress	The person's text-encoded Originator/Recipient (X.400) address.
uid (userID)	Identifies the person's user id (usually the logon ID).
userClass	Category of user.
userPassword	Password with which the entry can bind to the directory.

nsComplexRoleDefinition

---

Definition

Any role that is not a simple role is, by definition, a complex role.

This object class is defined in Directory Server.

Superior Class

nsRoleDefinition

OID

2.16.840.1.113730.3.2.95

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

cn (commonName)	The entry's common name.
description	Text description of the entry.

nsFilteredRoleDefinition

---

Definition

Specifies assignment of entries to the role, depending upon the attributes contained by each entry.

This object class is defined in Directory Server.

Superior Class

nsComplexRoleDefinition

OID

2.16.840.1.113730.3.2.97

Required Attributes

objectClass	Defines the object classes for the entry.
nsRoleFilter	Specifies the filter assigned to an entry.

Allowed Attributes

cn (commonName)	The entry's common name.
description	Text description of the entry.

nsLicenseUser

---

Definition

Used to track licenses for Netscape servers that are licensed on a per-client basis. nsLicenseUser is intended to be used with the inetOrgPerson object class. You can manage the contents of this object class through the Users and Groups area of the Netscape Administration Server.

This object class is defined in Netscape Administration Services.

Superior Class

top

OID

2.16.840.1.113730.3.2.7

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

nsLicensedFor	Netscape server that the user is licensed to use.
nsLicenseEndTime	Reserved for future use.
nsLicenseStartTime	Reserved for future use.

nsManagedRoleDefinition

---

Definition

Specifies assignment of a role to an explicit, enumerated list of members.

This object class is defined in Directory Server.

Superior Class

nsSimpleRoleDefinition

OID

2.16.840.1.113730.3.2.96

Required Attributes

objectClass

Defines the object classes for the entry.

Allowed Attributes

cn (commonName)	The entry's common name.
description	Text description of the entry.

nsNestedRoleDefinition

---

Definition

Specifies containment of one or more roles of any type within the role.

This object class is defined in Directory Server.

Superior Class

nsComplexRoleDefinition

OID

2.16.840.1.113730.3.2.98

Required Attributes

objectClass	Defines the object classes for the entry.
nsRoleDn	Specifies the roles assigned to an entry.

Allowed Attributes

cn (commonName)	The entry's common name.
description	Text description of the entry.

nsRoleDefinition

---

Definition

All role definition object classes inherit from the nsRoleDefi