Show last authors
| author | version | line-number | content |
|---|---|---|---|
| 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 | The GetOwnUserRights command uses the session ID established during login to verify a user's permissions. | ||
| 207 | Only the permissions of ACMP users are queried, so the "ACMP" authentication method must be used when logging in. | ||
| 208 | |||
| 209 | {{apimacro title="GetOwnUserRights_Request"}} | ||
| 210 | {{{<ICQL> | ||
| 211 | <ACMP> | ||
| 212 | <GetOwnUserRights version="1"> | ||
| 213 | <TGetOwnUserRightsRequest_V1/> | ||
| 214 | </GetOwnUserRights> | ||
| 215 | </ACMP> | ||
| 216 | </ICQL>}}} | ||
| 217 | {{/apimacro}} | ||
| 218 | |||
| 219 | {{apimacro title="GetOwnUserRights_Response"}} | ||
| 220 | {{{<ICQL> | ||
| 221 | <ACMP> | ||
| 222 | <GetOwnUserRights version="1"> | ||
| 223 | <TGetOwnUserRightsResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| 224 | <AcmpRights> | ||
| 225 | <string>Value 1</string> | ||
| 226 | <string>Value 2</string> | ||
| 227 | </AcmpRights> | ||
| 228 | <VisibleActionIds> | ||
| 229 | <string>Value 1</string> | ||
| 230 | <string>Value 2</string> | ||
| 231 | </VisibleActionIds> | ||
| 232 | <ResultCode>0</ResultCode> | ||
| 233 | </TGetOwnUserRightsResponse_V1> | ||
| 234 | </GetOwnUserRights> | ||
| 235 | </ACMP> | ||
| 236 | </ICQL>}}} | ||
| 237 | {{/apimacro}} | ||
| 238 | |||
| 239 | = Remove Token = | ||
| 240 | |||
| 241 | {{apimacro title="RemoveToken Request"}} | ||
| 242 | {{{<ICQL> | ||
| 243 | <ACMP> | ||
| 244 | <RemoveToken ActionType="Request" version="1"> | ||
| 245 | <TRemoveTokenRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| 246 | <Token>Token_Als_Hexadezimal</Token> | ||
| 247 | </TRemoveTokenRequest_V1> | ||
| 248 | </RemoveToken> | ||
| 249 | </ACMP> | ||
| 250 | </ICQL>}}} | ||
| 251 | {{/apimacro}} | ||
| 252 | |||
| 253 | {{apimacro title="RemoveToken Response"}} | ||
| 254 | {{{<ICQL> | ||
| 255 | <ACMP> | ||
| 256 | <RemoveToken ActionType="Response" version="1"> | ||
| 257 | <TRemoveTokenResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"> | ||
| 258 | <ResultCode>0</ResultCode> | ||
| 259 | <ResultMessage>ResultMessage</ResultMessage> | ||
| 260 | </TRemoveTokenResponse_V1> | ||
| 261 | </RemoveToken> | ||
| 262 | </ACMP> | ||
| 263 | </ICQL>}}} | ||
| 264 | {{/apimacro}} |

