doc/maintanance_web_services

   1 Maintanance web services specification
   2 ======================================
   3
   4 Source: Provozní řád ISDS, version 2010-01-22, Pages 14–15
   5 Source: Webové služby rozhraní ISDS pro správu datových schránek,
   6     version 2.6 (2009-11-18)
   7 Source: Webové služby související s přístupem do ISDS, version 1.0
   8     (2010-01-18)
   9
  10
  11 These services are intended for administration of box as such. NONE of the
  12 services MARK incoming messages as delivered.
  13
  14 SOAP web services defined in: db_manipulations.wsdl (Appendix 3),
  15 db_access.wsdl (Appendix 2)
  16
  17 Data types: dbTypes.xsd (Appendix 3)
  18
  19 Documentation: DataBox_ws.pdf (Appendix 3), GetInfo_ws.pdf (Appendix 2)
  20
  21 Note: OVM mode is defined in paragraph 5a of Czech ISDS Act (300/2008 Coll.)
  22
  23 List of SOAP requests follows.
  24
  25
  26 db_manipulations.wsdl
  27 =====================
  28
  29 URL postfix: DsManage
  30
  31 CreateDataBox
  32     Create box
  33 CreateDataBoxPFOInfo
  34     Report PFO/FO insert into registry
  35 DeleteDataBox
  36     Remove box permanently
  37 UpdateDataBoxDescr
  38     Change data about box owner
  39 AddDataBoxUser
  40     Add person permitted to access to the box
  41 DeleteDataBoxUser
  42     Remove person permitted to access to the box
  43 UpdateDataBoxUser
  44     Change data about permitted person
  45 NewAccessData
  46     Reset user credentials (remove old ones and generates new ones)
  47 DisableDataBoxExternally
  48     Make box unaccessible because owner lost ability to use the box for legal
  49     reasons (prisoned person, person with no or weak legal rights)
  50 DisableOwnDataBox
  51     Make box unaccessable on request of its owner
  52 EnableOwnDataBox
  53     Renew access to the box
  54 SetEffectiveOVM
  55     Switch box into OVM mode
  56 CleareEffectiveOVM
  57     Set box off OVM mode
  58 SetOpenAddressing
  59     Switch box into commercial message acceptance mode
  60 ClearOpenAddressing
  61     Set box off commercial message acceptance mode
  62 GetDataBoxUsers
  63     Get list of users permitted to access the box.
  64
  65
  66 db_access.wsdl
  67 ==============
  68
  69 URL postfix: DsManage
  70
  71 GetOwnerInfoFromLogin
  72     Get data about box of logged in user.
  73 GetUserInfoFromLogin
  74     Get data about logged in user
  75 GetPasswordInfo
  76     Get data about password expiration
  77 ChangeISDSPassword
  78     Change password
  79
  80
  81 GetDataBoxUsers
  82 ===============
  83
  84 Get list of users permitted to access given box.
  85
  86 Note: This request is not specified in any verbose document. Following info
  87 has been obtained from XML Schma file [dbTypes.xsd].
  88
  89 Input is type of XSD:tIdDbInput. Only box ID is sufficient probably.
  90
  91 Output is list of box users. Structure:
  92
  93 EnableOwnDataBoxResponse
  94     + dbUsers – optional
  95     |   + dbUserInfo – at least one must present. Type of XSD:tDbUserInfo. See
  96         |           GetUserInfoFromLogin request for more details.
  97     |   + dbUserInfo
  98     |   ⋮
  99     + dbStatus
 100
 101
 102 GetOwnerInfoFromLogin
 103 =====================
 104
 105 Get details about current box that user is logged in.
 106
 107 Input is empty dummy request.
 108
 109 Result is returned in tDbOwnerInfo structure. Some structrure memebers are
 110 undefined or unknown for particular box type.
 111
 112
 113 GetUserInfoFromLogin
 114 ====================
 115
 116 Get details about currently logged in user.
 117
 118 Input is empty dummy request.
 119
 120 Output is returned in tDbUserInfo. Some members can be irrelevant (and thus
 121 undefined) for particular user. Service can fail if user has logged into box
 122 with system certificate.
 123
 124
 125 GetPasswordInfo
 126 ===============
 127
 128 Inquire expiration time of current user password.
 129
 130 By default password expires in 90 days. ISDS can force password change sooner.
 131
 132 Non-normative: If user does not change password after expiration, SOAP server
 133 will return non-SOAP response and client could not continue in work.
 134
 135 Input is empty dummy request.
 136
 137 Output is ISO time of password expiration. Service has no sense if client
 138 autenticates with certifacate only.
 139
 140
 141 ChangeISDSPassword
 142 ==================
 143
 144 Change user password.
 145
 146 Input is current password and new password. Supplied new password must match
 147 password stored in ISDS, otherwise system refuse password update.
 148
 149 Password must meet formal syntax rules assuring strong complexity:
 150
 151     – 8 ≤ length ≤ 32 characters
 152
 153     – Must contains:
 154
 155         * at least 1 upper case letter
 156
 157         * at least 1 lower case letter
 158
 159         * at least 1 digit
 160
 161     – Allowed alphabet is [a-z], [A-Z], [0-9], and "!#$%&()*+,-.:=?@[]_{}|~"
 162     (delimited with double quotations).
 163
 164     – Must differ from last 255 passwords
 165
 166     – Must not equal to user ID, user's last name and phone number
 167
 168 Service is meaningful only when user logs in with password.
 169
 170 After successfull password update, client continue in current sessesion.
 171 Password change takes effect after propagation into whole ISDS cluster (about
 172 15 seconds).
 173
 174 Error codes:
 175     0000    Password chaned successfully
 176     1066    Empty password
 177     1067    New password same as current one
 178     9204    Generic error