share/OCISchemaAS/Services/OCISchemaServiceAuthentication.xsd

   1 <?xml version="1.0" encoding="UTF-8"?>\r
   2 \r
   3 <!-- ********************************************************************** -->\r
   4 <!-- Copyright (c) 2000-2012 BroadSoft, Inc.  All rights reserved.          -->\r
   5 <!-- ********************************************************************** -->\r
   6 <!-- O C I   X M L   S C H E M A  :  S E R V I C E  P A R T                 -->\r
   7 <!--                                                                        -->\r
   8 <!-- A U T H E N T I C A T I O N  S E R V I C E                             -->\r
   9 <!--                                                                        -->\r
  10 <!-- This file defines the XML Schema for the BroadSoft Application Server  -->\r
  11 <!-- Open Client Interface (OCI).                                           -->\r
  12 <!-- ********************************************************************** -->\r
  13 \r
  14 <xs:schema xmlns:xs             = "http://www.w3.org/2001/XMLSchema"\r
  15            xmlns:core           = "C"\r
  16            xmlns                = ""\r
  17            attributeFormDefault = "qualified"\r
  18            elementFormDefault   = "qualified">\r
  19   \r
  20   <xs:import namespace      = "C"\r
  21              schemaLocation = "../OCISchemaBASE.xsd"/>\r
  22   \r
  23   <xs:include schemaLocation="../OCISchemaDataTypes.xsd"/>\r
  24   \r
  25   <!-- ********************************************************************************** -->\r
  26   <!-- A U T H E N T I C A T I O N    R E Q U E S T S  A N D  R E S P O N S E S           -->\r
  27   <!-- ********************************************************************************** -->\r
  28   <!--\r
  29   Requests and responses are listed here in alphabetical order.\r
  30   The non-primitive attributes inside the commands are defined in another\r
  31   section of the schema.\r
  32 \r
  33   Requests in this schema file:\r
  34     UserAuthenticationGetRequest    \r
  35     UserAuthenticationModifyRequest    \r
  36     \r
  37   --> \r
  38   \r
  39   <xs:complexType name="UserAuthenticationGetRequest">\r
  40     <xs:annotation>\r
  41       <xs:documentation>\r
  42         Get the user's authentication service information.\r
  43         The response is either a UserAuthenticationGetResponse or an ErrorResponse.\r
  44       </xs:documentation>\r
  45     </xs:annotation>\r
  46     <xs:complexContent>\r
  47       <xs:extension base="core:OCIRequest">\r
  48         <xs:sequence>\r
  49           <xs:element name="userId" type="UserId"/>\r
  50         </xs:sequence>\r
  51       </xs:extension>\r
  52     </xs:complexContent>\r
  53   </xs:complexType>    \r
  54     \r
  55   <xs:complexType name="UserAuthenticationGetResponse">\r
  56     <xs:annotation>\r
  57       <xs:documentation>\r
  58         Response to the UserAuthenticationGetRequest.\r
  59       </xs:documentation>\r
  60     </xs:annotation>\r
  61     <xs:complexContent>\r
  62       <xs:extension base="core:OCIDataResponse">\r
  63         <xs:sequence>\r
  64           <xs:element name="userName" type="SIPAuthenticationUserName" minOccurs="0"/>\r
  65         </xs:sequence>\r
  66       </xs:extension>\r
  67     </xs:complexContent>\r
  68   </xs:complexType>    \r
  69     \r
  70   <xs:complexType name="UserAuthenticationModifyRequest">\r
  71     <xs:annotation>\r
  72       <xs:documentation>\r
  73         Modify the user's authentication service information.\r
  74         The response is either a SuccessResponse or an ErrorResponse.\r
  75       </xs:documentation>\r
  76     </xs:annotation>\r
  77     <xs:complexContent>\r
  78       <xs:extension base="core:OCIRequest">\r
  79         <xs:sequence>\r
  80           <xs:element name="userId" type="UserId"/>\r
  81           <xs:element name="userName" type="SIPAuthenticationUserName" minOccurs="0"/>\r
  82           <xs:choice>\r
  83             <xs:element name="newPassword" type="Password" minOccurs="0"/>\r
  84             <xs:element name="password" minOccurs="0">\r
  85               <xs:complexType>\r
  86                 <xs:annotation/>\r
  87                 <xs:sequence>\r
  88                   <xs:element name="old" type="Password"/>\r
  89                   <xs:element name="new" type="Password"/>\r
  90                 </xs:sequence>\r
  91               </xs:complexType>\r
  92             </xs:element>\r
  93           </xs:choice>\r
  94         </xs:sequence>\r
  95       </xs:extension>\r
  96     </xs:complexContent>\r
  97   </xs:complexType>    \r
  98     \r
  99 </xs:schema>\r