Sun ONE Messaging and Collaboration 6.0 Schema Reference Manual |
Chapter 2
Object ClassesThis chapter describes LDAP object classes for Sun Open Net Environment (ONE) Messaging and Collaboration products. The objects are listed alphabetically.
Note that the object classes and attributes specific only to Sun ONE Identity Server are found in a separate chapter, Chapter 4, "Sun ONE Identity Server Classes and Attributes."
Note also that the object classes and attributes specific only to iPlanet Delegated Administrator for Messaging are found in a separate chapter, Chapter 5, "iPlanet Delegated Administrator for Messaging Classes and Attributes."
List of Object ClassesThis chapter describes the following object classes:
Object Classes
domainSupported by
iPlanet Messaging Server 5.0, iPlanet Calendar Server 5.1
Definition
Object class used to define entries that represent DNS domains.
This class can only be used with an entry that doe not correspond to an organization, organizational unit, or other type of object for which an object class has been defined.
This is a core class for both Messaging and Calendar products.
Superior Class
top
Object Class Type
structural
OID
0.9.2342.19200300.100.4.13
Required Attributes
Allowed Attributes
associatedName, businessCategory, description, destinationIndicator, fax (facsimileTelephoneNumber), internationalIsdnNumber, localityName, manager, o (organizationName (see o)), physicalDeliveryOfficeName, postOfficeBox, postalAddress, postalCode, preferredDeliveryMethod, registeredAddress, searchGuide, seeAlso, st, street, telephoneNumber, telexTerminalIdentifier, telexNumber, userPassword, x121Address
groupOfUniqueNamesSupported by
iPlanet Messaging Server 5.0, iPlanet Calendar Server 5.1
Definition
Defines entries for a group of unique names. A static group entry must be extended by this class. (A group entry may also be extended by inetUser.) Use roles to define dynamic groups. For information on roles, see the Sun ONE Directory Server Administrator’s Guide.
Superior Class
top
Object Class Type
structural
OID
2.5.6.17
Required Attributes
Allowed Attributes
businessCategory, description, o, ou, owner, seeAlso
icsAdministratorSupported by
Not currently used.
Definition
Specifies a calendar administrator. Must be used in conjunction with other object classes.
Superior Class
Object Class Type
structural
OID
2.16.840.1.113730.3.2.145
Required Attributes
N/A
Allowed Attributes
icsAdminRole, icsExtended, icsExtendedGroupPrefs
icsCalendarDomainSupported by
Sun ONE Calendar Server 5.1.1
Definition
Specifies a calendar domain. Must be used in conjunction with inetDomain.
Superior Class
top
Object Class Type
structural
OID
1.3.6.1.4.1.42.2.27.9.2.4
Required Attributes
N/A
Allowed Attributes
The following attributes are currently used:
icsAllowedServiceAccess, icsAllowRights, icsDefaultAccess, icsDomainNames, icsExtendedDomainPrefs, icsStatus, icsTimezone
The following attributes are reserved but not implemented for this object class:
icsAnonymousAllowWrite, icsAnonymousCalendar, icsAnonymousDefaultSet, icsAnonymousLogin, icsAnonymousSet, icsDomainAllowed, icsDomainNotAllowed, icsDWPBackEndHosts, icsExtended, icsMandatorySubscribed, icsMandatoryView, icsPreferredHost, icsQuota, icsRecurrenceBound, icsRecurrenceDate, icsSessionTimeout, icsSourceHtml,
icsCalendarDWPHostSupported by
Sun ONE Calendar Server 5.1.1
Definition
Reserved; not implemented.
Contains configuration and other information specific to one DWP server. Each entry tracks which domain it serves. The domain names are used to scope searches.
Superior Class
Object Class Type
structural
OID
1.3.6.1.4.1.42.2.27.9.2.1
Required Attributes
N/A
Allowed Attributes
cn,description, icsDomainNames, icsDWPHost, icsExtended, icsRegularExpressions, icsStatus
icsCalendarGroupSupported by
iPlanet Calendar Server 5.1
Definition
Reserved, not implemented.
Superior Class
Object Class Type
structural
OID
1.3.6.1.4.1.42.2.27.9.2.5
Required Attributes
Allowed Attributes
N/A
icsCalendarResourceSupported by
iPlanet Calendar Server 5.1, Sun ONE Messaging and Collaboration User Management Utility 1.0
Modified in 5.1.1 – attributes added: icsDWPHost, icsPartition,uid
Definition
Specifies a calendar resource, such as a conference room or piece of equipment that must be scheduled. Must be used in conjunction with inetResource. Not all attributes are currently used.
Sun ONE Identity Server 6.1 reserves this as a marker class for calendar resources but does not support calendar resources yet.
Superior Class
inetResouce
Object Class Type
structural
OID
1.3.6.1.4.1.42.2.27.9.2.3
Required Attributes
N/A
Allowed Attributes
The following attributes are currently used:
cn, description, icsCalendar, icsDWPHost, icsPartition, icsStatus, icsTimezone, mail, mailAlternateAddress, uid
The following attributes are reserved but not implemented for this object class:
icsAlias, icsCapacity, icsContact, icsExtended, icsExtendedResourcePrefs, icsGeo, icsPreferredHost, icsQuota
icsCalendarUserSupported by
iPlanet Calendar Server 5.1
Modified in 5.1.1 – attributes added: icsDWPHost, icsPartition
Definition
Specifies a calendar user, including the DWP host name.
Superior Class
top
Object Class Type
auxiliary
OID
1.3.6.1.4.1.42.2.27.9.2.2
Required Attributes
N/A
Allowed Attributes
These attributes are currently in use:
cn, givenName, icsAllowedServiceAccess, icsCalendar, icsCalendarOwned, icsDWPHosticsExtendedUserPrefs,icsFirstDay, icsPartition, icsSet, icsStatus, icsSubscribed, icsTimezone, mail, mailAlternateAddress, preferredLanguage, sn, uid, userPassword
These attributes are reserved but not currently used:
icsDefaultSet, icsExtended, icsFreeBusy, icsGeo, icsPreferredHost, icsQuota, nswcalDisallowAccess
inetAdminSupported by
iPlanet Messaging Server 5.0
Definition
Identifies administrator user or group.
Superior Class
top
Object Class Type
Auxiliary
OID
2.16.840.1.113730.3.2.112
Required Attributes
Allowed Attributes
inetDomainSupported by
iPlanet Messaging Server 5.0
Definition
Used in two-tree LDAP data models to extend the base entry created by domain in the DC Tree. It represents a hosted domain account and is used in conjunction with mailDomain and (optionally inetDomainAuthInfo) for creating a hosted domain node in the DC Tree suitable for mail services for the hosted organization. This object class must be used for all hosted domain entries in the DC Tree.
Sun ONE Identity Server uses this as a marker class for domains in the DC Tree.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.129
Required Attributes
Allowed Attributes
inetDomainAliasSupported by
iPlanet Messaging Server 5.0
Definition
Structural class for creating domain alias entries in the DC Tree for the compatibility mode LDAP data model. Entries may be created that point at other hosted domain objects. Such domain alias entries must be extended by this object class. Attribute aliasedObjectName, inherited from the parent object class alias (see RFC 2256), holds the DN of the LDAP entry for which the node is an alias.
Use this object class when you want two identical domains with different names. If you want two domains that have different attribute settings, create two inetDomain entries and use the inetCanonicalDomainName attribute to decorate the domain to use for mail routing.
This object class is not used in the native mode LDAP data model. Instead, to show the aliases for a domain, the (Organization Tree) domain entry is extended by sunManagedOrganization and decorated with the businessCategory attribute.
Superior Class
alias
Object Class Type
structural
OID
2.16.840.1.113730.3.2.131
Required Attributes
Allowed Attributes
N/A
inetDomainAuthInfoSupported by
iPlanet Messaging Server 5.0
Definition
This object class is used to extend the domain entry with search filter, domain cert map, and a canonical domain name if more than one hosted domain refers to the same organization subtree.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.133
Required Attributes
N/A
Allowed Attributes
domainUidSeparator, inetDomainSearchFilter, inetDomainCertMap, inetCanonicalDomainName
inetLocalMailRecipientSupported by
iPlanet Messaging Server 5.0
Definition
Stores information that provides a way to designate an LDAP entry as one that represents a local (intra-organizational) email recipient, to specify the recipient’s email address(es), and to provide routing information pertinent to the recipient. This is intended to support SMTP message transfer agents in routing RFC 822-based email within a private enterprise only, and is not to be used in the process of routing email across the public Internet.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113.730.3.2.147
Required Attributes
N/A
Allowed Attributes
mail, mailAlternateAddress, mailHost, mailRoutingAddress
inetMailAdministratorSupported by
iPlanet Messaging Server 5.0
Definition
LDAP group defined with groupOfUniqueNames can be overlaid with this object class. Members (listed in the attribute uniqueMember) of a group overlaid with this object class and where mailAdminRole is set to storeAdmin get IMAP proxyauth (proxy authentication) rights over all users in the same domain in which the group entry exists.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.148
Required Attributes
N/A
Allowed Attributes
inetMailGroupSupported by
iPlanet Messaging Server 5.0
Definition
Used to extend the base entry created by groupOfUniqueNames to define a group of mail recipients. inetMailGroup is used to store attributes of a mailing list. It is used in conjunction with inetLocalMailRecipient and inetMailGroupManagement (for mailing lists managed by the Delegated Administrator).
Superior Class
top
Object Class Type
auxiliary
OID
1.3.6.1.4.1.42.2.27.2.2.2
Required Attributes
N/A
Allowed Attributes
dataSource, inetMailGroupStatus, mailConversionTag, mailDeferProcessing, mailDeliveryFileURL, mailDeliveryOption, mailEquivalentAddress, mailMsgMaxBlocks, mailProgramDeliveryInfo, mailRejectText, memberURL, mgrpAddHeader, mgrpAllowedBroadcaster, mgrpAllowedDomain, mgrpAuthPassword, mgrpBroadcasterPolicy, mgrpDeliverTo, mgrpDisallowedBroadcaster, mgrpDisallowedDomain, mgrpErrorsTo, mgrpModerator, mgrpMsgMaxSize, mgrpMsgPrefixText, mgrpMsgRejectAction, mgrpMsgRejectText, mgrpMsgSuffixText, mgrpNoDuplicateChecks, mgrpRemoveHeader, mgrpRFC822MailMember, preferredLanguage, uniqueMember
inetMailUserSupported by
iPlanet Messaging Server 5.0
Definition
Used to extend the base entry created by inetOrgPerson to define a messaging service user. It represents a mail account and is used in conjunction with inetUser and inetLocalMailRecipient. Optionally, inetSubscriber may also be used for general account management purposes.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.146
Required Attributes
N/A
Allowed Attributes
cn, dataSource, icsQuota, mailAllowedServiceAccess,mailAntiUBEService, mailAutoReplyMode, mailAutoReplySubject, mailAutoReplyTimeOut, mailAutoReplyText, mailAutoReplyTextInternal, mailConversionTag, mailDeferProcessing, mailDeliveryOption, mailEquivalentAddress, mailForwardingAddress, mailMessageStore, mailMsgMaxBlocks, mailMsgQuota, mailProgramDeliveryInfo, mailQuota, mailSieveRuleSource, mailSMTPSubmitChannel, mailUserStatus, nswmExtendedUserPrefs
inetOrgPersonSupported by
Specified here for reference only.
Definition
All user entries are created with this object class. Refer to the internet draft The LDAP inetOrgPerson Object Class for further details.
Superior Class
organizationalPerson
Object Class Type
structural
OID
2.16.840.1.113730.3.2.2
Required Attributes
N/A
Allowed Attributes
businessCategory, givenName, mail, uid, preferredLanguage
inetResourceSupported by
iPlanet Calendar Server 5.1
Definition
Specifies a resource, which is defined as an object to which calendar services are provided. For example, a conference room, or a piece of equipment shared by many that needs to be scheduled.
Superior Class
top
Object Class Type
structural
OID
2.16.840.1.113730.3.2.142
Required Attributes
Allowed Attributes
facsimileTelephoneNumber, inetResourceStatus, mail, postalAddress, telephoneNumber
inetSubscriberSupported by
iPlanet Messaging Server 5.0
Definition
Used to extend the base entry created by inetOrgPerson to define a user. It represents a subscriber account and may be used in conjunction with inetUser, inetMailUser, and ipUser for creating a mail account.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.134
Required Attributes
N/A
Allowed Attributes
inetSubscriberAccountId,inetSubscriberChallenge, inetSubscriberResponse
inetUserSupported by
iPlanet Messaging Server 5.0, Sun ONE Calendar Server 5.1.1
Definition
It represents a user account, or a resource (defined as any object to which services are provided) account, and is used in conjunction with inetMailUser and ipUser for creating a mail account. When creating user accounts, this object class extends the base entry created by inetOrgPerson.
This attribute can be used with icsCalendarUser for creating a calendar user account. (Note that inetResource is used by Calendar Server to create resource accounts.)
User and resource entries must be extended by this object class. Group entries may be extended with this class.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.130
Required Attributes
N/A.
Allowed Attributes
inetUserHttpURL (see note),inetUserStatus, memberOf (see note),uid, userPassword
Note
The attributes inetUserHttpURL, and memberOf are deprecated for this object class and are likely to be removed from the class in future versions of Sun ONE schema.
ipUserSupported by
iPlanet Messaging Server 5.0
Superior Class
top
Definition
Object class for services like mail and calendar. Used to extend the base entry created by inetOrgPerson and inetUser. This object class holds the reference to the personal address book container and the class of service specifier.
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.135
Required Attributes
N/A
Allowed Attributes
inetCoS, memberOfPAB, maxPabEntries, pabURI
mailDomainSupported by
iPlanet Messaging Server 5.0
Definition
Auxiliary class used to extend the base entry created by domain and inetDomain for enabling messaging services for the hosted domain. It represents a hosted domain account with access to Messaging Service. This object class must be used for all hosted domain entries.
In the absence of the mailPublicFolderDefaultRights attribute for a maliPublicFolder entry, the presence of the attribute in the mailDomain entry allows administrators to specify the default rights to assign to the public folder.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.151
Required Attributes
N/A
Allowed Attributes
mailAccessProxyPreAuth, mailAccessProxyReplay, mailClientAttachmentQuota, mailDomainAllowedServiceAccess, mailDomainConversionTag, mailDomainCatchallAddress, mailDomainDiskQuota, mailDomainMsgMaxBlocks, mailDomainMsgQuota, mailDomainReportAddress, mailDomainSieveRuleSource,mailDomainStatus, mailDomainWelcomeMessage, mailPublicFolderDefaultRights, mailQuota,mailRoutingHosts, mailRoutingSmartHost, preferredLanguage, preferredMailHost,
mailPublicFolderSupported by
Sun ONE Messaging Server 6.0
Definition
Defines a public folder.
Superior Class
top
Object Class Type
structural
OID
Required Attributes
Allowed Attributes
mailMessageStore, mailPublicFolderDefaultRights, mailDeliveryOption
msgVanityDomainUserSupported by
iPlanet Messaging Server 5.0
Definition
This object class and its attribute are deprecated in the current release, and may not be supported in future releases. Sites should stop using this feature and consider migrating current vanity domains to hosted domains.
Auxiliary class for supporting the notion of a vanity domain for messaging. Used to extend the base mail user entry to assign a vanity domain to the user.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.150
Required Attributes
N/A
Allowed Attributes
organizationSupported by
iPlanet Messaging Server 5.0
Definition
Defines entries that represent organizations. An organization is generally assumed to be a large, relatively static grouping within a larger corporation or enterprise.
Superior Class
top
OID
2.5.6.4
Required Attributes
objectClass, o (organizationName)
Allowed Attributes
businessCategory, description, destinationIndicator, facsimileTelephoneNumber, internationalIsdnNumber, l (localityName), physicalDeliveryOfficeName, postalAddress, postalCode, postOfficeBox, preferredDeliveryMethod, registeredAddress, searchGuide, seeAlso, st, street, telephoneNumber, teletexTerminalIdentifier, telexNumber, userPassword
organizationalUnitSupported by
iPlanet Messaging Server 5.0
Definition
Defines entries that represent organizations. An organization is generally assumed to be a large, relatively static grouping within a larger corporation or enterprise.
Superior Class
top
OID
2.5.6.5
Required Attributes
objectClass, ou
Allowed Attributes
businessCategory, description, destinationIndicator, facsimileTelephoneNumber, internationalIsdnNumber, l (localityName), physicalDeliveryOfficeName, postalAddress, postalCode, postOfficeBox, preferredDeliveryMethod, registeredAddress, searchGuide, seeAlso, st, street, telephoneNumber, teletexTerminalIdentifier, telexNumber, userPassword
pabSupported by
iPlanet Messaging Server 5.0
Definition
The data model used is as follows:
pabPerson is a user entry in the personal address book.
pabGroup is the group entry and corresponds to a personal distribution list. For example, the pabGroup “pab-notes” may contain pabPersons micky and john.
pab is the address book that contains zero or more pabPerson and zero or more pabGroup entries. This is the top level logical container. pab may contain pabPerson and/or pabGroup. A pabPerson may belong in zero or more pabGroup and zero or more pab.
pabPerson may belong to zero or more pabGroup entries. This link is established by memberOfPABGroup, a multi-valued attribute holding the DN of the pabGroup in which the pabPerson belongs. A pabPerson may also belong to many personal address book’s. This link is established by having the DN of the pab listed as a value of the attribute memberOfPAB.
All users and groups belong in the default personal address book called “All.”
Superior Class
top
Object Class Type
structural
OID
2.16.840.1.113730.3.2.140
Required Attributes
Allowed Attributes
pabGroupSupported by
iPlanet Messaging Server 5.0
Definition
pabGroup is a group entry in a personal address book (pab) and corresponds to a personal distribution list. For example, the pabGroup “pab-notes” may contain pabPersons micky and john.
Superior Class
top
Object Class Type
structural
OID
2.16.840.1.113730.3.2.139
Required Attributes
Allowed Attributes
description, memberOfPAB, nickName, un
pabPersonSupported by
iPlanet Messaging Server 5.0
Definition
A user entry in the personal address book (pab).
Superior Class
inetOrgPerson
Object Class Type
structural
OID
2.16.840.1.113730.3.2.138
Required Attributes
N/A
Allowed Attributes
calCalURI, calFBURL, co, dateOfBirth, mailAlternateAddress, memberOfPAB, memberOfPABGroup, nickName, organizationName (see o), ou (oranizationalUnitName), un
userPresenceProfileSupported by
iPlanet Messaging Server 5.0
Definition
Used to store the presence information for a user.
Superior Class
top
Object Class Type
auxiliary
OID
2.16.840.1.113730.3.2.136
Required Attributes
N/A
Allowed Attributes
vacationEndDate, vacationStartDate