| ... |
... |
@@ -1,0 +1,270 @@ |
|
1 |
+{{aagon.floatingbox/}} |
|
2 |
+ |
|
3 |
+= Login ACMP user (PasswordHash) = |
|
4 |
+ |
|
5 |
+{{apimacro title="LoginAcmpUser Request"}} |
|
6 |
+<ICQL> |
|
7 |
+ <ACMP> |
|
8 |
+ <LoginAcmpUser ActionType="Request" version="1"> |
|
9 |
+ <TLoginAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
10 |
+ <Username>Username</Username> |
|
11 |
+ <PasswordHash>PasswordHash</PasswordHash> |
|
12 |
+ <SessionId>SessionId</SessionId> |
|
13 |
+ <CreateToken>false</CreateToken> <!-- ab 5.4.6 --> |
|
14 |
+ </TLoginAcmpUserRequest_V1> |
|
15 |
+ </LoginAcmpUser> |
|
16 |
+ </ACMP> |
|
17 |
+</ICQL> |
|
18 |
+{{/apimacro}} |
|
19 |
+ |
|
20 |
+{{apimacro title="LoginAcmpUser Request"}} |
|
21 |
+<ICQL> |
|
22 |
+ <ACMP> |
|
23 |
+ <LoginAcmpUser ActionType="Response" version="1"> |
|
24 |
+ <TLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
25 |
+ <!-- Possible values: |
|
26 |
+ - Successful |
|
27 |
+ - IncorrectCredentials |
|
28 |
+ - Undefined |
|
29 |
+ --> |
|
30 |
+ <LoginResult>LoginResult</LoginResult> |
|
31 |
+ <Token>Token_Als_Hexadezimal</Token> <!-- ab 5.4.6 --> |
|
32 |
+ <ResultCode>0</ResultCode> |
|
33 |
+ </TLoginAcmpUserResponse_V1> |
|
34 |
+ </LoginAcmpUser> |
|
35 |
+ </ACMP> |
|
36 |
+</ICQL> |
|
37 |
+{{/apimacro}} |
|
38 |
+ |
|
39 |
+= Login ACMP User (Token) = |
|
40 |
+ |
|
41 |
+{{apimacro title="LoginAcmpUser Request"}} |
|
42 |
+<ICQL> |
|
43 |
+ <ACMP> |
|
44 |
+ <TokenLoginAcmpUser version="1"> |
|
45 |
+ <TTokenLoginAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
46 |
+ <UserName>UserName</UserName> |
|
47 |
+ <Token>Token_Als_Hexadezimal</Token> |
|
48 |
+ <SessionId>SessionId</SessionId> |
|
49 |
+ </TTokenLoginAcmpUserRequest_V1> |
|
50 |
+ </TokenLoginAcmpUser> |
|
51 |
+ </ACMP> |
|
52 |
+</ICQL> |
|
53 |
+{{/apimacro}} |
|
54 |
+ |
|
55 |
+{{apimacro title="LoginAcmpUser Request"}} |
|
56 |
+<ICQL> |
|
57 |
+ <ACMP> |
|
58 |
+ <TokenLoginAcmpUser ActionType="Response" version="1"> |
|
59 |
+ <TTokenLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
60 |
+ <!-- Possible values: |
|
61 |
+ - Successful |
|
62 |
+ - IncorrectCredentials |
|
63 |
+ - Undefined |
|
64 |
+ --> |
|
65 |
+ <LoginResult>LoginResult</LoginResult> |
|
66 |
+ <ResultCode>0</ResultCode> |
|
67 |
+ </TTokenLoginAcmpUserResponse_V1> |
|
68 |
+ </TokenLoginAcmpUser> |
|
69 |
+ </ACMP> |
|
70 |
+</ICQL> |
|
71 |
+{{/apimacro}} |
|
72 |
+ |
|
73 |
+= Login Domain User (PasswordHash) = |
|
74 |
+ |
|
75 |
+{{apimacro title="LoginDomainUser Request"}} |
|
76 |
+<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/LoginDomainUserRequest_V1"> |
|
77 |
+ <ACMP> |
|
78 |
+ <LoginDomainUser ActionType="Request" version="1"> |
|
79 |
+ <TLoginDomainUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
80 |
+ <Username>Username</Username> |
|
81 |
+ <Domain>Domain</Domain> |
|
82 |
+ <Password>Password</Password> |
|
83 |
+ <SessionId>{59387FFD-B171-47C5-B735-041FA132CA39}</SessionId> |
|
84 |
+ <CreateToken>false</CreateToken> |
|
85 |
+ </TLoginDomainUserRequest_V1> |
|
86 |
+ </LoginDomainUser> |
|
87 |
+ </ACMP> |
|
88 |
+</ICQL> |
|
89 |
+{{/apimacro}} |
|
90 |
+ |
|
91 |
+{{apimacro title="LoginDomainUser Response"}} |
|
92 |
+<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/LoginDomainUserResponse_V1"> |
|
93 |
+ <ACMP> |
|
94 |
+ <LoginDomainUser ActionType="Response" version="1"> |
|
95 |
+ <TLoginDomainUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
96 |
+ <!-- Possible values: |
|
97 |
+ - Successful |
|
98 |
+ - IncorrectCredentials |
|
99 |
+ - Undefined |
|
100 |
+ --> |
|
101 |
+ <LoginResult>LoginResult</LoginResult> |
|
102 |
+ <Token>Token_Als_Hexadezimal</Token> |
|
103 |
+ <ResultCode>0</ResultCode> |
|
104 |
+ <ResultMessage>ResultMessage</ResultMessage> |
|
105 |
+ </TLoginDomainUserResponse_V1> |
|
106 |
+ </LoginDomainUser> |
|
107 |
+ </ACMP> |
|
108 |
+</ICQL> |
|
109 |
+{{/apimacro}} |
|
110 |
+ |
|
111 |
+= Login Domain User (Token) = |
|
112 |
+ |
|
113 |
+{{apimacro title="TokenLoginDomainUser Request"}} |
|
114 |
+<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/TokenLoginDomainUserRequest_V1"> |
|
115 |
+ <ACMP> |
|
116 |
+ <TokenLoginDomainUser ActionType="Request" version="1"> |
|
117 |
+ <TTokenLoginDomainUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
118 |
+ <UserName>UserName</UserName> |
|
119 |
+ <Domain>Domain</Domain> |
|
120 |
+ <Token>Token_Als_Hexadezimal</Token> |
|
121 |
+ <SessionId>{59387FFD-B171-47C5-B735-041FA132CA39}</SessionId> |
|
122 |
+ </TTokenLoginDomainUserRequest_V1> |
|
123 |
+ </TokenLoginDomainUser> |
|
124 |
+ </ACMP> |
|
125 |
+</ICQL> |
|
126 |
+{{/apimacro}} |
|
127 |
+ |
|
128 |
+{{apimacro title="TokenLoginDomainUser Response"}} |
|
129 |
+<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/TokenLoginAcmpUserResponse_V1"> |
|
130 |
+ <ACMP> |
|
131 |
+ <TokenLoginAcmpUser ActionType="Response" version="1"> |
|
132 |
+ <TTokenLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
133 |
+ <!-- Possible values: |
|
134 |
+ - Successful |
|
135 |
+ - IncorrectCredentials |
|
136 |
+ - Undefined |
|
137 |
+ --> |
|
138 |
+ <LoginResult>LoginResult</LoginResult> |
|
139 |
+ <ResultCode>0</ResultCode> |
|
140 |
+ <ResultMessage>ResultMessage</ResultMessage> |
|
141 |
+ </TTokenLoginAcmpUserResponse_V1> |
|
142 |
+ </TokenLoginAcmpUser> |
|
143 |
+ </ACMP> |
|
144 |
+</ICQL> |
|
145 |
+{{/apimacro}} |
|
146 |
+ |
|
147 |
+= Logout ACMP user = |
|
148 |
+ |
|
149 |
+{{apimacro title="LogoutAcmpUser Request"}} |
|
150 |
+<ICQL> |
|
151 |
+ <ACMP> |
|
152 |
+ <LogoutAcmpUser version="1"> |
|
153 |
+ <TLogoutAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
154 |
+ <SessionId>SessionId</SessionId> |
|
155 |
+ </TLogoutAcmpUserRequest_V1> |
|
156 |
+ </LogoutAcmpUser> |
|
157 |
+ </ACMP> |
|
158 |
+</ICQL> |
|
159 |
+{{/apimacro}} |
|
160 |
+ |
|
161 |
+{{apimacro title="LogoutAcmpUser Response"}} |
|
162 |
+<ICQL> |
|
163 |
+ <ACMP> |
|
164 |
+ <LogoutAcmpUser version="1"> |
|
165 |
+ <TLogoutAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
166 |
+ <ResultCode>0</ResultCode> |
|
167 |
+ </TLogoutAcmpUserResponse_V1> |
|
168 |
+ </LogoutAcmpUser> |
|
169 |
+ </ACMP> |
|
170 |
+</ICQL> |
|
171 |
+{{/apimacro}} |
|
172 |
+ |
|
173 |
+= Get user salt = |
|
174 |
+ |
|
175 |
+{{apimacro title="GetUserSalt Request"}} |
|
176 |
+<ICQL> |
|
177 |
+ <ACMP> |
|
178 |
+ <GetUserSalt ActionType="Request" version="1"> |
|
179 |
+ <TGetUserSaltRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
180 |
+ <Username>Username</Username> |
|
181 |
+ </TGetUserSaltRequest_V1> |
|
182 |
+ </GetUserSalt> |
|
183 |
+ </ACMP> |
|
184 |
+</ICQL> |
|
185 |
+{{/apimacro}} |
|
186 |
+ |
|
187 |
+{{apimacro title="GetUserSalt Response"}} |
|
188 |
+<ICQL> |
|
189 |
+ <ACMP> |
|
190 |
+ <GetUserSalt ActionType="Response" version="1"> |
|
191 |
+ <TGetUserSaltResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
192 |
+ <!-- Salt as hex string for PBKDF2_HMAC_SHA256 password generation--> |
|
193 |
+ <Salt>Salt</Salt> |
|
194 |
+ <!-- Iteration count for PBKDF2_HMAC_SHA256 password generation--> |
|
195 |
+ <IterationCount>0</IterationCount> |
|
196 |
+ <PasswordVersion>0</PasswordVersion> <!-- ab 5.4.6 --> |
|
197 |
+ <ResultCode>0</ResultCode> |
|
198 |
+ </TGetUserSaltResponse_V1> |
|
199 |
+ </GetUserSalt> |
|
200 |
+ </ACMP> |
|
201 |
+</ICQL> |
|
202 |
+{{/apimacro}} |
|
203 |
+ |
|
204 |
+= Get own user rights = |
|
205 |
+ |
|
206 |
+Das GetOwnUserRights Command verwendet die beim Login aufgebaute Session ID um nur die eigenen Berechtigungen prüfen zu können. |
|
207 |
+ |
|
208 |
+Es werden nur Berechtigungen von ACMP Benutzern abgefragt, daher muss beim Login die Authentifizierungs-Methode "ACMP" benutzt werden. (Beim MessageStudio bei dem Login-Dialog auswählbar) |
|
209 |
+ |
|
210 |
+{{apimacro title="GetOwnUserRights_Request"}} |
|
211 |
+<ICQL> |
|
212 |
+ <ACMP> |
|
213 |
+ <GetOwnUserRights version="1"> |
|
214 |
+ <TGetOwnUserRightsRequest_V1/> |
|
215 |
+ </GetOwnUserRights> |
|
216 |
+ </ACMP> |
|
217 |
+</ICQL> |
|
218 |
+{{/apimacro}} |
|
219 |
+ |
|
220 |
+{{apimacro title="GetOwnUserRights_Response"}} |
|
221 |
+<ICQL> |
|
222 |
+ <ACMP> |
|
223 |
+ <GetOwnUserRights version="1"> |
|
224 |
+ <TGetOwnUserRightsResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
225 |
+ <AcmpRights> |
|
226 |
+ <string>Value 1</string> |
|
227 |
+ <string>Value 2</string> |
|
228 |
+ </AcmpRights> |
|
229 |
+ <VisibleActionIds> |
|
230 |
+ <string>Value 1</string> |
|
231 |
+ <string>Value 2</string> |
|
232 |
+ </VisibleActionIds> |
|
233 |
+ <ResultCode>0</ResultCode> |
|
234 |
+ </TGetOwnUserRightsResponse_V1> |
|
235 |
+ </GetOwnUserRights> |
|
236 |
+ </ACMP> |
|
237 |
+</ICQL> |
|
238 |
+{{/apimacro}} |
|
239 |
+ |
|
240 |
+= Remove token = |
|
241 |
+ |
|
242 |
+{{apimacro title="RemoveToken Request"}} |
|
243 |
+<ICQL> |
|
244 |
+ <ACMP> |
|
245 |
+ <RemoveToken ActionType="Request" version="1"> |
|
246 |
+ <TRemoveTokenRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
247 |
+ <Token>Token_Als_Hexadezimal</Token> |
|
248 |
+ </TRemoveTokenRequest_V1> |
|
249 |
+ </RemoveToken> |
|
250 |
+ </ACMP> |
|
251 |
+</ICQL> |
|
252 |
+{{/apimacro}} |
|
253 |
+ |
|
254 |
+{{apimacro title="RemoveToken Response"}} |
|
255 |
+<ICQL> |
|
256 |
+ <ACMP> |
|
257 |
+ <RemoveToken ActionType="Response" version="1"> |
|
258 |
+ <TRemoveTokenResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> |
|
259 |
+ <ResultCode>0</ResultCode> |
|
260 |
+ <ResultMessage>ResultMessage</ResultMessage> |
|
261 |
+ </TRemoveTokenResponse_V1> |
|
262 |
+ </RemoveToken> |
|
263 |
+ </ACMP> |
|
264 |
+</ICQL> |
|
265 |
+{{/apimacro}} |
|
266 |
+ |
|
267 |
+ |
|
268 |
+ |
|
269 |
+ |
|
270 |
+ |