User
Last modified by Steffi F on 2025/06/30 07:27
Content
Login ACMP User (PasswordHash)
LoginAcmpUser Request
▶
<ICQL>
<ACMP>
<LoginAcmpUser ActionType="Request" version="1">
<TLoginAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Username>Username</Username>
<PasswordHash>PasswordHash</PasswordHash>
<SessionId>SessionId</SessionId>
<CreateToken>false</CreateToken> <! ab 5.4.6 >
</TLoginAcmpUserRequest_V1>
</LoginAcmpUser>
</ACMP>
</ICQL>LoginAcmpUser Request
▶
<ICQL>
<ACMP>
<LoginAcmpUser ActionType="Response" version="1">
<TLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<! Possible values:
- Successful
- IncorrectCredentials
- Undefined
>
<LoginResult>LoginResult</LoginResult>
<Token>Token_Als_Hexadezimal</Token> <! ab 5.4.6 >
<ResultCode>0</ResultCode>
</TLoginAcmpUserResponse_V1>
</LoginAcmpUser>
</ACMP>
</ICQL>Login ACMP User (Token)
LoginAcmpUser Request
▶
<ICQL>
<ACMP>
<TokenLoginAcmpUser version="1">
<TTokenLoginAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UserName>UserName</UserName>
<Token>Token_Als_Hexadezimal</Token>
<SessionId>SessionId</SessionId>
</TTokenLoginAcmpUserRequest_V1>
</TokenLoginAcmpUser>
</ACMP>
</ICQL>LoginAcmpUser Request
▶
<ICQL>
<ACMP>
<TokenLoginAcmpUser ActionType="Response" version="1">
<TTokenLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<! Possible values:
- Successful
- IncorrectCredentials
- Undefined
>
<LoginResult>LoginResult</LoginResult>
<ResultCode>0</ResultCode>
</TTokenLoginAcmpUserResponse_V1>
</TokenLoginAcmpUser>
</ACMP>
</ICQL>Login Domain User (PasswordHash)
LoginDomainUser Request
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/LoginDomainUserRequest_V1">
<ACMP>
<LoginDomainUser ActionType="Request" version="1">
<TLoginDomainUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Username>Username</Username>
<Domain>Domain</Domain>
<Password>Password</Password>
<SessionId>{59387FFD-B171-47C5-B735-041FA132CA39}</SessionId>
<CreateToken>false</CreateToken>
</TLoginDomainUserRequest_V1>
</LoginDomainUser>
</ACMP>
</ICQL>LoginDomainUser Response
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/LoginDomainUserResponse_V1">
<ACMP>
<LoginDomainUser ActionType="Response" version="1">
<TLoginDomainUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<! Possible values:
- Successful
- IncorrectCredentials
- Undefined
>
<LoginResult>LoginResult</LoginResult>
<Token>Token_Als_Hexadezimal</Token>
<ResultCode>0</ResultCode>
<ResultMessage>ResultMessage</ResultMessage>
</TLoginDomainUserResponse_V1>
</LoginDomainUser>
</ACMP>
</ICQL>Login Domain User (Token)
TokenLoginDomainUser Request
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/TokenLoginDomainUserRequest_V1">
<ACMP>
<TokenLoginDomainUser ActionType="Request" version="1">
<TTokenLoginDomainUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<UserName>UserName</UserName>
<Domain>Domain</Domain>
<Token>Token_Als_Hexadezimal</Token>
<SessionId>{59387FFD-B171-47C5-B735-041FA132CA39}</SessionId>
</TTokenLoginDomainUserRequest_V1>
</TokenLoginDomainUser>
</ACMP>
</ICQL>TokenLoginDomainUser Response
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/TokenLoginAcmpUserResponse_V1">
<ACMP>
<TokenLoginAcmpUser ActionType="Response" version="1">
<TTokenLoginAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<! Possible values:
- Successful
- IncorrectCredentials
- Undefined
>
<LoginResult>LoginResult</LoginResult>
<ResultCode>0</ResultCode>
<ResultMessage>ResultMessage</ResultMessage>
</TTokenLoginAcmpUserResponse_V1>
</TokenLoginAcmpUser>
</ACMP>
</ICQL>Logout ACMP User
LogoutAcmpUser Request
▶
<ICQL>
<ACMP>
<LogoutAcmpUser version="1">
<TLogoutAcmpUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<SessionId>SessionId</SessionId>
</TLogoutAcmpUserRequest_V1>
</LogoutAcmpUser>
</ACMP>
</ICQL>LogoutAcmpUser Response
▶
<ICQL>
<ACMP>
<LogoutAcmpUser version="1">
<TLogoutAcmpUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ResultCode>0</ResultCode>
</TLogoutAcmpUserResponse_V1>
</LogoutAcmpUser>
</ACMP>
</ICQL>Get User Salt
GetUserSalt Request
▶
<ICQL>
<ACMP>
<GetUserSalt ActionType="Request" version="1">
<TGetUserSaltRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Username>Username</Username>
</TGetUserSaltRequest_V1>
</GetUserSalt>
</ACMP>
</ICQL>GetUserSalt Response
▶
<ICQL>
<ACMP>
<GetUserSalt ActionType="Response" version="1">
<TGetUserSaltResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<! Salt as hex string for PBKDF2_HMAC_SHA256 password generation>
<Salt>Salt</Salt>
<! Iteration count for PBKDF2_HMAC_SHA256 password generation>
<IterationCount>0</IterationCount>
<PasswordVersion>0</PasswordVersion> <! ab 5.4.6 >
<ResultCode>0</ResultCode>
</TGetUserSaltResponse_V1>
</GetUserSalt>
</ACMP>
</ICQL>Get Own User Rights
The GetOwnUserRights command uses the session ID established during login to verify a user's permissions.
Only the permissions of ACMP users are queried, so the "ACMP" authentication method must be used when logging in.
GetOwnUserRights_Request
▶
<ICQL>
<ACMP>
<GetOwnUserRights version="1">
<TGetOwnUserRightsRequest_V1/>
</GetOwnUserRights>
</ACMP>
</ICQL>GetOwnUserRights_Response
▶
<ICQL>
<ACMP>
<GetOwnUserRights version="1">
<TGetOwnUserRightsResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AcmpRights>
<string>Value 1</string>
<string>Value 2</string>
</AcmpRights>
<VisibleActionIds>
<string>Value 1</string>
<string>Value 2</string>
</VisibleActionIds>
<ResultCode>0</ResultCode>
</TGetOwnUserRightsResponse_V1>
</GetOwnUserRights>
</ACMP>
</ICQL>Remove Token
RemoveToken Request
▶
<ICQL>
<ACMP>
<RemoveToken ActionType="Request" version="1">
<TRemoveTokenRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<Token>Token_Als_Hexadezimal</Token>
</TRemoveTokenRequest_V1>
</RemoveToken>
</ACMP>
</ICQL>RemoveToken Response
▶
<ICQL>
<ACMP>
<RemoveToken ActionType="Response" version="1">
<TRemoveTokenResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ResultCode>0</ResultCode>
<ResultMessage>ResultMessage</ResultMessage>
</TRemoveTokenResponse_V1>
</RemoveToken>
</ACMP>
</ICQL>Multi Tenancy
Read out Tenant Information
GetTenantInfosOfCurrentUser_V1 Request
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/GetTenantInfosOfCurrentUserRequest_V1">
<ACMP>
<GetTenantInfosOfCurrentUser ActionType="Request" version="1">
<TGetTenantInfosOfCurrentUserRequest_V1/>
</GetTenantInfosOfCurrentUser>
</ACMP>
</ICQL>GetTenantInfosOfCurrentUser_V1 Response
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/GetTenantInfosOfCurrentUserResponse_V1">
<ACMP>
<GetTenantInfosOfCurrentUser ActionType="Response" version="1">
<TGetTenantInfosOfCurrentUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<AvailableTenants>
<TTenantInfo_V1 xsi:type="TTenantInfo_V1">
<ID>{59387FFD-B171-47C5-B735-041FA132CA39}</ID>
<Name>Name</Name>
<ParentId>{59387FFD-B171-47C5-B735-041FA132CA39}</ParentId>
<TenantNo>0</TenantNo>
<Description>Description</Description>
</TTenantInfo_V1>
<TTenantInfo_V1 xsi:type="TTenantInfo_V1">
<ID>{59387FFD-B171-47C5-B735-041FA132CA39}</ID>
<Name>Name</Name>
<ParentId>{59387FFD-B171-47C5-B735-041FA132CA39}</ParentId>
<TenantNo>0</TenantNo>
<Description>Description</Description>
</TTenantInfo_V1>
</AvailableTenants>
<SelectedTenants>
<TTenantInfo_V1 xsi:type="TTenantInfo_V1">
<ID>{59387FFD-B171-47C5-B735-041FA132CA39}</ID>
<Name>Name</Name>
<ParentId>{59387FFD-B171-47C5-B735-041FA132CA39}</ParentId>
<TenantNo>0</TenantNo>
<Description>Description</Description>
</TTenantInfo_V1>
<TTenantInfo_V1 xsi:type="TTenantInfo_V1">
<ID>{59387FFD-B171-47C5-B735-041FA132CA39}</ID>
<Name>Name</Name>
<ParentId>{59387FFD-B171-47C5-B735-041FA132CA39}</ParentId>
<TenantNo>0</TenantNo>
<Description>Description</Description>
</TTenantInfo_V1>
</SelectedTenants>
<TenantMasterAvailable>false</TenantMasterAvailable>
<TenantMasterSelected>false</TenantMasterSelected>
<ResultCode>0</ResultCode>
<ResultMessage>ResultMessage</ResultMessage>
</TGetTenantInfosOfCurrentUserResponse_V1>
</GetTenantInfosOfCurrentUser>
</ACMP>
</ICQL>Change Tenant Settings
ChangeTenantsForCurrentUser_V1 Request
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/ChangeTenantsForCurrentUserRequest_V1">
<ACMP>
<ChangeTenantsForCurrentUser ActionType="Request" version="1">
<TChangeTenantsForCurrentUserRequest_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<TenantIds>
<string>{59387FFD-B171-47C5-B735-041FA132CA39}</string>
<string>{69387FFD-B171-47C5-B735-041FA132CA39}</string>
</TenantIds>
<TenantMaster>false</TenantMaster>
</TChangeTenantsForCurrentUserRequest_V1>
</ChangeTenantsForCurrentUser>
</ACMP>
</ICQL>ChangeTenantsForCurrentUser_V1 Response
▶
<ICQL xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://acmp.com/ChangeTenantsForCurrentUserResponse_V1">
<ACMP>
<ChangeTenantsForCurrentUser ActionType="Response" version="1">
<TChangeTenantsForCurrentUserResponse_V1 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<ResultCode>0</ResultCode>
<ResultMessage>ResultMessage</ResultMessage>
</TChangeTenantsForCurrentUserResponse_V1>
</ChangeTenantsForCurrentUser>
</ACMP>
</ICQL>