[MS-DLX]:
Distribution List Expansion Protocol
Intellectual Property Rights Notice for Open Specifications Documentation
Technical Documentation. Microsoft publishes Open Specifications documentation (“this documentation”) for protocols, file formats, data portability, computer languages, and standards support. Additionally, overview documents cover inter-protocol relationships and interactions.
Copyrights. This documentation is covered by Microsoft copyrights. Regardless of any other terms that are contained in the terms of use for the Microsoft website that hosts this documentation, you can make copies of it in order to develop implementations of the technologies that are described in this documentation and can distribute portions of it in your implementations that use these technologies or in your documentation as necessary to properly document the implementation. You can also distribute in your implementation, with or without modification, any schemas, IDLs, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications documentation.
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
Patents. Microsoft has patents that might cover your implementations of the technologies described in the Open Specifications documentation. Neither this notice nor Microsoft's delivery of this documentation grants any licenses under those patents or any other Microsoft patents. However, a given Open Specifications document might be covered by the Microsoft Open Specifications Promise or the Microsoft Community Promise. If you would prefer a written license, or if the technologies described in this documentation are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .
License Programs. To see all of the protocols in scope under a specific license program and the associated patents, visit the Patent Map.
Trademarks. The names of companies and products contained in this documentation might be covered by trademarks or similar intellectual property rights. This notice does not grant any licenses under those rights. For a list of Microsoft trademarks, visit
Fictitious Names. The example companies, organizations, products, domain names, email addresses, logos, people, places, and events that are depicted in this documentation are fictitious. No association with any real company, organization, product, domain name, email address, logo, person, place, or event is intended or should be inferred.
Reservation of Rights. All other rights are reserved, and this notice does not grant any rights other than as specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications documentation does not require the use of Microsoft programming tools or programming environments in order for you to develop an implementation. If you have access to Microsoft programming tools and environments, you are free to take advantage of them. Certain Open Specifications documents are intended for use in conjunction with publicly available standards specifications and network programming art and, as such, assume that the reader either is familiar with the aforementioned material or has immediate access to it.
Support. For questions and support, please contact .
Revision Summary
Date / Revision History / Revision Class / Comments4/4/2008 / 0.1 / New / Initial version
4/25/2008 / 0.2 / Minor / Revised and edited the technical feedback
6/27/2008 / 1.0 / Major / Revised and edited the technical feedback
8/15/2008 / 1.01 / Minor / Revised and edited the technical feedback
12/12/2008 / 2.0 / Major / Revised and edited the technical feedback
2/13/2009 / 2.01 / Minor / Revised and edited the technical feedback
3/13/2009 / 2.02 / Minor / Edited the technical feedback
7/13/2009 / 2.03 / Major / Revised and edited the technical content
8/28/2009 / 2.04 / Editorial / Revised and edited the technical content
11/6/2009 / 2.05 / Editorial / Revised and edited the technical content
2/19/2010 / 2.06 / Editorial / Revised and edited the technical content
3/31/2010 / 2.07 / Major / Updated and revised the technical content
4/30/2010 / 2.08 / Editorial / Revised and edited the technical content
6/7/2010 / 2.09 / Editorial / Revised and edited the technical content
6/29/2010 / 2.10 / Editorial / Changed language and formatting in the technical content.
7/23/2010 / 2.10 / None / No changes to the meaning, language, or formatting of the technical content.
9/27/2010 / 3.0 / Major / Significantly changed the technical content.
11/15/2010 / 3.0 / None / No changes to the meaning, language, or formatting of the technical content.
12/17/2010 / 3.0 / None / No changes to the meaning, language, or formatting of the technical content.
3/18/2011 / 3.0 / None / No changes to the meaning, language, or formatting of the technical content.
6/10/2011 / 3.0 / None / No changes to the meaning, language, or formatting of the technical content.
1/20/2012 / 4.0 / Major / Significantly changed the technical content.
4/11/2012 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/16/2012 / 4.0 / None / No changes to the meaning, language, or formatting of the technical content.
10/8/2012 / 4.0.1 / Editorial / Changed language and formatting in the technical content.
2/11/2013 / 4.0.1 / None / No changes to the meaning, language, or formatting of the technical content.
7/30/2013 / 4.1 / Minor / Clarified the meaning of the technical content.
11/18/2013 / 4.1 / None / No changes to the meaning, language, or formatting of the technical content.
2/10/2014 / 4.1 / None / No changes to the meaning, language, or formatting of the technical content.
4/30/2014 / 4.2 / Minor / Clarified the meaning of the technical content.
7/31/2014 / 4.2 / None / No changes to the meaning, language, or formatting of the technical content.
10/30/2014 / 4.3 / Minor / Clarified the meaning of the technical content.
3/30/2015 / 5.0 / Major / Significantly changed the technical content.
9/4/2015 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
7/15/2016 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
9/14/2016 / 5.0 / None / No changes to the meaning, language, or formatting of the technical content.
9/19/2017 / 6.0 / Major / Significantly changed the technical content.
12/12/2017 / 7.0 / Major / Significantly changed the technical content.
Table of Contents
1Introduction
1.1Glossary
1.2References
1.2.1Normative References
1.2.2Informative References
1.3Overview
1.4Relationship to Other Protocols
1.5Prerequisites/Preconditions
1.6Applicability Statement
1.7Versioning and Capability Negotiation
1.8Vendor-Extensible Fields
1.9Standards Assignments
2Messages
2.1Transport
2.2Common Message Syntax
2.2.1Namespaces
2.2.2Messages
2.2.3Elements
2.2.4Complex Types
2.2.5Simple Types
2.2.5.1SearchResponseState
2.2.6Attributes
2.2.7Groups
2.2.8Attribute Groups
2.2.9Common Data Structures
3Protocol Details
3.1Server Details
3.1.1Abstract Data Model
3.1.2Timers
3.1.3Initialization
3.1.4Message Processing Events and Sequencing Rules
3.1.4.1ExpandDistributionList
3.1.4.1.1Messages
3.1.4.1.1.1ExpandDistributionListSoapIn
3.1.4.1.1.2ExpandDistributionListSoapOut
3.1.4.1.2Elements
3.1.4.1.3Complex Types
3.1.4.1.3.1ExpandDistributionList
3.1.4.1.3.2ExpandDistributionListResponse
3.1.4.1.3.3DlxGroup
3.1.4.1.3.4ArrayOfActiveDirectoryObjectInfo
3.1.4.1.3.5ActiveDirectoryObjectInfo
3.1.4.1.4Simple Types
3.1.4.1.4.1ResponseState
3.1.4.1.5Attributes
3.1.4.1.6Groups
3.1.4.1.7Attribute Groups
3.1.4.2SearchAbEntry
3.1.4.2.1Messages
3.1.4.2.1.1SearchAbEntrySoapIn
3.1.4.2.1.2SearchAbEntrySoapOut
3.1.4.2.2Elements
3.1.4.2.3Complex Types
3.1.4.2.3.1SearchAbEntry
3.1.4.2.3.2AbEntryRequest
3.1.4.2.3.3AbEntryRequest.BasicSearchQuery
3.1.4.2.3.4ArrayOfAbEntryRequest.ChangeSearchQuery
3.1.4.2.3.5AbEntryRequest.ChangeSearchQuery
3.1.4.2.3.6AbEntryRequest.SearchMetadata
3.1.4.2.3.7AbEntryRequest.OrgSearchQuery
3.1.4.2.3.8SearchAbEntryResponse
3.1.4.2.3.9AbEntryResponse
3.1.4.2.3.10ArrayOfAbEntry
3.1.4.2.3.11AbEntry
3.1.4.2.3.12ArrayOfAttribute
3.1.4.2.3.13Attribute
3.1.4.2.3.14ArrayOfstring
3.1.4.2.3.15AbEntryResponse.ResponseMetadata
3.1.4.2.4Simple Types
3.1.4.2.4.1SearchVerb
3.1.4.2.5Attributes
3.1.4.2.6Groups
3.1.4.2.7Attribute Groups
3.1.4.3SearchSkypeDirectory
3.1.4.3.1Messages
3.1.4.3.1.1SearchSkypeDirectorySoapIn
3.1.4.3.1.2SearchSkypeDirectorySoapOut
3.1.4.3.2Elements
3.1.4.3.3Complex Types
3.1.4.3.3.1SearchSkypeDirectory
3.1.4.3.3.2SkypeDirectorySearchRequest
3.1.4.3.3.3SearchSkypeDirectoryResponse
3.1.4.3.3.4AbEntryResponse
3.1.4.3.3.5ArrayOfAbEntry
3.1.4.3.3.6AbEntry
3.1.4.3.3.7ArrayOfAttribute
3.1.4.3.3.8Attribute
3.1.4.3.3.9ArrayOfstring
3.1.4.3.3.10AbEntryResponse.ResponseMetadata
3.1.4.3.4Simple Types
3.1.4.3.5Attributes
3.1.4.3.6Groups
3.1.4.3.7Attribute Groups
3.1.4.4ProvideSkypeSearchFeedback
3.1.4.4.1Messages
3.1.4.4.1.1ProvideSkypeSearchFeedbackSoapIn
3.1.4.4.1.2ProvideSkypeSearchFeedbackSoapOut
3.1.4.4.2Elements
3.1.4.4.3Complex Types
3.1.4.4.3.1ProvideSkypeSearchFeedback
3.1.4.4.3.2SkypeSearchFeedbackRequest
3.1.4.4.3.3ProvideSkypeSearchFeedbackResponse
3.1.4.4.3.4SkypeSearchFeedbackResponse
3.1.4.4.3.5ArrayOfString
3.1.4.4.4Simple Types
3.1.4.4.4.1SkypeSearchFeedbackResponseCode
3.1.4.4.5Attributes
3.1.4.4.6Groups
3.1.4.4.7Attribute Groups
3.1.5Timer Events
3.1.6Other Local Events
4Protocol Examples
4.1Successful Distribution List Expansion Request and Response
4.2Successful Distribution List Expansion Request and Response with Nested Groups
4.3Unsuccessful Distribution List Expansion Request and Response
4.4Successful Basic Search Request and Response using exact match
4.5Successful Basic Search Request and Response using prefix match
4.6Unsuccessful Basic Search Request and Response
4.7Successful Change Search Request and Response
4.8Successful Change Search Request and Response using entry hash
4.9Successful Change Search Request and Response using entry and photo hash
4.10Successful Change Search Request and Response with not found entries
4.11Successful Organization Search Request and Response
4.12Successful Organization Search Request and Response using organization hash
4.13Unsuccessful Organization Search Request and Response
4.14Successful Skype Directory Search Request and Response
4.15Unsuccessful Skype Directory Search Request and Response
4.16Successful Provide Skype Search Feedback Request and Response
4.17Unsuccessful Provide Skype Search Feedback Request and Response
5Security
5.1Security Considerations for Implementers
5.2Index of Security Parameters
6Appendix A: Full WSDL
7Appendix B: Product Behavior
8Change Tracking
9Index
1Introduction
This document specifies the procedure for expanding distribution lists. It specifies the web service method that is used to get the membership of a distribution list. The same Web service can also be used to search for users and distribution lists and query attributes associated with each. The web service can also serve as a proxy for searching users in the Skype public directory.
Sections 1.5, 1.8, 1.9, 2, and 3 of this specification are normative. All other sections and examples in this specification are informative.
1.1Glossary
This document uses the following terms:
address book: A collection of Address Book objects, each of which are contained in any number of address lists.
directory service (DS): A service that stores and organizes information about a computer network's users and network shares, and that allows network administrators to manage users' access to the shares. See also Active Directory.
display name: A text string that is used to identify a principal or other object in the user interface. Also referred to as title.
distribution list: A collection of users, computers, contacts, or other groups that is used only for email distribution, and addressed as a single recipient.
fully qualified domain name (FQDN): An unambiguous domain name that gives an absolute location in the Domain Name System's (DNS) hierarchy tree, as defined in [RFC1035] section 3.1 and [RFC2181] section 11.
Global Address List (GAL): An address list that conceptually represents the default address list for an address book.
Hypertext Transfer Protocol (HTTP): An application-level protocol for distributed, collaborative, hypermedia information systems (text, graphic images, sound, video, and other multimedia files) on the World Wide Web.
Hypertext Transfer Protocol Secure (HTTPS): An extension of HTTP that securely encrypts and decrypts web page requests. In some older protocols, "Hypertext Transfer Protocol over Secure Sockets Layer" is still used (Secure Sockets Layer has been deprecated). For more information, see [SSL3] and [RFC5246].
Kerberos: An authentication system that enables two parties to exchange private information across an otherwise open network by assigning a unique key (called a ticket) to each user that logs on to the network and then embedding these tickets into messages sent by the users. For more information, see [MS-KILE].
membership: The state or status of being a member of a member group. A membership contains additional metadata such as the privacy level that is associated with the membership.
NT LAN Manager (NTLM) Authentication Protocol: A protocol using a challenge-response mechanism for authentication in which clients are able to verify their identities without sending a password to the server. It consists of three messages, commonly referred to as Type 1 (negotiation), Type 2 (challenge) and Type 3 (authentication). For more information, see [MS-NLMP].
Secure Sockets Layer (SSL): A security protocol that supports confidentiality and integrity of messages in client and server applications that communicate over open networks. SSL uses two keys to encrypt data-a public key known to everyone and a private or secret key known only to the recipient of the message. SSL supports server and, optionally, client authentication using X.509 certificates. For more information, see [X509]. The SSL protocol is precursor to Transport Layer Security (TLS). The TLS version 1.0 specification is based on SSL version 3.0 [SSL3].
Session Initiation Protocol (SIP): An application-layer control (signaling) protocol for creating, modifying, and terminating sessions with one or more participants. SIP is defined in [RFC3261].
Skype public directory: A directory containing a list of all Skype consumer users.
SOAP: A lightweight protocol for exchanging structured information in a decentralized, distributed environment. SOAP uses XML technologies to define an extensible messaging framework, which provides a message construct that can be exchanged over a variety of underlying protocols. The framework has been designed to be independent of any particular programming model and other implementation-specific semantics. SOAP 1.2 supersedes SOAP 1.1. See [SOAP1.2-1/2003].
SOAP body: A container for the payload data being delivered by a SOAP message to its recipient. See [SOAP1.2-1/2007] section 5.3 for more information.
SOAP envelope: A container for SOAP message information and the root element of a SOAP document. See [SOAP1.2-1/2007] section 5.1 for more information.
SOAP message: An XML document consisting of a mandatory SOAP envelope, an optional SOAP header, and a mandatory SOAP body. See [SOAP1.2-1/2007] section 5 for more information.
Transmission Control Protocol (TCP): A protocol used with the Internet Protocol (IP) to send data in the form of message units between computers over the Internet. TCP handles keeping track of the individual units of data (called packets) that a message is divided into for efficient routing through the Internet.
Transport Layer Security (TLS): A security protocol that supports confidentiality and integrity of messages in client and server applications communicating over open networks. TLS supports server and, optionally, client authentication by using X.509 certificates (as specified in [X509]). TLS is standardized in the IETF TLS working group.
Uniform Resource Identifier (URI): A string that identifies a resource. The URI is an addressing mechanism defined in Internet Engineering Task Force (IETF) Uniform Resource Identifier (URI): Generic Syntax [RFC3986].
Uniform Resource Locator (URL): A string of characters in a standardized format that identifies a document or resource on the World Wide Web. The format is as specified in [RFC1738].
web service method: A procedure that is exposed to web service clients as an operation that can be called on the web service. Also referred to as web method.
Web Services Description Language (WSDL): An XML format for describing network services as a set of endpoints that operate on messages that contain either document-oriented or procedure-oriented information. The operations and messages are described abstractly and are bound to a concrete network protocol and message format in order to define an endpoint. Related concrete endpoints are combined into abstract endpoints, which describe a network service. WSDL is extensible, which allows the description of endpoints and their messages regardless of the message formats or network protocols that are used.
XML namespace: A collection of names that is used to identify elements, types, and attributes in XML documents identified in a URI reference [RFC3986]. A combination of XML namespace and local name allows XML documents to use elements, types, and attributes that have the same names but come from different sources. For more information, see [XMLNS-2ED].
XML namespace prefix: An abbreviated form of an XML namespace, as described in [XML].
MAY, SHOULD, MUST, SHOULD NOT, MUST NOT: These terms (in all caps) are used as defined in [RFC2119]. All statements of optional behavior use either MAY, SHOULD, or SHOULD NOT.
1.2References
Links to a document in the Microsoft Open Specifications library point to the correct section in the most recently published version of the referenced document. However, because individual documents in the library are not updated at the same time, the section numbers in the documents may not match. You can confirm the correct section numbering by checking the Errata.
1.2.1Normative References
We conduct frequent surveys of the normative references to assure their continued availability. If you have any issue with finding a normative reference, please contact . We will assist you in finding the relevant information.
[MS-ABS] Microsoft Corporation, "Address Book File Structure".
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997,
[RFC2616] Fielding, R., Gettys, J., Mogul, J., et al., "Hypertext Transfer Protocol -- HTTP/1.1", RFC 2616, June 1999,
[RFC2818] Rescorla, E., "HTTP Over TLS", RFC 2818, May 2000,
[RFC3261] Rosenberg, J., Schulzrinne, H., Camarillo, G., Johnston, A., Peterson, J., Sparks, R., Handley, M., and Schooler, E., "SIP: Session Initiation Protocol", RFC 3261, June 2002,
[SOAP1.1] Box, D., Ehnebuske, D., Kakivaya, G., et al., "Simple Object Access Protocol (SOAP) 1.1", W3C Note, May 2000,
[SOAP1.2/1] Gudgin, M., Hadley, M., Mendelsohn, N., Moreau, J., and Nielsen, H.F., "SOAP Version 1.2 Part 1: Messaging Framework", W3C Recommendation, June 2003,
[SOAP1.2/2] Gudgin, M., Hadley, M., Mendelsohn, N., Moreau, J., and Nielsen, H.F., "SOAP Version 1.2 Part 2: Adjuncts", W3C Recommendation, June 2003,
[WSDL] Christensen, E., Curbera, F., Meredith, G., and Weerawarana, S., "Web Services Description Language (WSDL) 1.1", W3C Note, March 2001,
[XMLNS] Bray, T., Hollander, D., Layman, A., et al., Eds., "Namespaces in XML 1.0 (Third Edition)", W3C Recommendation, December 2009,
[XMLSCHEMA1] Thompson, H., Beech, D., Maloney, M., and Mendelsohn, N., Eds., "XML Schema Part 1: Structures", W3C Recommendation, May 2001,
[XMLSCHEMA2] Biron, P.V., Ed. and Malhotra, A., Ed., "XML Schema Part 2: Datatypes", W3C Recommendation, May 2001,
1.2.2Informative References
[MS-NLMP] Microsoft Corporation, "NT LAN Manager (NTLM) Authentication Protocol".
[RFC4559] Jaganathan, K., Zhu, L., and Brezak, J., "SPNEGO-based Kerberos and NTLM HTTP Authentication in Microsoft Windows", RFC 4559, June 2006,
1.3Overview
This protocol is used to expand distribution lists or to search for users and distribution lists and query attributes associated with each one. Using this protocol, a user can provide the address of a distribution list and obtain information about its membership. The user can also provide a search string, a set of attributes to search against, and a set of attributes to return for each match. The search can return one or more users or distribution lists or both and get attributes about each one found. The protocol can also be used for searching users in the Skype public directory, and provide feedback on the corresponding search results.
The protocol consists of one request and one response. The request contains either a distribution list expansion request, a search request, or search feedback data. The request contains the information needed to describe the request. The response contains the response status and, if the response is successful, the data requested.
This protocol is conceptually three Web services methods. This documentation specifies the structure of the schema used to construct the body in the request and response messages. The protocol uses Simple Object Access Protocol (SOAP) and Web Services Description Language (WSDL) to describe the structure of the message body. The full WSDL is included in section 6.
1.4Relationship to Other Protocols
This protocol uses SOAP over Hypertext Transfer Protocol over Secure Sockets Layer (HTTPS), as described in [RFC2818], as shown in the following layering diagram:
Figure 1: This protocol in relation to other protocols
1.5Prerequisites/Preconditions
For a client that uses this protocol with a server, it is assumed that the server has an operational SOAP1.2/HTTP1.1/TCP/IP stack, as described in [RFC2616]. It is also assumed that the client has the fully qualified domain name (FQDN) of the server to which the client will connect. The client can obtain the FQDN of the server via a different channel, for example, in the Session Initiation Protocol (SIP) signaling channel, as described in [RFC3261]. The server also requires that the client be able to negotiate Hypertext Transfer Protocol (HTTP) over Transport Layer Security (TLS) to establish the connection.