[MS-OXWSADISC]:
Autodiscover Publishing and Lookup SOAP-Based Web Service Protocol
Intellectual Property Rights Notice for Open Specifications Documentation
Technical Documentation. Microsoft publishes Open Specifications documentation for protocols, file formats, languages, standards as well as overviews of the interaction among each of these technologies.
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 may make copies of it in order to develop implementations of the technologies described in the Open Specifications and may distribute portions of it in your implementations using these technologies or your documentation as necessary to properly document the implementation. You may also distribute in your implementation, with or without modification, any schema, IDL's, or code samples that are included in the documentation. This permission also applies to any documents that are referenced in the Open Specifications.
No Trade Secrets. Microsoft does not claim any trade secret rights in this documentation.
Patents. Microsoft has patents that may cover your implementations of the technologies described in the Open Specifications. Neither this notice nor Microsoft's delivery of the documentation grants any licenses under those or any other Microsoft patents. However, a given Open Specification may be covered by Microsoft Open Specification Promiseor the Community Promise. If you would prefer a written license, or if the technologies described in the Open Specifications are not covered by the Open Specifications Promise or Community Promise, as applicable, patent licenses are available by contacting .
Trademarks. The names of companies and products contained in this documentation may 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, e-mail addresses, logos, people, places, and events 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 specifically described above, whether by implication, estoppel, or otherwise.
Tools. The Open Specifications do 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 are intended for use in conjunction with publicly available standard specifications and network programming art, and assumes that the reader either is familiar with the aforementioned material or has immediate access to it.
Preliminary Documentation. This Open Specification provides documentation for past and current releases and/or for the pre-release version of this technology. This Open Specification is final documentation for past or current releases as specifically noted in the document, as applicable; it is preliminary documentation for the pre-release versions. Microsoft will release final documentation in connection with the commercial release of the updated or new version of this technology. As the documentation may change between this preliminary version and the final version of this technology, there are risks in relying on preliminary documentation. To the extent that you incur additional development obligations or any other costs as a result of relying on this preliminary documentation, you do so at your own risk.
Revision Summary
Date / Revision History / Revision Class / Comments7/15/2009 / 1.0 / Major / Initial Availability.
11/4/2009 / 2.0.0 / Major / Updated and revised the technical content.
2/10/2010 / 3.0.0 / Major / Updated and revised the technical content.
5/5/2010 / 4.0.0 / Major / Updated and revised the technical content.
8/4/2010 / 5.0 / Major / Significantly changed the technical content.
11/3/2010 / 6.0 / Major / Significantly changed the technical content.
3/18/2011 / 7.0 / Major / Significantly changed the technical content.
8/5/2011 / 7.1 / Minor / Clarified the meaning of the technical content.
10/7/2011 / 8.0 / Major / Significantly changed the technical content.
1/20/2012 / 9.0 / Major / Significantly changed the technical content.
4/27/2012 / 9.0 / No Change / No changes to the meaning, language, or formatting of the technical content.
7/16/2012 / 10.0 / Major / Significantly changed the technical content.
10/8/2012 / 11.0 / Major / Significantly changed the technical content.
2/11/2013 / 12.0 / Major / Significantly changed the technical content.
7/26/2013 / 13.0 / Major / Significantly changed the technical content.
11/18/2013 / 13.0 / No Change / No changes to the meaning, language, or formatting of the technical content.
2/10/2014 / 13.0 / No Change / No changes to the meaning, language, or formatting of the technical content.
4/30/2014 / 14.0 / Major / Significantly changed the technical content.
7/31/2014 / 14.1 / Minor / Clarified the meaning of the technical content.
10/30/2014 / 14.2 / Minor / Clarified the meaning of the technical content.
5/26/2015 / 15.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.3.1ServerVersionInfo Element
2.2.3.2Domains Element
2.2.3.3tns:RequestedSettings Element
2.2.4Complex Types
2.2.4.1tns:ServerVersionInfo Complex Type
2.2.4.2tns:Domains Complex Type
2.2.4.3tns:RequestedSettings Complex Type
2.2.5Simple Types
2.2.6Attributes
2.2.7Groups
2.2.8Attribute Groups
3Protocol Details
3.1Autodiscover Server Details
3.1.1Abstract Data Model
3.1.2Timers
3.1.3Initialization
3.1.4Message Processing Events and Sequencing Rules
3.1.4.1GetDomainSettings
3.1.4.1.1Messages
3.1.4.1.1.1tns:GetDomainSettingsRequestMessage
3.1.4.1.1.2tns:GetDomainSettingsRequestMessage_Headers
3.1.4.1.1.3tns:GetDomainSettingsResponseMessage
3.1.4.1.1.4tns:GetDomainSettingsResponseMessage_Headers
3.1.4.1.2Elements
3.1.4.1.2.1tns:GetDomainSettingsRequestMessage Element
3.1.4.1.2.2tns:GetDomainSettingsResponseMessage Element
3.1.4.1.2.3tns:GetDomainSettingsRequest Element
3.1.4.1.2.4tns:GetDomainSettingsResponse Element
3.1.4.1.2.5tns:ArrayOfDomainResponse Element
3.1.4.1.2.6tns:DomainResponse Element
3.1.4.1.2.7tns:DomainSettingErrors Element
3.1.4.1.2.8tns:DomainSettingError Element
3.1.4.1.2.9tns:DomainSettings Element
3.1.4.1.2.10tns:DomainSetting Element
3.1.4.1.3Complex Types
3.1.4.1.3.1tns:GetDomainSettingsRequest Complex Type
3.1.4.1.3.2tns:GetDomainSettingsResponse Complex Type
3.1.4.1.3.3tns:ArrayOfDomainResponse Complex Type
3.1.4.1.3.4tns:DomainResponse Complex Type
3.1.4.1.3.5tns:DomainSettingErrors Complex Type
3.1.4.1.3.6tns:DomainSettingError Complex Type
3.1.4.1.3.7tns:DomainSettings Complex Type
3.1.4.1.3.8tns:DomainSetting Complex Type
3.1.4.1.3.9tns:DomainStringSetting Complex Type
3.1.4.1.4Simple Types
3.1.4.1.5Attributes
3.1.4.1.6Groups
3.1.4.1.7Attribute Groups
3.1.4.2GetFederationInformation
3.1.4.2.1Messages
3.1.4.2.1.1tns:GetFederationInformationRequestMessage
3.1.4.2.1.2tns:GetFederationInformationRequestMessage_Headers
3.1.4.2.1.3tns:GetFederationInformationResponseMessage
3.1.4.2.1.4tns:GetFederationInformationResponseMessage_Headers
3.1.4.2.2Elements
3.1.4.2.2.1tns:GetFederationInformationRequestMessage Element
3.1.4.2.2.2tns:GetFederationInformationResponseMessage Element
3.1.4.2.2.3tns:GetFederationInformationRequest Element
3.1.4.2.2.4tns:GetFederationInformationResponse Element
3.1.4.2.3Complex Types
3.1.4.2.3.1tns:GetFederationInformationRequest Complex Type
3.1.4.2.3.2tns:GetFederationInformationResponse Complex Type
3.1.4.2.3.3tns:TokenIssuer Complex Type
3.1.4.2.3.4tns:TokenIssuers Complex Type
3.1.4.2.4Simple Types
3.1.4.2.5Attributes
3.1.4.2.6Groups
3.1.4.2.7Attribute Groups
3.1.4.3GetOrganizationRelationshipSettings
3.1.4.3.1Messages
3.1.4.3.1.1tns:GetOrganizationRelationshipSettingsRequestMessage
3.1.4.3.1.2tns:GetOrganizationRelationshipSettingsRequestMessage_Headers
3.1.4.3.1.3tns:GetOrganizationRelationshipSettingsResponseMessage
3.1.4.3.1.4tns:GetOrganizationRelationshipSettingsResponseMessage_Headers
3.1.4.3.2Elements
3.1.4.3.2.1tns:GetOrganizationRelationshipSettingsRequestMessage Element
3.1.4.3.2.2tns:GetOrganizationRelationshipSettingsRequest Element
3.1.4.3.2.3tns:GetOrganizationRelationshipSettingsResponseMessage Element
3.1.4.3.2.4tns:GetOrganizationRelationshipSettingsResponse Element
3.1.4.3.2.5tns:OrganizationRelationshipSettingsCollection Element
3.1.4.3.2.6tns:OrganizationRelationshipSettings Element
3.1.4.3.3Complex Types
3.1.4.3.3.1tns:GetOrganizationRelationshipSettingsRequest Complex Type
3.1.4.3.3.2tns:GetOrganizationRelationshipSettingsResponse Complex Type
3.1.4.3.3.3tns:OrganizationRelationshipSettingsCollection Complex Type
3.1.4.3.3.4tns:OrganizationRelationshipSettings Complex Type
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.4GetUserSettings
3.1.4.4.1Messages
3.1.4.4.1.1tns:GetUserSettingsRequestMessage
3.1.4.4.1.2tns:GetUserSettingsRequestMessage_Headers
3.1.4.4.1.3tns:GetUserSettingsResponseMessage
3.1.4.4.1.4tns:GetUserSettingsResponseMessage_Headers
3.1.4.4.2Elements
3.1.4.4.2.1tns:GetUserSettingsRequestMessage Element
3.1.4.4.2.2tns:GetUserSettingsResponseMessage Element
3.1.4.4.2.3tns:GetUserSettingsRequest Element
3.1.4.4.2.4tns:GetUserSettingsResponse Element
3.1.4.4.2.5tns:AutodiscoverRequest Element
3.1.4.4.2.6tns:Users Element
3.1.4.4.2.7tns:User Element
3.1.4.4.2.8tns:RequestedServerVersion Element
3.1.4.4.2.9tns:AutodiscoverResponse Element
3.1.4.4.2.10tns:ErrorCode Element
3.1.4.4.2.11tns:ArrayOfUserResponse Element
3.1.4.4.2.12tns:UserResponse Element
3.1.4.4.2.13tns:UserSettingErrors Element
3.1.4.4.2.14tns:UserSettingError Element
3.1.4.4.2.15tns:UserSettings Element
3.1.4.4.2.16tns:UserSetting Element
3.1.4.4.2.17tns:WebClientUrls Element
3.1.4.4.2.18tns:WebClientUrl Element
3.1.4.4.2.19tns:ProtocolConnections Element
3.1.4.4.2.20tns:ProtocolConnection Element
3.1.4.4.2.21tns:AlternateMailboxes Element
3.1.4.4.2.22tns:AlternateMailbox Element
3.1.4.4.2.23tns:ArrayOfFileExtension Element
3.1.4.4.2.24tns:DocumentSharingLocation Element
3.1.4.4.2.25tns:DocumentSharingLocationCollectionSetting Element
3.1.4.4.2.26tns:DocumentSharingLocations Element
3.1.4.4.3Complex Types
3.1.4.4.3.1tns:GetUserSettingsRequest Complex Type
3.1.4.4.3.2tns:AutodiscoverRequest Complex Type
3.1.4.4.3.3tns:Users Complex Type
3.1.4.4.3.4tns:User Complex Type
3.1.4.4.3.5tns:GetUserSettingsResponse Complex Type
3.1.4.4.3.6tns:AutodiscoverResponse Complex Type
3.1.4.4.3.7tns:UserResponse Complex Type
3.1.4.4.3.8tns:UserSettingErrors Complex Type
3.1.4.4.3.9tns:ArrayOfUserResponse Complex Type
3.1.4.4.3.10tns:UserSettingError Complex Type
3.1.4.4.3.11tns:UserSettings Complex Type
3.1.4.4.3.12tns:UserSetting Complex Type
3.1.4.4.3.13tns:StringSetting Complex Type
3.1.4.4.3.14tns:WebClientUrlCollectionSetting Complex Type
3.1.4.4.3.15tns:WebClientUrls Complex Type
3.1.4.4.3.16tns:WebClientUrl Complex Type
3.1.4.4.3.17tns:ProtocolConnectionCollectionSetting Complex Type
3.1.4.4.3.18tns:ProtocolConnections Complex Type
3.1.4.4.3.19tns:ProtocolConnection Complex Type
3.1.4.4.3.20tns:AlternateMailboxCollectionSetting Complex Type
3.1.4.4.3.21tns:AlternateMailboxes Complex Type
3.1.4.4.3.22tns:AlternateMailbox Complex Type
3.1.4.4.3.23tns:ArrayOfFileExtension Complex Type
3.1.4.4.3.24tns:DocumentSharingLocation Complex Type
3.1.4.4.3.25tns:DocumentSharingLocationCollectionSetting Complex Type
3.1.4.4.3.26tns:DocumentSharingLocations Complex Type
3.1.4.4.4Simple Types
3.1.4.4.4.1tns:ExchangeVersion Simple Type
3.1.4.4.4.2tns:ErrorCode Simple Type
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.1GetDomainSettings Operation
4.2GetFederationInformation Operation
4.3GetUserSettings Operation
5Security
5.1Security Considerations for Implementers
5.2Index of Security Parameters
6Appendix A: Full WSDL
7Appendix B: Full XML Schema
8Appendix C: Product Behavior
9Change Tracking
10Index
1Introduction
The Autodiscover Publishing and Lookup SOAP-Based Web Service Protocol is used to send request-response messages for retrieving user settings configuration information. Clients use this protocol and the Autodiscover service (autodiscovery) to obtain specific configuration settings by passing in their email addresses as simple strings.
The Autodiscover service can then be used to discover and configure internal and external URLs for the server's web services during profile setup and later sessions with the computer that has the Client Access server role installed.
Sections 1.8, 2, and 3 of this specification are normative and can contain the terms MAY, SHOULD, MUST, MUST NOT, and SHOULD NOT as defined in [RFC2119]. Sections 1.5 and 1.9 are also normative but do not contain those terms. All other sections and examples in this specification are informative.
1.1Glossary
The following terms are specific to this document:
address book: A collection of Address Book objects, each of which are contained in any number of address lists.
Autodiscover client: A client that queries for a set of server locations where setup and configuration information for an [RFC2821]-compliant email address is stored.
Autodiscover server: A server in a managed environment that makes setup and configuration information available to Autodiscover clients. The location of Autodiscover servers is made available via the Autodiscover HTTP Service Protocol, as described in [MS-OXDISCO].
delivery receipt: A report message that is generated and sent by a client or server to the sender of a message or another designated recipient when an email message is received by an intended recipient.
display name: A text string that is used to identify a principal or other object in the user interface. Also referred to as title.
distinguished name (DN): In the Active Directory directory service, the unique identifier of an object in Active Directory, as described in [MS-ADTS] and [RFC2251].
email address: A string that identifies a user and enables the user to receive Internet messages.
endpoint: (1) A network-specific address of a remote procedure call (RPC) server process for remote procedure calls. The actual name and type of the endpoint depends on the RPC protocol sequence that is being used. For example, for RPC over TCP (RPC Protocol Sequence ncacn_ip_tcp), an endpoint might be TCP port 1025. For RPC over Server Message Block (RPC Protocol Sequence ncacn_np), an endpoint might be the name of a named pipe. For more information, see [C706].
(2) A communication port that is exposed by an application server for a specific shared service and to which messages can be addressed.
free/busy status: A property of an appointment that indicates how an appointment on the calendar of an attendee or resource affects their availability.
fully qualified domain name (FQDN): An unambiguous domain name (2) 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 over Secure Sockets Layer (HTTPS): An extension of HTTP that securely encrypts and decrypts webpage requests.
Internet Message Access Protocol - Version 4 (IMAP4): A protocol that is used for accessing email and news items from mail servers, as described in [RFC3501].
mail tip: A note that is presented to the author of a message when the author is composing the message. A mail tip provides information about the recipients of a message and issues that might impact delivery of the message, such as moderation or delivery restrictions.
mailbox: A message store that contains email, calendar items, and other Message objects for a single recipient.
offline address book (OAB): A collection of address lists that are stored in a format that a client can save and use locally.
Post Office Protocol - Version 3 (POP3): A protocol that is used for accessing email from mail servers, as described in [RFC1939].
public folder: A Folder object that is stored in a location that is publicly available.
remote procedure call (RPC): A context-dependent term commonly overloaded with three meanings. Note that much of the industry literature concerning RPC technologies uses this term interchangeably for any of the three meanings. Following are the three definitions: (*) The runtime environment providing remote procedure call facilities. The preferred usage for this meaning is "RPC runtime". (*) The pattern of request and response message exchange between two parties (typically, a client and a server). The preferred usage for this meaning is "RPC exchange". (*) A single message from an exchange as defined in the previous definition. The preferred usage for this term is "RPC message". For more information about RPC, see [C706].
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 (2) using X.509 certificates (2). 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.
security token: An opaque message or data packet produced by a Generic Security Services (GSS)-style authentication package and carried by the application protocol. The application has no visibility into the contents of the token.
security token service (STS): A web service that issues claims (2) and packages them in encrypted security tokens.
Simple Mail Transfer Protocol (SMTP): A member of the TCP/IP suite of protocols that is used to transport Internet messages, as described in [RFC5321].
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 action: The HTTP request header field used to indicate the intent of the SOAP request, using a URI value. See [SOAP1.1] section 6.1.1 for more information.
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 header: A mechanism for implementing extensions to a SOAP message in a decentralized manner without prior agreement between the communicating parties. See [SOAP1.2-1/2007] section 5.2 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.
Unified Messaging: A set of components and services that enable voice, fax, and email messages to be stored in a user's mailbox and accessed from a variety of devices.
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 server: A server computer that hosts websites and responds to requests from applications.
web service: A unit of application logic that provides data and services to other applications and can be called by using standard Internet transport protocols such as HTTP, Simple Mail Transfer Protocol (SMTP), or File Transfer Protocol (FTP). Web services can perform functions that range from simple requests to complicated business processes.
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.
WSDL message: An abstract, typed definition of the data that is communicated during a WSDL operation[WSDL]. Also, an element that describes the data being exchanged between web service providers and clients.
WSDL operation: A single action or function of a web service. The execution of a WSDL operation typically requires the exchange of messages between the service requestor and the service provider.
WSDL port type: A named set of logically-related, abstract Web Services Description Language (WSDL) operations and messages.
XML: The Extensible Markup Language, as described in [XML1.0].
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].
XML schema: A description of a type of XML document that is typically expressed in terms of constraints on the structure and content of documents of that type, in addition to the basic syntax constraints that are imposed by XML itself. An XML schema provides a view of a document type at a relatively high level of abstraction.
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.