Netscape Communications Corporation ("Netscape") and its licensors retain all ownership rights to the software programs offered by
Netscape (referred to herein as "Software") and related documentation. Use of the Software and related documentation is governed
by the licenseagreement for the Software and applicable copyright law.
Your right to copy this documentation is limited by copyright law. Making unauthorized copies, adaptations or compilation works is
prohibited and constitutes a punishable violation of the law. Netscape may revise this documentation from time to time without
notice.
THIS DOCUMENTATION IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND. IN NO EVENT SHALL NETSCAPE BE
LIABLE FOR INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES OF ANY KIND ARISING FROM ANY
ERROR IN THIS DOCUMENTATION, INCLUDING WITHOUT LIMITATION ANY LOSS OR INTERRUPTION OF BUSINESS,
PROFITS, USE, OR DATA.
Netscape and the Netscape N logo are registered trademarks of Netscape Communications Corporation in the United States and
other countries. Other Netscape logos, product names, and service names are also trademarks of Netscape Communications
Corporation, which may be registered in other countries. Other product and brand names are the exclusive property of their
respective owners.
The downloading, exporting, or reexporting of Netscape software or any underlying information or technology must be in full
compliance with all United States and other applicable laws and regulations. Any provision of Netscape software or documentation
to the U.S. government is with restricted rights as described in the license agreement for that Software.
Index ....................................................................... 157
8Netscape Directory Server Schema Reference • January 2002
Page 9
About This Reference Guide
Netscape Directory Server (Directory Server) 6.x is a powerful and scalable
distributed directory server based on the industry-standard Lightweight Directory
Access Protocol (LDAP). Directory Server is the cornerstone for building a
centralized and distributed data repository that can be used in your intranet, over
your extranet with your trading partners, or over the public Internet to reach your
customers.
This preface contains the following sections:
•Purpose of This Guide (page 9)
•Directory Server Overview (page 10)
•Contents of This Guide (page 10)
•Prerequisite Reading (page 11)
•Conventions Used in This Book (page 11)
•Related Information (page 12)
Purpose of This Guide
This Schema Reference guide describes the standard directory schema for Directory
Server, and lists all the object classes and attributes defined by the standard
schema. The information provided here is intended for the administrator who
manages and maintains the schema.
9
Page 10
Directory Server Overview
Directory Server Overview
The major components of Directory Server include:
•An LDAP server—The core of the directory service, provided by the
daemon, and compliant with the LDAP v3 Internet standards.
•Directory Server Console—An improved management console that
dramatically reduces the effort of setting up and ma intaining your directory
service. The Directory Server Console is part of Netscape Console, the common
management framework for Netscape servers.
•SNMP Agent—Permits you to monitor your directory server in real time using
the Simple Network Management Protocol (SNMP).
•Online backu p and restore—Allows you to create backups and restore from
backups while the server is running.
Contents of This Guide
Chapter 1, “About Schema” provides an overview of some of the basic concepts of
the directory schema, a nd li sts the files in which the schema is described. It
describes object classes, attributes and Object Identifiers (OIDs), and briefly
discusses schema checking and extending server schema.
Chapter 2, “Object Class Reference” contains an alphabetical list of the object
classes accepted by the default schema. It gives a definition of each object class, and
gives the list of required and allowed attributes specific to the particular object
class. However, any mandatory and optional attributes inherited from superior
object classes are not listed.
ns-slapd
Chapter 3, “Attribute Reference” contains an alphabetic list of the standard
attributes. It gives a definition of each attribute, and gives the attribute syntax.
Chapter 4, “Operational Attributes, Special Attributes, and Special Object
Classes” contains operational attributes used by Directory Server. The chapter also
describes some special a ttributes and object classes that are used by the server.
10Netscape Directory Server Schema Reference • January 2002
Page 11
Prerequisite Reading
This guide describes the standard schema and the standard object classes and
attributes. However, this guide does not describe how to design, customize or
maintain your schema, nor does it give any information on replication. Those
concepts are described in the N ets cap e Directory Server Deployment Guid e.You
should read that book before continuing with this manual.
When you are familiar with directory server schema concepts, and have done some
preliminary planning for your directory service, you can install the Directory
Server. The instructions for installing the various Directory Server components are
contained in the Ne tsc a pe Directory Server Installation Guide.
Preliminary planning includes deciding how to represent the data you store. You
should chose predefined schema elements to meet as many of your needs as
possible. These predefined schema elements are listed in this guide.
Prerequisite Reading
Conventions Used in This Book
This section explains the conventions used in this book.
screen or text that you should type. It is also used for filenames, functions, and
examples.
Throughout this book you will see path references of the form:
/usr/netscape/servers/slapd-
The /usr/netscape/servers directory is the default installation directory. If you
have installed the Directory Server in a different location, you should adapt the
path accordingly. serverID represents the server identifier you gave the server
when you installed it. For example, if you gave the server an identifier of
phonebook, then the actual path would be:
/usr/netscape/servers/slapd-phonebook/. . .
Schema files are stored in the /usr/netscape/servers/slapd-
directory.
All paths specified in this manual are i n UNIX format. If you are using a Windows
NT-based directory server, use equivalent paths.
serverID
/...
serverID
/config
About This Reference Guide11
Page 12
Related Information
Related Information
The document set for Directory Server also contains the following guides:
•Netscape Directo ry Server Installation Guide. Procedures for installing your
Directory Server as well as procedures for migrating your Directory Server.
•Netscape Directory Server Deployment Guide. Provides an overview for planning
your deployment of the Directory Server. Includes deployment examples.
•Netscape Directo ry Server Administrator’s Guide. Procedures for the day-to-day
maintenance of your directory server. Includes information on configuring
server-side plug-ins.
•Netscape Directory Server Configuration, Command, and File Reference.
Information about the command-line scripts, configuration attributes, and log
files shipped with Directory Server.
•Netscape Directo ry Server Plug-In Prog ramm er’s Guide. Describes how to write
server plug-ins in order to custom ize and extend the capabilities of Directory
Server.
For a list of documentation installed with Directory Server, open the
<server_root>/manual/en/slapd/index.htm file, where <server_root> is the
directory in which you installed Directory Server.
For the latest information about Directory Server, including current release notes,
complete product documentation, technical notes, and deployment information,
checkthissite:
http://enterprise.netscape.com/docs
12Netscape Directory Server Schema Reference • January 2002
Page 13
Chapter1
About Schema
This chapter provides an overview of some of the basic concepts of the directory
schema, and lists the files in which the schema is described. It describes object
classes, attributes and object identifiers (OIDs), and briefly discusses extending
server schema and schema checking.
This chapter contains the following sections:
•Schema Definition (page 13)
•Schema Supported by Directory Server 6.x (page 17)
•Object Identifiers (OIDs) (page 19)
•Extending Server Schema (page 20)
•Schema Checking (page 20)
Schema Definition
The directory schema is a set of rules that defines how the data can be stored in the
directory. The data is stored in the form of directory entries. Each entry is a set o f
attributes and their values. Each entry must have an object class. The object class
specifies the kind of object the entry describes and defines the set of attributes it
contains.The schema defines the type of entries allowed, their attribute structure
and the syntax of the attributes.The schema can be modified and extended if it does
not meet your required needs.
To find detailed information about object classes, attributes, and how the Netscape
Directory Server (Directory Server) uses the schema, please refer to the
Directory Server Deployment Guide.
Netscape
13
Page 14
Schema Definition
Object Classes
In LDAP, an object class defines the set of attributes that can be used to define an
entry. The LDAP standard provides some basic types of object classes, including:
•Groups, including unordered lists of individual objects or groups of objects.
•Locations, such as the country name and description.
•Organizations.
•People.
•Devices.
Required and Allowed Attributes
Every object class includes a number of required attributes and of allowed
attributes. Required attributes include the attributes that must be present in entries
using the object class. All entries require the objectClass attribute, which defines
the object classes assigned to the entry.
Allowed attributes include the attributes that may be present in entries using the
object class.
Example: Object Class = person
Required Attributes
object class
cn (common name)
sn (surname)
Allowed Attributes
description
seeAlso
telephoneNumber
userPassword
Object Class Inheritance
An entry can have more than one object class. For example, the entry for a person is
defined by the person object class, but may also be defined by attributes in the
inetOrgPerson, groupOfNames, and organization object classes.
14Netscape Directory Server Schema Reference • January 2002
Page 15
Schema Definition
The server’s object class structure determines the list of required and allowed
attributes for a particular entry. For example, a person entry is usually defined
with the following object class structure:
objectClass: top
objectClass: person
objectClass: organizationalPerson
objectClass: inetOrgperson
In this structure, the inetOrgperson inherits from the organizationalPerson and
person object classes. Therefore, when you assign the inetOrgperson object class to
an entry, it automatically inherits the required and allowed attributes from the
superior object class.
Attributes
Directory data is represented as attribute-value pairs. Any piece of information in
the directory is associated with a descriptive attribute.
For instance, the
commonName,orcn, attribute is used to store a person’s name. A
person named Jonas Salk can be represented in the directory as
cn: Jonas Salk
Each person entered in the directory can be defined by the collection of attributes
in the
inetorgperson object class. Other attributes used to define this entry could
include:
givenname: Jonas
surname: Salk
mail: jonass@example.com
Attribute Syntax
Each attribute has a syntax definition that describes the type of information
provided by the attribute.
Attribute syntax is used by the Directory Server to perform sorting and pattern
matching.
Table 1-1 lists the different syntax methods that can be applied to attributes, and
gives an OID and a definition for each syntax method.
Chapter 1About Schema15
Page 16
Schema Definition
Table 1-1Attribute Syntax
Syntax MethodOIDDefinition
Binary1.3.6.1.4.1.1466.115.121.1.5Indicates that values for this attribute are binary
Boolean1.3.6.1.4.1.1466.115.121.1.7Indicates that this attribute has one of only two
values: True or False
Country String1.3.6.1.4.1.1466.115.121.1.11Indicates that values for this attribute are
limited to exactly two printable string
characters, for example US
DN1.3.6.1.4.1.1466.115.121.1.12Indicates that values for this attribute are DNs.
DirectoryString1.3.6.1.4.1.1466.115.121.1.15Indicates that values for this attribute are not
case sensitive
GeneralizedTime1.3.6.1.4.1.1466.115.121.1.24Indicates that values for this attribute are
encoded as printable strings. The time zone
must be specified. It is strongly recommended
to use GMT time.
IA5String1.3.6.1.4.1.1466.115.121.1.26Indicates that values for this attribute are case
sensitive.
INTEGER1.3.6.1.4.1.1466.115.121.1.27Indicates that valid values for this attribute are
numbers.
OctetString1.3.6.1.4.1.1466.115.121.1.40Same behavior as binary
Postal Address1.3.6.1.4.1.1466.115.121.1.41Indicates that values for this attribute are
encoded according to
postal-address = dstring * (“$”
dstring)
where each dstring component is encoded as a
value of type DirectoryString syntax.
Backslashes and dollar characters, if they occur,
are quoted, so that they will not be mistaken for
line delimiters. Many servers limit the postal
address to 6 lines of up to thirty characters. For
example:
1234 Main St.$Anytown, TX 1234$USA
TelephoneNumber1.3.6.1.4.1.1466.115.121.1.50Indicates that values for this attribute are in the
form of telephone numbers. It is recommended
to use telephone numbers in international form
16Netscape Directory Server Schema Reference • January 2002
Page 17
Schema Supported by Directory Server 6.x
Syntax MethodOIDDefinition
URIindicates that the values for this attribute are in
the form of a URL, introduced by a string such
as http://, https://, ftp://, ldap://, ldaps://.
TheURIhas the same behavioras IA5String.See
RFC 2396.
Single-Valued and Multi-Valued Attributes
By default, m os t attributes are multi-valued. This means that an entry can contain
the same attribute with multiple values. For example,
are all attributes that can have more than one value. Attributes that are
single-valued—that is, only one instance of the attribute can be specified—are
noted as such. For example,
uidNumber can only have one possible value.
cn, tel and object class
Schema Supported by Directory Server 6.x
The schema provided with Directory Server 6.x is described in a set of files stored
in the
You can modify the schema by creating new object classes and attributes. These
modifications are stored in a separate file called
modify the standard files provided with the Directory Server, because you incur
the risk of breaking compatibility with other Netscape products, or of causing
interoperability problems with directory servers from vendors other than Netscape
Communications Corporation.
For more information about how the Directory Server stores information and
suggestions for planning directory schema, refer to the Netscape Directory S erv erDeployment G ui de.
The following tables list the schema files that are provided with Directory Server.
Table 1-2 lists the schema files that are used by the Directory Server. Table 1-3 lists
the schema files that are used by other Netscape products.
00core.ldifRecommended core schema from the X.500 and LDAP
standards (RFCs), and schema used by the Directory
Server itself
Chapter 1About Schema17
Page 18
Schema Supported by Directory Server 6.x
Schema FilenamePurpose
05rfc2247.ldifSchema from RFC 2247 and related pilot schema
05rfc2927.ldifSchema from RFC 2927 "MIME Directory Profile for
10rfc2307.ldifSchema from RFC 2307 "An Approach for Using
20subscriber.ldifCommon schema elements for Netscape-Nortel
25java-object.ldifSchema from RFC 2713 "Schema for Representing
28pilot.ldifSchema from the pilot RFCs, especially RFC 1274, that
30ns-common.ldifCommon Netscape schema
"Using Domains in LDAP/X.500 Distinguished
Names"
LDAP Schema"
LDAP as a Network Information Service"
subscriber interoperability
Java(tm) Objects in an LDAP Directory"
is no longer recommended by Netscape for use in new
deployments.
50ns-directory.ldifAdditional schema used by Directory Server 4.x
50ns-value.ldifNetscape servers "value item" schema
99user.ldifCustomer modifications to the schema
Table 1-3Schema Files used by other Netscape Products
Schema FilenamesPurpose
50netscape-servicemgt.ldifNetscape service management schema elements
50ns-admin.ldifSchema used by Netscape Administration Server
50ns-calendar.ldifNetscape Calendar Server schema
50ns-certificate.ldifSchema for Netscape Certificate Management System
50ns-compass.ldifSchema for the Netscape Compass Server
50ns-delegated-admin.ldifSchema for Netscape Delegated Administrator 4.5
50ns-legacy.ldifLegacy Netscape Schema
50ns-mail.ldifSchema for Netscape Messaging Server
50ns-mcd-browser.ldifSchema for Netscape Mission Control Desktop - Browser
50ns-mcd-config.ldifSchema for Netscape Mission Control Desktop -
18Netscape Directory Server Schema Reference • January 2002
Configuration
Page 19
Object Identifiers (OIDs)
50ns-mcd-li.ldifSchema for Netscape Mission Control Desktop - Location
Independence
50ns-mcd-mail.ldifSchema for Netscape Mission Control Desktop - Mail
50ns-media.ldifSchema for Netscape Media Server
50ns-mlm.ldifSchema for Netscape Mailing List Manager
50ns-msg.ldifSchema for Netscape Web Mail
50ns-netshare.ldifSchema for Netscape Netshare
50ns-news.ldifSchema for Netscape Collabra Server
50ns-proxy.ldifSchema for Netscape Proxy Server
50ns-wcal.ldifSchema for Netscape Web Calendaring
50ns-web.ldifSchema for Netscape Web Server
Object Identifiers (OIDs)
Object identifiers (OIDs) are assigned to all attributes and object classes to conform
to the LDAP and X.500 standards. An OID is a sequence of integers, typically
written as a dot-separated string. When no OID is specified, the Directory Server
automatically uses ObjectClass_name-oid and attribute_name-oid.
TheNetscapebaseOIDis
2.16.840.1.113730
The base OID for the Directory Server is
2.16.840.1.113730.3
All Netscape-defined attributes have the base OID of
2.16.840.1.113370.3.1
All Netscape-defined object classes have the base OID of
2.16.840.1.113730.3.2
For more information about OIDs or to request a prefix for your enterprise, please
go to the Internet Assigned Number Authority (IANA) web site at
http://www.iana.org/.
Chapter 1About Schema19
Page 20
Extending Server Schema
Extending Server Schema
The Directory Server schema includes hundreds of object classes and attributes that
can be used to meet most of your requirements. This schema can be extended with
new object classes and attributes that meet evolving requirements for the directory
service in the enterprise.
When adding new attributes to the schema, a new object class should be created to
contain them (adding a new attribute to an existing object class can compromise
the Directory Server’s compatibility with existing LDAP clients that rely on the
standard LDAP schema and may cause difficulties when upgrading the server).
For more information about extending server schema, refer to the NetscapeDirectory Serve r Deployment Guide .
Schema Checking
You should run Directory Server with schema checking turned on.
The schema checking capability of Directory Server checks entries when you add
them to the directory or when you modify them, to verify that:
•Object classes a nd attributes used in the entry are defined in the directory
schema
•Attributes required for an object class are contained in the entry
•Only attributes allowed by the object class are contained in the entry
Schema checking also occurs when importing a database using LDIF. For more
information, refer to the Ne tsc ape Directory Server Administrator’s Guide.
20Netscape Directory Server Schema Reference • January 2002
Page 21
Chapter2
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 .
NOTEWhen 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.
Chapter 2Object Class Reference21
Page 22
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
objectClassDefines the object classes for the entry.
uid (userID)Identifies the account’s user ID.
Allowed Attributes
descriptionText description of the entry.
hostHostname 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)
seeAlsoURL to information relevant to the account.
Organizational unit to which the account belongs.
22Netscape Directory Server Schema Reference • January 2002
Page 23
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
objectClassDefines the object classes for the entry.
aliasedObjectNameDistinguishedname of the entry for w hich this entry is
an alias.
Chapter 2Object Class Reference23
Page 24
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
This object class is defined in Directory Server.
Superior Class
cosSuperDefinition
OID
2.16.840.1.113730.3.2.100
Required Attributes
objectClassDefines the object classes for the entry.
cosAttributeProvides the name of the attribute for which you want to
cosSpecifier attribute).
generate a value. You can specify more than one cosAttribute
value.
Allowed Attributes
cn (commonName)Common name of the entry.
cosSpecifierSpecifies the attribute value used by a classic CoS,
cosTemplateDnProvides the DN of the t emplate entry associated with
descriptionText description of the entry.
24Netscape Directory Server Schema Reference • January 2002
which, along with the template entry’s DN, identifies
the template entry.
the CoS definition.
Page 25
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
objectClassDefines the object classes for the entry.
Allowed Attributes
aciEvaluates what rights are granted or denied when the
directory server receives an LDAP request from a
client.
cn (commonName)Common name of the entry.
cosAttributeProvides the name of the attribute for which you want
to generate a value. You can specify more than one
cosAttribute value.
cosSpecifierSpecifies the attribute value used by a classic CoS,
which, along with the template entry’s DN, identifies
the template entry.
cosTargetTreeDetermines the subtrees of the DIT to which the CoS
schema applies.
cosTemplateDnProvides the DN of the template entry associated with
the CoS definition.
uid (userID)Identifies the user ID.
Chapter 2Object Class Reference25
Page 26
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
attribute.
This object class is defined in Directory Server.
Superior Class
cosSuperDefinition
OID
2.16.840.1.113730.3.2.102
Required Attributes
objectClassDefines the object classes for the entry.
cosAttributeProvides the name of the attribute for which you want to
cosIndirectSpecifier
generate a value. You can specify more than one cosAttribute
value.
Allowed Attributes
cn (commonName)Common name of the entry.
cosIndirectSpecifierSpecifiesthe attribute value used by an indirect CoS to
identify the template entry.
descriptionText description of the entry.
26Netscape Directory Server Schema Reference • January 2002
Page 27
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
attribute.
This object class is defined in Directory Server.
Superior Class
cosSuperDefinition
OID
2.16.840.1.113730.3.2.101
Required Attributes
objectClassDefines the object classes for the entry.
cosAttributeProvides the name of the attribute for which you want to
cosTemplateDn
generate a value. You can specify more than one cosAttribute
value.
Allowed Attributes
cn (commonName)Common name of the entry.
cosTemplateDnProvides the DN of the template entry associated with
the CoS definition.
descriptionText description of the entry.
Chapter 2Object Class Reference27
Page 28
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
objectClassDefines the object classes for the entry.
cosAttributeProvides the name of the attribute for whichyouwantto
generate a value. You can specify more than one
cosAttribute value.
Allowed Attributes
cn (commonName)Common name of the entry.
descriptionText description of the entry.
28Netscape Directory Server Schema Reference • January 2002
Page 29
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
objectClassDefines the object classes for the entry.
Allowed Attributes
cn (commonName)Common name of the entry.
cosPrioritySpecifies which template provides the attribute
value, when CoS templates compete to provide an
attribute value.
Chapter 2Object Class Reference29
Page 30
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
objectClassDefines 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
descriptionText description of the country.
searchGuideSpecifies information for suggested search criteria when
using the entry as the base object in the directory tree for
a search operation.
30Netscape Directory Server Schema Reference • January 2002
Page 31
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
objectClassDefines the object classes for the entry.
dc (domainComponent)One component of a domain name.
Chapter 2Object Class Reference31
Page 32
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
objectClassDefines the object classes for the entry.
cn (commonName)Common name of the device.
Allowed Attributes
descriptionText description of the device.
l (localityName)Place in which the device is located.
o (organizationName)Organization to which the device belongs.
ou
(organizationUnitName)
ownerDistinguished name of the person responsible for the
seeAlsoURL to information relevant to the device.
serialNumberSerial number of the device.
Organizational unit to which t he device belongs.
device.
32Netscape Directory Server Schema Reference • January 2002
Page 33
document
objectClassDefines the object classes for the entry.
documentIdentifierUnique identifier for a 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
Allowed Attributes
abstractAbstract of the document.
audioStoresasoundfileinbinaryformat.
authorCnAuthor’s common, or given, name.
authorSnAuthor’s surname.
cn (commonName)Common name of the document.
descriptionText description of the document.
dITRedirectDistinguished name to use as a redirect for the entry.
documentAuthorDistinguished name of the document author.
documentLocationLocation of the original document.
documentPublisherPerson or organization that published the document.
documentStoreNot defined.
documentTitleThe document’s title.
documentVersionThe document’s version number.
infoInformation about the object.
jpegPhotoPhoto in jpeg format.
Chapter 2Object Class Reference33
Page 34
keyWordsKeywords that describe the document.
l (localityName)Place in which the document is located.
lastModifiedByDistinguished name of the last user to modify the
document.
lastModifiedTimeLast time the document was modified.
managerDistinguished name of the object’s manager.
o (organizationName)Organization to which the document belongs.
obsoletedByDocumentDistinguished name of a document that obsoletes this
document.
obsoletesDocumentDistinguished name of a document that is obsoleted by
this document.
ou
Organizational unit to which the document belongs.
(organizationUnitName)
photoPhoto of the document, in binary form.
seeAlsoURL to information relevant to the document.
subjectSubject of the document.
uniqueIdentifierSpecific item used to distinguish between two entries
when a distinguished name has been reused.
updatedByDocumentDistinguished name of a document that is an updated
version of this document.
updatesDocumentDistinguished name of a document for which this
document is an updated version.
34Netscape Directory Server Schema Reference • January 2002
Page 35
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
objectClassDefines the object classes for the entry.
cn (commonName)The common name of the series.
Allowed Attributes
descriptionText description of the series.
l (localityName)Place in which the series is located.
o (organizationName)Organization to which the series belongs.
ou
(organizationUnitName)
seeAlsoURL to information relevant to the series.
telephoneNumberTelephone number of the person responsible for the
Organizational unit to which the series belongs.
series.
Chapter 2Object Class Reference35
Page 36
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,organizationalunit 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 permi ts 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
objectClassDefines the object classes for the entry.
dc (domainComponent)One component of a domain name.
Allowed Attributes
associatedNameEntry in the organizationaldirectory tree associated with
aDNSdomain.
businessCategoryType of business in which this domain is engaged.
descriptionText description of the domain.
destinationIndicatorCountry and city associated with the entry needed to
provide Public Telegram Service.
fax
(fascimileTelephoneNumber)
internationalISDNNumberDomain’s ISDN number.
36Netscape Directory Server Schema Reference • January 2002
Domain’s fax number.
Page 37
l (localityName)Place in which the domain is located.
o (organizationName)Organization to which the domain belongs.
physicalDeliveryOfficeNameLocation where physical deliveries can be made.
postOfficeBoxDomain’s post office box.
postalAddressDomain’s mailing address.
postalCodeThe postal code for this address (such as a United States
zip code).
preferredDeliveryMethodDomain’s preferred method of contact or delivery.
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
searchGuideSpecifies information for suggested search criteria when
using the entry as the base object in the directory tree for
a search operation.
seeAlsoURL to information relevant to the domain.
st
State or province in which the domain is located.
(stateOrProvinceName)
streetStreet address in which the domain is l ocated.
telephoneNumberDomain’s telephone number.
teletexTerminalIdentifierIdentifier for a domain’s teletex terminal.
telexNumberDomain’s telex number.
userPasswordPassword with which the entry can bind to the directory.
x121AddressX.121 address of the domain.
Chapter 2Object Class Reference37
Page 38
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
objectClassDefines the object classes for the entry.
associatedDomainSpecifies a DNS domain associated with an object in the
directory tree.
38Netscape Directory Server Schema Reference • January 2002
Page 39
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
objectClassDefines the object classes for the entry.
cn (commonName)The common name of the series.
presentationAddressContains an OSI presentation address for the entry.
Allowed Attributes
descriptionText description of the series.
knowledgeInformationThis attribute is no longer used.
l (localityName)Place in which the series is located.
o (organizationName)Organization to which the series belongs.
ou
(organizationUnitName)
seeAlsoURL to information relevant to the series.
supportedApplicationContextThis attribute contains the identifiers of OSI
Organizational unit to which the series belongs.
application contexts.
Chapter 2Object Class Reference39
Page 40
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
objectClassDefines the object classes for the entry.
Allowed Attributes
All attributes known to the server.
40Netscape Directory Server Schema Reference • January 2002
Page 41
friendlyCountry
Definition
Used to define cou ntry 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
objectClassDefines the object classes for the entry.
co
(friendlyCountryName)
c (country)Contains the two-character code representing country
Allowed Attributes
descriptionText description of the country.
searchGuideSpecifies information for suggested search criteria when
Storesthenameofacountry.
names, as defined by ISO, in the directory.
using the entry as the base object in the directory tree for
a search operation.
Chapter 2Object Class Reference41
Page 42
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
objectClassDefines the object classes for the entry.
cn (commonName)The group’s common name.
Allowed Attributes
businessCategoryType of business in which the group is engaged.
descriptionText description of the group’s purpose.
memberCertificateDescriptionValues 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)
ownerDistinguished name of the person responsible for the
seeAlsoURL to information relevant to the group.
Organizational unit to which the group belongs.
group.
42Netscape Directory Server Schema Reference • January 2002
Page 43
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
objectClassDefines the object classes for the entry.
cn (commonName)The group’s common name.
Allowed Attributes
businessCategoryType of business in which the group is engaged.
descriptionText description of the group’s purpose.
memberDistinguished name of a group member.
o (organizationName)Organization to which the group belongs.
ou
(organizationUnitName)
ownerDistinguished name of the person responsible for the
seeAlsoURL to information relevant to the group.
Organizational unit to which the group belongs.
group.
Chapter 2Object Class Reference43
Page 44
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
objectClassDefines the object classes for the entry.
cn (commonName)The group’s common name.
Allowed Attributes
businessCategoryType of business in which the group is engaged.
descriptionText description of the group’s purpose.
o (organizationName)Organization to which the group belongs.
ou
(organizationUnitName)
ownerDistinguished name of the person responsible for the
seeAlsoURL to information relevant to the group.
uniqueMemberDistinguished name of a unique group member.
Organizational unit to which the group belongs.
group.
44Netscape Directory Server Schema Reference • January 2002
Page 45
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
objectClassDefines the object classes for the entry.
cn (commonName)The group’s common name.
Allowed Attributes
businessCategoryType of business in which the group is engaged.
descriptionText description of the group’s purpose.
memberURLURL associated with each member of the group.
o (organizationName)Organization to which the group belongs.
ou
(organizationUnitName)
ownerDistinguished name of the person responsible for the
seeAlsoURL to information relevant to the group.
Organizational unit to which the group belongs.
group.
Chapter 2Object Class Reference45
Page 46
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
objectClassDefines the object classes for the entry.
cn (commonName)The person’s common name.
sn (surname)The person’s surname, or last name.
Allowed Attributes
audioStoresasoundfileinbinaryformat.
businessCategoryType of business in which the person is engaged.
carLicenseThe license plate number of the person’s vehicle.
departmentNumberDepartment for which the person works.
descriptionText description of the person.
destinationIndicatorCountry and city associated with the entry needed to provide
Public Telegram Service.
displayNamePreferred name of a person to be used when displaying
entries.
employeeNumberThe person’s employee number.
employeeTypeThe person’s type of employment (for example, full
time).
fax
(fascimileTelephoneNumber)
The person’s fax number.
46Netscape Directory Server Schema Reference • January 2002
Page 47
givenNameThe person’s given, or first, name.
homePhoneTheperson’s home phone number.
homePostalAddressThe person’s home mailing adress.
initialsThe person’s initials.
internationalISDNNumberThe person’s ISDN number.
jpegPhotoPhoto in JPEG format.
l (localityName)Place in which the person is located.
labeledURIUniversal resource locator that is relevant to the person.
mailThe person’s email address.
managerDistinguished name of the object’s manager.
mobileThe person’s mobile phone number.
o (organizationName)Organization to which the person belongs
ou
Organizational unit to which the person belongs.
(organizationUnitName)
pagerTheperson’s pager number.
photoPhoto of the person, in binary form.
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the person.
postOfficeBoxThe person’s post office box.
postalAddressThe person’s mailing address.
postalCodeThe postal code for this address (such as a United States zip
code).
preferredDeliveryMethodThe person’s preferred method of contact or delivery.
preferredLanguageThe person’s preferred written or spoken language.
registeredAddressPostal address suitable for reception of expediated documents,
where the recipient must verify delivery.
roomNumberThe room number in which the person is located.
secretaryDistinguished name of the person’s secretary or
administrativeassistant.
seeAlsoURL to information relevant to the person.
st (stateOrProvinceName)State or province in which the person is located.
streetStreet address at which the person is located.
Chapter 2Object Class Reference47
Page 48
telephoneNumberThe person’s telephone number.
teletexTerminalIdentifierIdentifier for the person’s teletex terminal.
telexNumberThe person’s telex number.
titleThe person’s job title.
uid (userID)Identifies the person’s user id (usually the logon ID).
userCertificateStores a user’s certificate in cleartext (not used).
userPasswordPassword with which the entry can bind to the directory.
userSMIMECertificateStores a user’s certificate in binary form. Used by
Netscape Communicator for S/MIME.
x121AddressX.121 address of the person.
x500UniqueIdentifierReserved.
48Netscape Directory Server Schema Reference • January 2002
Page 49
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
objectClassDefines the object classes for the entry.
Allowed Attributes
labeledURIUniversal Resource Locator that is relevant to the entry.
Chapter 2Object Class Reference49
Page 50
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
objectClassDefines the object classes for the entry.
Allowed Attributes
descriptionText description of the locality.
l (localityName)Place in which the entry is located.
searchGuideSpecifies information for a suggested search criteria
when using the entry as the base object in the directory
tree for a search operation.
seeAlsoURL to information relevant to the locality.
st
(stateOrProvinceName)
streetStreet address associated with the locality.
Stateorprovincetowhichthelocalitybelongs.
50Netscape Directory Server Schema Reference • January 2002
Page 51
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
objectClassDefines the object classes for the entry.
cn (commonName)The person’s common name.
sn (surname)The person’s surname, or last name.
Allowed Attributes
businessCategoryType of business in which this person is engaged.
descriptionText description of the person.
drink (favouriteDrink)The person’s favorite drink.
homePhoneTheperson’s home phone number.
homePostalAddressThe person’s home mailing address.
janetMailboxThe person’s email address.
mailThe person’s email address.
mailPreferenceOptionIndicates a preference for inclusion of the person’s name
on mailing lists (electronic or physical). Not valid in
Messaging server 4.0.
mobileThe person’s mobile phone number.
organizationalStatusThe person’s type of employment (for example, full
time).
Chapter 2Object Class Reference51
Page 52
otherMailboxValues for electronic mailbox types other than X.400 and
rfc822.
pagerTheperson’s pager number.
personalSignatureThe person’s signature file.
personalTitleThe person’s personal title.
preferredDeliveryMethodThe person’s preferred method of contact or delivery.
roomNumberThe person’s room number.
secretaryDistinguished name of the person’s secretary or
administrative assistant.
seeAlsoURL to information relevant to the person.
telephoneNumberThe person’s telephone number.
address.
uid (userID)Identifies the person’s user id (usually the logon ID).
userClassCategory of user.
userPasswordPassword with which the entry can bind to the directory.
52Netscape Directory Server Schema Reference • January 2002
Page 53
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
objectClassDefines the object classes for the entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
Chapter 2Object Class Reference53
Page 54
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
objectClassDefines the object classes for the entry.
nsRoleFilterSpecifies the filter assigned to an entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
54Netscape Directory Server Schema Reference • January 2002
Page 55
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
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
objectClassDefines the object classes for the entry.
inetOrgPerson object class. You can
Allowed Attributes
nsLicensedForNetscape server that the user is licensed to use.
nsLicenseEndTimeReserved for future use.
nsLicenseStartTimeReserved for future use.
Chapter 2Object Class Reference55
Page 56
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
objectClassDefines the object classes for the entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
56Netscape Directory Server Schema Reference • January 2002
Page 57
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
objectClassDefines the object classes for the entry.
nsRoleDNSpecifies the roles assigned to an entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
Chapter 2Object Class Reference57
Page 58
nsRoleDefinition
Definition
All role defini tion object classes inherit from the nsRoleDefinition object class.
This object class is defined in Directory Server.
Superior Class
ldapSubEntry
OID
2.16.840.1.113730.3.2.93
Required Attributes
objectClassDefines the object classes for the entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
58Netscape Directory Server Schema Reference • January 2002
Page 59
nsSimpleRoleDefinition
Definition
Roles containing this object class are called simple roles because they have a
deliberately limited flexibility, which makes it easy to:
•Enumerate the members of a role.
•Determine whether a given entry possesses a particul ar role.
•Enumerate all the roles possessed by a given entry.
•Assign a particular role to a given entry.
•Remove a particular role from a given entry.
This object class is defined in Directory Server.
Superior Class
nsRoleDefinition
OID
2.16.840.1.113730.3.2.94
Required Attributes
objectClassDefines the object classes for the entry.
Allowed Attributes
cn (commonName)The entry’s common name.
descriptionText description of the entry.
Chapter 2Object Class Reference59
Page 60
organization
Definition
Used to define entries that represent organizations. An organization is generally
assumed to be a large, relatively static grouping within a larger corporation or
enterprise.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.4
Required Attributes
objectClassDefines the object classes for the entry.
o (organizationName)The name of the organization.
Allowed Attributes
businessCategoryType of business in which the organization is engaged.
descriptionText description of the organization.
destinationIndicatorCountry and city associated with the entry needed to
streetStreet address at which the organization is located.
telephoneNumberThe organization’s telephone number.
teletexTerminalIdentifierIdentifier for the organization’s teletex terminal.
telexNumberThe organization’s telex number.
userPasswordPasswordwith which the entry can bind to the
directory.
x121AddressX.121 address of the organization.
Chapter 2Object Class Reference61
Page 62
organizationalPerson
Definition
Used to define entries for people employed by or associated with an organization.
cn and sn are inherited from the person object cl ass.
This object class is defined in RFC 2256.
Superior Class
person
OID
2.5.6.7
Required Attributes
objectClassDefines the object classes for the entry.
cn (commonName)The person’s common name.
sn (surname)The person’s surname, or last name.
Allowed Attributes
descriptionText description of the person.
destinationIndicatorCountry and city associated with the person needed to
provide Public Telegram Service.
fax
(fascimileTelephoneNumber)
internationalISDNNumberThe person’s ISDN number.
l (localityName)Place in which the person is located.
ou
(organizationUnitName)
physicalDeliveryOfficeNameLocation where physical deliveries can be made to this
postalAddressThe person’s mailing address.
postalCodeThe postal code for this address (such as a United States
The person’s fax number.
Organizational unit to which the person belongs.
person.
zip code).
62Netscape Directory Server Schema Reference • January 2002
Page 63
postOfficeBoxThe person’s post office box.
preferredDeliveryMethodThe person’s preferred method of contact or delivery.
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
seeAlsoURL to information relevant to the person.
st
State or province in which the person is located.
(stateOrProvinceName)
streetStreet address at which the person is located.
telephoneNumberThe person’s telephone number.
teletexTerminalIdentifierIdentifier for the person’s teletex terminal.
telexNumberThe person’s telex number.
titleThe person’s job title.
userPasswordPassword with which the entry can bind to the directory.
x121AddressX.121 address of the person.
Chapter 2Object Class Reference63
Page 64
organizationalRole
Definition
Used to define entries that represent roles held by people within an organization.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.8
Required Attributes
objectClassDefines the object classes for the entry.
cn (commonName)The role’s common name.
Allowed Attributes
descriptionText description of the role.
destinationIndicatorCountry and city associated with the entry needed to
provide Public Telegram Service.
fax
(fascimileTelephoneNumber)
internationalISDNNumberISDN number of the person in the role.
l (localityName)Place in which the person in the role is located.
ou
(organizationUnitName)
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the
postalAddressThe mailing address for the person in the role.
postalCodeThe postal code for this address (such as a United States
postOfficeBoxThe post office box for the person in the role.
Fax number of the person in the role.
Organizational unit to which the person in the role
belongs.
person in the role.
zip code).
64Netscape Directory Server Schema Reference • January 2002
Page 65
preferredDeliveryMethodPreferred method of contact or delivery of the person in
the role.
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
roleOccupantDistinguished name of the person in the role.
seeAlsoURL to information relevant to the person in the role.
st
(stateOrProvinceName)
Stateorprovinceinwhichthepersonintheroleis
located.
streetStreet address at which the person in the role is located.
telephoneNumberThe person’s telephone number.
teletexTerminalIdentifierIdentifier for the teletex terminal of the person in the
role.
telexNumberTelex number of the person in the role.
x121AddressX.121 address of the person in the role.
Chapter 2Object Class Reference65
Page 66
organizationalUnit
Definition
Used to define entries that represent organizational units. An organizational unit is
generally assumed to be a relatively static grouping within a larger organization.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.5
Required Attributes
objectClassDefines the object classes for the entry.
ou
(organizationUnitName)
Allowed Attributes
businessCategoryType of business in which the organizational unit is
descriptionText description of the organizational unit.
destinationIndicatorCountry and city associatedwith the organizationalunit
l (localityName)Place in which the organizational unit is located.
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the
Thenameoftheorganizationalunit.
engaged.
needed to provide Public Telegram Service.
The organizational unit’s fax number.
organizational unit.
postalAddressThe organizational unit’s mailing address.
postalCodeThe postal code for this address (such as a United States
66Netscape Directory Server Schema Reference • January 2002
zip code).
Page 67
postOfficeBoxThe organizational unit’s post office box.
preferredDeliveryMethodThe organizational unit’s preferred method of contact or
delivery.
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
searchGuideSpecifies information for suggested search criteria when
using the entry as the base object in the directory tree for
a search operation.
seeAlsoURL to information relevant to the organizational unit.
st
(stateOrProvinceName)
State or province in which the organizational unit is
located
streetStreet address at which the organizational unit is
located.
telephoneNumberThe organizational unit’s telephone number.
teletexTerminalIdentifierIdentifier for the organizational unit’s teletex terminal.
telexNumberThe organization’s telex number.
userPasswordPassword with which the entry can bind to the
directory.
x121AddressX.121 address of the organizational unit.
Chapter 2Object Class Reference67
Page 68
person
Definition
Used to define entries that generically represent people. This object class is the base
class for the organizationalPerson object class.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.6
Required Attributes
objectClassDefines the object classes for the entry.
cn (commonName)The person’s common name.
sn (surname)The person’s surname, or last name.
Allowed Attributes
descriptionText description of the person.
seeAlsoURL to information relevant to the person.
telephoneNumberThe person’s telephone number.
userPasswordPasswordwith which the entry can bind to the
directory.
68Netscape Directory Server Schema Reference • January 2002
Page 69
pilotObject
Definition
Used as a subclass to allow additional attributes to be assigned to entries of all
other object classes.
This object class is defined in RFC 1274.
Superior Class
top
OID
0.9.2342.19200300.100.4.3
Required Attributes
objectClassDefines the object classes for the entry.
Allowed Attributes
audioStoresasoundfileinbinaryformat.
dITRedirectDistinguished name to use as a redirect for the entry.
infoInformation about the object.
jpegPhotoPhoto in jpeg format.
lastModifiedByDistinguished name of the last user to modify the object.
lastModifiedTimeLast time the object was modified.
managerDistinguished name of the object’s manager.
photoPhoto of the object.
uniqueIdentifierSpecific item used to distinguish between two entries
when a distinguished name has been reused.
Chapter 2Object Class Reference69
Page 70
pilotOrganization
Definition
Used as a subclass to allow additional attributes to be assigned to organization and
organizationalUnit object class entries.
This object class is defined in RFC 1274.
Superior Class
top
OID
0.9.2342.19200300.100.4.20
Required Attributes
objectClassDefines the object classes for the entry.
o (organizationName)Organization to which the entry belongs.
ou
(organizationUnitName)
Allowed Attributes
buildingNameName of the building in which the entry is located.
businessCategoryType of business in which the entry is engaged.
descriptionText description of the entry.
destinationIndicatorCountry and city associated with the pilot organization
fax
(fascimileTelephoneNumber)
internationalISDNNumberThe pilot organization’s ISDN number.
l (localityName)Place in which the pilot organization is located.
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the
Organizational unit to which the entry belongs.
needed to provide Public Telegram Service.
The pilot organization’s fax number.
pilot organization.
postalAddressThe pilot organization’s mailing address.
70Netscape Directory Server Schema Reference • January 2002
Page 71
postalCodeThe postal code for this address (such as a United States
zip code).
postOfficeBoxThe pilot organization’s post office box.
preferredDeliveryMethodThe pilot organization’s preferred method of contact or
delivery
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
searchGuideS pecifies information for suggested search criteria when
using the entry as the base object in the directory tree for
a search operation.
seeAlsoURL to information relevant to the pilot organization.
st
(stateOrProvinceName)
State or province in which the pilot organization is
located.
streetStreet address at which the pilot organization is located.
telephoneNumberThe pilot organization’s telephone number.
teletexTerminalIdentifierIdentifier for the pilot organization’s teletex terminal.
telexNumberThe pilot organization’s telex number.
userPasswordPassword with which the entry can bind to the directory.
x121AddressX.121 address of the pilot organization.
Chapter 2Object Class Reference71
Page 72
residentialPerson
Definition
Used by the directory server to contain a person’s residential information.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.10
Required Attributes
objectClassDefines the object classes for the entry.
cn (commonName)The person’s common name.
l (localityName)Place in which the person resides.
sn (surname)The person’s surname, or last name.
Allowed Attributes
businessCategoryType of business in which the person is engaged.
descriptionText description of the person.
destinationIndicatorCountry and city associated with the entry needed to
provide Public Telegram Service.
fax
(fascimileTelephoneNumber)
internationalISDNNumberThe person’s ISDN number.
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the
postalAddressThe person’s business mailing address.
postalCodeThe postal code for this address (such as a United States
postOfficeBoxThe person’s business post office box.
The person’s fax number.
person.
zip code).
72Netscape Directory Server Schema Reference • January 2002
Page 73
preferredDeliveryMethodThe person’s preferred method of contact or delivery.
registeredAddressPostal address suitable for reception of expedited
documents, where the recipient must verify delivery.
seeAlsoURL to information relevant to the person.
st
State or province in which the person resides.
(stateOrProvinceName)
streetStreet address at which the person is located.
telephoneNumberThe person’s telephone number.
teletexTerminalIdentifierIdentifier for the person’s teletex terminal.
telexNumberThe person’s telex number.
userPasswordPassword with which the entry can bind to the directory.
x121AddressX.121 address of the entry.
Chapter 2Object Class Reference73
Page 74
RFC822LocalPart
Definition
Used to define entries that represent the local part of RFC822 mail addresses. The
directory treats this part of an RFC822 address as a domain.
This object class is defined in Internet directory pilot.
Superior Class
domain
OID
0.9.2342.19200300.100.4.14
Required Attributes
objectClassDefines the object classes for the entry.
dc (domainComponent)Domain component of the entry.
Allowed Attributes
associatedNameEntry in the organizational directory tree associated with a
DNS domain.
businessCategoryType of business in which this local part is engaged.
cn (commonName)The local part’s common name.
descriptionText description of the local part.
destinationIndicatorCountry and city associated with the entry needed to provide
Public Telegram Service.
fax
(fascimileTelephoneNumber)
internationalISDNNumberThe local part’s ISDN number.
l (localityName)Place in which the local part is located.
o (organizationName)O rganization to which the local part belongs.
physicalDeliveryOfficeNameLocation where physical deliveries can be made to the local
postOfficeBoxThe local part’s post office box.
The local part’s fax number.
part.
74Netscape Directory Server Schema Reference • January 2002
Page 75
postalAddressThe local part’s mailing address.
postalCodeThe postal code for this address (such as a United States zip
code).
preferredDeliveryMethodLocal part’s preferred method of contact or delivery.
registeredAddressPostal address suitable for reception of expediated documents,
where the recipient must verify delivery.
searchGuideSpecifies information for suggested search criteria when using
the entry as the base object in the directory tree for a search
operation.
seeAlsoURL to information relevant to the local part.
sn (surname)The entry’s surname, or last name.
st (stateOrProvinceName)State or province in which the local part is located.
streetStreet address at which the local part is located.
telephoneNumberTelephone number associated with the local part.
teletexTerminalIdentifierIdentifier for a telex terminal associated with the local part.
telexNumberTelex number associated with the local part.
userPasswordPassword with which the entry can bind to the directory.
x121AddressX.121 address associated with the entry.
Chapter 2Object Class Reference75
Page 76
room
Definition
Used to store information in the directory about a room.
This object class is defined in RFC 1274.
Superior Class
top
OID
0.9.2342.19200300.100.4.7
Required Attributes
objectClassDefines the object classes for the entry.
cn (commonName)Common name of the room.
Allowed Attributes
descriptionText description of the room.
roomNumberThe room’s number.
seeAlsoURL to information relevant to the room.
telephoneNumberThe room’s telephone number.
76Netscape Directory Server Schema Reference • January 2002
Page 77
strongAuthenticationUser
Definition
Used to store a user’s certificate entry in the directory.
This object class is defined in RFC 2256.
Superior Class
top
OID
2.5.6.15
Required Attributes
objectClassDefines the object classes for the entry.
userCertificateStores a user’s certificate, usually in binary form.
Chapter 2Object Class Reference77
Page 78
simpleSecurityObject
Definition
Used to allow an entry to contain the userPassword attribute when an entry's
principal object classes do not allow userPassword as an attribute type. Reserved
forfutureuse.
This object class is defined in RFC 1274.
Superior Class
top
OID
0.9.2342.19200300.100.4.19
Required Attributes
objectClassDefines the object classes for the entry.
userPasswordPassword with which the entry can bind to the directory.
78Netscape Directory Server Schema Reference • January 2002
Page 79
abstract
Chapter3
Attribute Reference
This chapter contains reference information about Netscape Directory Server
(Directory Server) attributes. The attributes are listed in alphabetical order.
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.
For example:
aliasedObjectName: cn=jdoe, o=example.com
This attribute is defined in RFC 2256.
79
Page 80
Syntax
DN, single-valued.
OID
2.5.4.1
associatedDomain
Definition
Specifies a D NS domain associated with an object in the directory tree. For
example, the entry in the directory tree with a distinguished name "C=US,
O=Example Corporation" would have an associated domain of "EC.US". N ote that
all domains shou ld be represented in rfc822 order.
For example:
associatedDomain: US
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.
80Netscape Directory Server Schema Reference • January 2002
Page 81
audio
OID
0.9.2342.19200300.100.1.38
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
Chapter 3Attribute Reference81
Page 82
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:
82Netscape Directory Server Schema Reference • January 2002
Page 83
buildingName: 14
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.
Chapter 3Attribute Reference83
Page 84
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: 6ABC246
This attribute is defined in RFC 2798.
Syntax
DirectoryString, multi-valued.
OID
2.16.840.1.113730.3.1.1
84Netscape Directory Server Schema Reference • January 2002
Page 85
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:
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
CoS definition entries.
This attribute is defined in Directory Server.
Syntax
Directory String , multi-valued.
OID
2.16.840.1.113730.3.1.550
cosAttribute value. This attribute is used by all types of
86Netscape Directory Server Schema Reference • January 2002
Page 87
cosIndirectSpecifier
Description
Specifies the attribute values used by an indirect CoS to identify the template entry.
This attribute is defined in 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 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 Directory Server.
Syntax
DirectoryString, single-valued.
Chapter 3Attribute Reference87
Page 88
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 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
CoS definition entries.
This attribute is defined in Directory Server.
Syntax
DirectoryString, single-valued.
OID
2.16.840.1.113730.3.1.553
crossCertificatePair
Definition
This attribute is to be stored and requ ested in the binary form, as
‘crossCertificatePair;binary’.
cosAttribute value. This attribute is used by all types of
88Netscape Directory Server Schema Reference • January 2002
Page 89
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: example
or
dc: example
This attribute is defined in RFC 2247.
Syntax
DirectoryString, single-valued.
OID
0.9.2342.19200300.100.1.25
deltaRevocationList
Definition
This attribute is to be stored and requested in the binary form, as
‘deltaRevocationList;binary’.
This attribute is defined in RFC 2256.
Syntax
Binary, multi-valued.
Chapter 3Attribute Reference89
Page 90
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
90Netscape Directory Server Schema Reference • January 2002
Page 91
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
Chapter 3Attribute Reference91
Page 92
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, o=example.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.
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, o=example.com
92Netscape Directory Server Schema Reference • January 2002
Page 93
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:
This attribute is defined in RFC 1274.
Syntax
DN, multi-valued.
cn=John Doe, o=example.com
Chapter 3Attribute Reference93
Page 94
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
94Netscape Directory Server Schema Reference • January 2002
Page 95
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
Defines the *** of a document.
For example:
documentStore:
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: Netscape Directory Server Administrator’s Guide
Chapter 3Attribute Reference95
Page 96
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.
96Netscape Directory Server Schema Reference • January 2002
Page 97
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
Chapter 3Attribute Reference97
Page 98
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 construcing search filters.
For example:
enhancedSearchGuide: (uid=mhughes)
This attribute is defined in RFC 2798.
Syntax
DirectoryString, multi-valued.
OID
2.5.4.47
fax (fascimileTelephoneNumber)
Definition
Identifies the fax number at which the entry can be reached. Abbreviation: fax
For example:
facsimileTelephoneNumber: +1 415 555 1212
98Netscape Directory Server Schema Reference • January 2002
Page 99
or:
fax: +1 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:III
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.
Chapter 3Attribute Reference99
Page 100
OID
2.5.4.42
homePhone
Definition
Identifies the entry’s home phone number.
For example:
homeTelephoneNumber: 415-555-1212
or
homePhone: 415-555-1234
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.